Interconnect / Client / get_connection

get_connection¶

Interconnect.Client.get_connection(**kwargs)¶

Describes the current state of a Connection resource as specified by the identifier.

Request Syntax

response = client.get_connection(
    identifier='string'
)

Parameters:

identifier (string) –

[REQUIRED]

The identifier of the requested Connection

Return type:

dict

Returns:

Response Syntax

{
    'connection': {
        '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,
        'ownerAccount': 'string',
        'activationKey': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) –
- connection (dict) –
  
  The existing Connection resource.
  - id (string) –
    
    The short identifier of the connection object.
  - arn (string) –
    
    An ARN of a Connection object.
  - description (string) –
    
    A descriptive name for the connection.
  - bandwidth (string) –
    
    The specific selected bandwidth of this 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 specific Environment this connection is placed upon.
  - 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
  - type (string) –
    
    The specific product type of this Connection.
  - 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.
  - ownerAccount (string) –
    
    The account that owns this Connection
  - activationKey (string) –
    
    The Activation Key associated to this connection.
  - tags (dict) –
    
    The tags on the Connection
    - (string) –
      - (string) –