v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1437198164.5 KB

Describes a specific runtime environment.

get/environments/{environmentId}

Path parameters

environmentIdstring required

The unique identifier of the runtime environment.

Response

Success

actualCapacityinteger

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.

creationTimestring date-time required

The timestamp when the runtime environment was created.

descriptionstring

The description of the runtime environment.

engineType'microfocus' | 'bluage' required

The target platform for the runtime environment.

engineVersionstring required

The version of the runtime engine.

environmentArnstring required

The Amazon Resource Name (ARN) of the runtime environment.

environmentIdstring required

The unique identifier of the runtime environment.

instanceTypestring required

The type of instance underlying the runtime environment.

kmsKeyIdstring

The identifier of a customer managed key.

loadBalancerArnstring

The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

namestring required

The name of the runtime environment. Must be unique within the account.

networkType'ipv4' | 'dual'

The network type supported by the runtime environment.

preferredMaintenanceWindowstring

The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.

publiclyAccessibleboolean

Whether applications running in this runtime environment are publicly accessible.

securityGroupIdsString50[] 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>.

statusReasonstring

The reason for the reported status.

subnetIdsString50[] required

The unique identifiers of the subnets assigned to this runtime environment.

tagsobject

The tags defined for this runtime environment.

vpcIdstring required

The unique identifier for the VPC used with this runtime environment.