---
title: "GET /environments/{environmentId}"
method: GET
path: "/environments/{environmentId}"
---

# GET /environments/{environmentId}

`GET /environments/{environmentId}`

Describes a specific runtime environment.

## Path parameters

- `environmentId` string, required

## Response `200`

Success

- GetEnvironmentResponse
  - `actualCapacity` integer — The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.
  - `creationTime` string, date-time, required — The timestamp when the runtime environment was created.
  - `description` string — The description of the runtime environment.
  - `engineType` 'microfocus' | 'bluage', required — The target platform for the runtime environment.
  - `engineVersion` string, required — The version of the runtime engine.
  - `environmentArn` string, required — The Amazon Resource Name (ARN) of the runtime environment.
  - `environmentId` string, required — The unique identifier of the runtime environment.
  - `highAvailabilityConfig` object — The desired capacity of the high availability configuration for the runtime environment.
    - `desiredCapacity` integer, required — The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
  - `instanceType` string, required — The type of instance underlying the runtime environment.
  - `kmsKeyId` string — The identifier of a customer managed key.
  - `loadBalancerArn` string — The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
  - `name` string, required — The name of the runtime environment. Must be unique within the account.
  - `networkType` 'ipv4' | 'dual' — The network type supported by the runtime environment.
  - `pendingMaintenance` object — Indicates the pending maintenance scheduled on this environment.
    - `engineVersion` string — The specific runtime engine that the maintenance schedule applies to.
    - `schedule` object — The maintenance schedule for the runtime engine version.
      - `endTime` string, date-time — The time the scheduled maintenance is to end.
      - `startTime` string, date-time — The time the scheduled maintenance is to start.
  - `preferredMaintenanceWindow` string — The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.
  - `publiclyAccessible` boolean — Whether applications running in this runtime environment are publicly accessible.
  - `securityGroupIds` String50[], required — The unique identifiers of the security groups assigned to this runtime environment.
  - `status` 'Creating' | 'Available' | 'Updating' | 'Deleting' | 'Failed' | 'UnHealthy', required — The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be <code>Unhealthy</code>.
  - `statusReason` string — The reason for the reported status.
  - `storageConfigurations` StorageConfiguration[] — The storage configurations defined for the runtime environment.
    - `efs` object — Defines the storage configuration for an Amazon EFS file system.
      - `fileSystemId` string, required — The file system identifier.
      - `mountPoint` string, required — The mount point for the file system.
    - `fsx` object — Defines the storage configuration for an Amazon FSx file system.
      - `fileSystemId` string, required — The file system identifier.
      - `mountPoint` string, required — The mount point for the file system.
  - `subnetIds` String50[], required — The unique identifiers of the subnets assigned to this runtime environment.
  - `tags` object — The tags defined for this runtime environment.
  - `vpcId` string, required — The unique identifier for the VPC used with this runtime environment.

## Other responses

- `480` — ResourceNotFoundException
- `481` — ThrottlingException
- `482` — AccessDeniedException
- `483` — ValidationException
- `484` — InternalServerException

---

[API](https://skmtc.net/aws/apis/m2.md) · [All operations](https://skmtc.net/aws/apis/m2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/m2/versions/aac43e95a42b/schema)