MainframeModernization / Client / list_environments
list_environments#
- MainframeModernization.Client.list_environments(**kwargs)#
Lists the runtime environments.
See also: AWS API Documentation
Request Syntax
response = client.list_environments( engineType='microfocus'|'bluage', maxResults=123, names=[ 'string', ], nextToken='string' )
- Parameters:
engineType (string) – The engine type for the runtime environment.
maxResults (integer) – The maximum number of runtime environments to return.
names (list) –
The names of the runtime environments. Must be unique within the account.
(string) –
nextToken (string) – A pagination token to control the number of runtime environments displayed in the list.
- Return type:
dict
- Returns:
Response Syntax
{ 'environments': [ { 'creationTime': datetime(2015, 1, 1), 'engineType': 'microfocus'|'bluage', 'engineVersion': 'string', 'environmentArn': 'string', 'environmentId': 'string', 'instanceType': 'string', 'name': 'string', 'status': 'Creating'|'Available'|'Updating'|'Deleting'|'Failed' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
environments (list) –
Returns a list of summary details for all the runtime environments in your account.
(dict) –
Contains a subset of the possible runtime environment attributes. Used in the environment list.
creationTime (datetime) –
The timestamp when the runtime environment was created.
engineType (string) –
The target platform for the runtime environment.
engineVersion (string) –
The version of the runtime engine.
environmentArn (string) –
The Amazon Resource Name (ARN) of a particular runtime environment.
environmentId (string) –
The unique identifier of a particular runtime environment.
instanceType (string) –
The instance type of the runtime environment.
name (string) –
The name of the runtime environment.
status (string) –
The status of the runtime environment
nextToken (string) –
A pagination token that’s returned when the response doesn’t contain all the runtime environments.
Exceptions
MainframeModernization.Client.exceptions.ThrottlingException
MainframeModernization.Client.exceptions.AccessDeniedException
MainframeModernization.Client.exceptions.ValidationException
MainframeModernization.Client.exceptions.InternalServerException