GetEnvironment
Describes a specific runtime environment.
Request Syntax
GET /environments/environmentId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- environmentId
-
The unique identifier of the runtime environment.
Pattern:
^\S{1,80}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"actualCapacity": number,
"creationTime": number,
"description": "string",
"engineType": "string",
"engineVersion": "string",
"environmentArn": "string",
"environmentId": "string",
"highAvailabilityConfig": {
"desiredCapacity": number
},
"instanceType": "string",
"kmsKeyId": "string",
"loadBalancerArn": "string",
"name": "string",
"networkType": "string",
"pendingMaintenance": {
"engineVersion": "string",
"schedule": {
"endTime": number,
"startTime": number
}
},
"preferredMaintenanceWindow": "string",
"publiclyAccessible": boolean,
"securityGroupIds": [ "string" ],
"status": "string",
"statusReason": "string",
"storageConfigurations": [
{ ... }
],
"subnetIds": [ "string" ],
"tags": {
"string" : "string"
},
"vpcId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- actualCapacity
-
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.
Type: Integer
- creationTime
-
The timestamp when the runtime environment was created.
Type: Timestamp
- description
-
The description of the runtime environment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
- engineType
-
The target platform for the runtime environment.
Type: String
Valid Values:
microfocus | bluage - engineVersion
-
The version of the runtime engine.
Type: String
Pattern:
^\S{1,10}$ - environmentArn
-
The Amazon Resource Name (ARN) of the runtime environment.
Type: String
Pattern:
^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$ - environmentId
-
The unique identifier of the runtime environment.
Type: String
Pattern:
^\S{1,80}$ - highAvailabilityConfig
-
The desired capacity of the high availability configuration for the runtime environment.
Type: HighAvailabilityConfig object
- instanceType
-
The type of instance underlying the runtime environment.
Type: String
Pattern:
^\S{1,20}$ - kmsKeyId
-
The identifier of a customer managed key.
Type: String
- loadBalancerArn
-
The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
Type: String
- name
-
The name of the runtime environment. Must be unique within the account.
Type: String
Pattern:
^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$ - networkType
-
The network type supported by the runtime environment.
Type: String
Valid Values:
ipv4 | dual - pendingMaintenance
-
Indicates the pending maintenance scheduled on this environment.
Type: PendingMaintenance object
- preferredMaintenanceWindow
-
The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.
Type: String
Pattern:
^\S{1,50}$ - publiclyAccessible
-
Whether applications running in this runtime environment are publicly accessible.
Type: Boolean
- securityGroupIds
-
The unique identifiers of the security groups assigned to this runtime environment.
Type: Array of strings
Pattern:
^\S{1,50}$ - status
-
The status of the runtime environment. If the AWS Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be
Unhealthy.Type: String
Valid Values:
Creating | Available | Updating | Deleting | Failed | UnHealthy - statusReason
-
The reason for the reported status.
Type: String
- storageConfigurations
-
The storage configurations defined for the runtime environment.
Type: Array of StorageConfiguration objects
- subnetIds
-
The unique identifiers of the subnets assigned to this runtime environment.
Type: Array of strings
Pattern:
^\S{1,50}$ -
The tags defined for this runtime environment.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:).+$Value Length Constraints: Minimum length of 0. Maximum length of 256.
- vpcId
-
The unique identifier for the VPC used with this runtime environment.
Type: String
Pattern:
^\S{1,50}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The account or role doesn't have the right permissions to make the request.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred during the processing of the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests made exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
One or more parameters provided in the request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
