Interconnect / Client / create_connection

create_connection

Interconnect.Client.create_connection(**kwargs)

Initiates the process to create a Connection across the specified Environment.

The Environment dictates the specified partner and location to which the other end of the connection should attach. You can see a list of the available Environments by calling ListEnvironments

The Attach Point specifies where within the AWS Network your connection will logically connect.

After a successful call to this method, the resulting Connection will return an Activation Key which will need to be brought to the specific partner’s portal to confirm the Connection on both sides. (See Environment$activationPageUrl for a direct link to the partner portal).

See also: AWS API Documentation

Request Syntax

response = client.create_connection(
    description='string',
    bandwidth='string',
    attachPoint={
        'directConnectGateway': 'string',
        'arn': 'string'
    },
    environmentId='string',
    remoteAccount={
        'identifier': 'string'
    },
    tags={
        'string': 'string'
    },
    clientToken='string'
)
Parameters:

  • description (string) – A description to distinguish this Connection.

  • bandwidth (string) –

    [REQUIRED]

    The desired bandwidth of the requested Connection

  • attachPoint (dict) –

    [REQUIRED]

    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 can be set: directConnectGateway, arn.

    • directConnectGateway (string) –

      Identifies an DirectConnect Gateway attach point by DirectConnectGatewayID.

    • arn (string) –

      Identifies an attach point by full ARN.

  • environmentId (string) –

    [REQUIRED]

    The identifier of the Environment across which this Connection should be created.

    The available Environment objects can be determined using ListEnvironments.

  • remoteAccount (dict) –

    Account and/or principal identifying information that can be verified by the partner of this specific Environment.

    Note

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

    • identifier (string) –

      A generic bit of identifying information. Can be used in place of any of the more specific types.

  • tags (dict) –

    The tag to associate with the resulting Connection.

    • (string) –

      • (string) –

  • clientToken (string) –

    Idempotency token used for the request.

    This field is autopopulated if not provided.

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 resulting Connection.

      • 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) –

Exceptions