class MigrationHubRefactorSpaces.Paginator.ListEnvironments
paginator = client.get_paginator('list_environments')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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
Response Syntax
    'EnvironmentSummaryList': [
            'Arn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Description': 'string',
            'EnvironmentId': 'string',
            'Error': {
                'AccountId': 'string',
                'AdditionalDetails': {
                    'string': 'string'
                'Message': 'string',
                'ResourceIdentifier': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'Name': 'string',
            'NetworkFabricType': 'TRANSIT_GATEWAY'|'NONE',
            'OwnerAccountId': 'string',
            'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
            'Tags': {
                'string': 'string'
            'TransitGatewayId': 'string'


Response Structure

  • (dict) --
    • EnvironmentSummaryList (list) --

      The list of EnvironmentSummary objects.

      • (dict) --

        The summary information for environments as a response to ListEnvironments .

        • Arn (string) --

          The Amazon Resource Name (ARN) of the environment.

        • CreatedTime (datetime) --

          A timestamp that indicates when the environment is created.

        • Description (string) --

          A description of the environment.

        • EnvironmentId (string) --

          The unique identifier of the environment.

        • Error (dict) --

          Any error associated with the environment resource.

          • AccountId (string) --

            The Amazon Web Services account ID of the resource owner.

          • AdditionalDetails (dict) --

            Additional details about the error.

            • (string) --
              • (string) --
          • Code (string) --

            The error code associated with the error.

          • Message (string) --

            The message associated with the error.

          • ResourceIdentifier (string) --

            The ID of the resource.

          • ResourceType (string) --

            The type of resource.

        • LastUpdatedTime (datetime) --

          A timestamp that indicates when the environment was last updated.

        • Name (string) --

          The name of the environment.

        • NetworkFabricType (string) --

          The network fabric type of the environment.

        • OwnerAccountId (string) --

          The Amazon Web Services account ID of the environment owner.

        • State (string) --

          The current state of the environment.

        • Tags (dict) --

          The tags assigned to the environment.

          • (string) --
            • (string) --
        • TransitGatewayId (string) --

          The ID of the transit gateway set up by the environment.