Interconnect / Paginator / ListEnvironments

ListEnvironments

class Interconnect.Paginator.ListEnvironments

paginator = client.get_paginator('list_environments')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    provider={
        'cloudServiceProvider': 'string',
        'lastMileProvider': 'string'
    },
    location='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• provider (dict) –

  Filter results to only include Environment objects that connect to the Provider.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: cloudServiceProvider, lastMileProvider.

  • cloudServiceProvider (string) –

    The provider’s name. Specifically, connections to/from this Cloud Service Provider will be considered Multicloud connections.

  • lastMileProvider (string) –

    The provider’s name. Specifically, connections to/from this Last Mile Provider will be considered LastMile connections.

• location (string) – Filter results to only include Environment objects that connect to a given location distiguisher.

• 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': [
        {
            'provider': {
                'cloudServiceProvider': 'string',
                'lastMileProvider': 'string'
            },
            'location': 'string',
            'environmentId': 'string',
            'state': 'available'|'limited'|'unavailable',
            'bandwidths': {
                'available': [
                    'string',
                ],
                'supported': [
                    'string',
                ]
            },
            'type': 'string',
            'activationPageUrl': 'string',
            'remoteIdentifierType': 'account'|'email'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • environments (list) –

    The list of matching Environment objects.

    • (dict) –

      Defines the logical topology that an AWS Interconnect Connection is created upon.

      Specifically, an Environment defines the partner The remote Cloud Service Provider of this resource. or The remote Last Mile Provider of this resource. and the region or location specification to which an AWS Interconnect Connection can be made.

      • provider (dict) –

        The provider on the remote side of this Connection.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: cloudServiceProvider, lastMileProvider. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • cloudServiceProvider (string) –

          The provider’s name. Specifically, connections to/from this Cloud Service Provider will be considered Multicloud connections.

        • lastMileProvider (string) –

          The provider’s name. Specifically, connections to/from this Last Mile Provider will be considered LastMile connections.

      • location (string) –

        The provider specific location on the remote side of this Connection.

      • environmentId (string) –

        The identifier of this Environment

      • state (string) –

        The state of the Environment. Possible values:

        • available: The environment is available and new Connection objects can be requested.

        • limited: The environment is available, but overall capacity is limited. The set of available bandwidths

        • unavailable: The environment is currently unavailable.

      • bandwidths (dict) –

        The sets of bandwidths that are available and supported on this environment.

        • available (list) –

          The list of currently available bandwidths.

          • (string) –

        • supported (list) –

          The list of all bandwidths that this environment plans to support

          • (string) –

      • type (string) –

        The specific product type of Connection objects provided by this Environment.

      • activationPageUrl (string) –

        An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.

      • remoteIdentifierType (string) –

        The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.

  • NextToken (string) –

    A token to resume pagination.