Interconnect / Paginator / ListConnections

ListConnections¶

class Interconnect.Paginator.ListConnections¶

paginator = client.get_paginator('list_connections')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    state='available'|'requested'|'pending'|'down'|'deleting'|'deleted'|'failed'|'updating',
    environmentId='string',
    provider={
        'cloudServiceProvider': 'string',
        'lastMileProvider': 'string'
    },
    attachPoint={
        'directConnectGateway': 'string',
        'arn': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

state (string) – Filter the results to only include Connection objects in the given Connection$state.
environmentId (string) – Filter the results to only include Connection objects on the given Environment.
provider (dict) –
Filter the results to only include Connection objects to the given 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.
attachPoint (dict) –
Filter results to only include Connection objects attached to the given AttachPoint.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: directConnectGateway, arn.
- directConnectGateway (string) –
  
  Identifies an DirectConnect Gateway attach point by DirectConnectGatewayID.
- arn (string) –
  
  Identifies an attach point by full ARN.
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

{
    'connections': [
        {
            'id': 'string',
            'arn': 'string',
            'description': 'string',
            'bandwidth': 'string',
            'attachPoint': {
                'directConnectGateway': 'string',
                'arn': 'string'
            },
            'environmentId': 'string',
            'provider': {
                'cloudServiceProvider': 'string',
                'lastMileProvider': 'string'
            },
            'location': 'string',
            'type': 'string',
            'state': 'available'|'requested'|'pending'|'down'|'deleting'|'deleted'|'failed'|'updating',
            'sharedId': 'string',
            'billingTier': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- connections (list) –
  
  The resulting list of Connection objects.
  - (dict) –
    
    Summarized view of a Connection object.
    - id (string) –
      
      The identifier of the requested Connection
    - arn (string) –
      
      The ARN of the Connection
    - description (string) –
      
      A descriptive name of the Connection
    - bandwidth (string) –
      
      The bandwidth of the Connection
    - attachPoint (dict) –
      
      The Attach Point to which the connection should be associated.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: directConnectGateway, arn. 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'}
      - directConnectGateway (string) –
        
        Identifies an DirectConnect Gateway attach point by DirectConnectGatewayID.
      - arn (string) –
        
        Identifies an attach point by full ARN.
    - environmentId (string) –
      
      The Environment that this Connection is created on.
    - provider (dict) –
      
      The provider on the remote end 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 at the remote end of this Connection
    - type (string) –
      
      The product variant supplied by this resource.
    - state (string) –
      - requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.
      - pending: The connection has been accepted and is being provisioned between AWS and the Partner.
      - available: The connection has been fully provisioned between AWS and the Partner.
      - deleting: The connection is being deleted.
      - deleted: The connection has been deleted.
      - failed: The connection has failed to be created.
      - updating: The connection is being updated.
    - sharedId (string) –
      
      An identifier used by both AWS and the remote partner to identify the specific connection.
    - billingTier (integer) –
      
      The billing tier this connection is currently assigned.
- NextToken (string) –
  
  A token to resume pagination.