ListEnvironments - AWS Mainframe Modernization


Lists the runtime environments.

Request Syntax

GET /environments?engineType=engineType&maxResults=maxResults&names=names&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The engine type for the runtime environment.

Valid Values: microfocus | bluage


The maximum number of runtime environments to return.

Valid Range: Minimum value of 1. Maximum value of 2000.


The names of the runtime environments. Must be unique within the account.

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$


A pagination token to control the number of runtime environments displayed in the list.

Pattern: ^\S{1,2000}$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "environments": [ { "creationTime": number, "engineType": "string", "engineVersion": "string", "environmentArn": "string", "environmentId": "string", "instanceType": "string", "name": "string", "status": "string" } ], "nextToken": "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.


Returns a list of summary details for all the runtime environments in your account.

Type: Array of EnvironmentSummary objects


A pagination token that's returned when the response doesn't contain all the runtime environments.

Type: String

Pattern: ^\S{1,2000}$


For information about the errors that are common to all actions, see Common Errors.


The account or role doesn't have the right permissions to make the request.

HTTP Status Code: 403


An unexpected error occurred during the processing of the request.

HTTP Status Code: 500


The number of requests made exceeds the limit.

HTTP Status Code: 429


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: