MainframeModernization / Paginator / ListEnvironments

ListEnvironments

class MainframeModernization.Paginator.ListEnvironments

paginator = client.get_paginator('list_environments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_environments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    engineType='microfocus'|'bluage',
    names=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• engineType (string) – The engine type for the runtime environment.

• names (list) –

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

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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 token to resume pagination.