MigrationHubRefactorSpaces / Paginator / ListEnvironmentVpcs

ListEnvironmentVpcs#

class MigrationHubRefactorSpaces.Paginator.ListEnvironmentVpcs#
paginator = client.get_paginator('list_environment_vpcs')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EnvironmentIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • EnvironmentIdentifier (string) –

    [REQUIRED]

    The ID of the environment.

  • 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

{
    'EnvironmentVpcList': [
        {
            'AccountId': 'string',
            'CidrBlocks': [
                'string',
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'EnvironmentId': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'VpcId': 'string',
            'VpcName': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • EnvironmentVpcList (list) –

      The list of EnvironmentVpc objects.

      • (dict) –

        Provides summary information for the EnvironmentVpc resource as a response to ListEnvironmentVpc.

        • AccountId (string) –

          The Amazon Web Services account ID of the virtual private cloud (VPC) owner.

        • CidrBlocks (list) –

          The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.

          • (string) –

        • CreatedTime (datetime) –

          A timestamp that indicates when the VPC is first added to the environment.

        • EnvironmentId (string) –

          The unique identifier of the environment.

        • LastUpdatedTime (datetime) –

          A timestamp that indicates when the VPC was last updated by the environment.

        • VpcId (string) –

          The ID of the VPC.

        • VpcName (string) –

          The name of the VPC at the time it is added to the environment.