Interconnect

2026/04/13 - Interconnect - 13 new api methods

Changes  Initial release of AWS Interconnect -- a managed private connectivity service that enables you to create high-speed network connections between your AWS Virtual Private Clouds (VPCs) and your VPCs on other public clouds or your on-premise networks.

CreateConnection (new) Link ¶

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

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

string

param description:

A description to distinguish this Connection.

type bandwidth:

string

param bandwidth:

[REQUIRED]

The desired bandwidth of the requested Connection

type attachPoint:

dict

param attachPoint:

[REQUIRED]

The Attach Point to which the connection should be associated."

  • directConnectGateway (string) --

    Identifies an DirectConnect Gateway attach point by DirectConnectGatewayID.

  • arn (string) --

    Identifies an attach point by full ARN.

type environmentId:

string

param environmentId:

[REQUIRED]

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

The available Environment objects can be determined using ListEnvironments.

type remoteAccount:

dict

param remoteAccount:

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

  • identifier (string) --

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

type tags:

dict

param tags:

The tag to associate with the resulting Connection.

  • (string) --

    • (string) --

type clientToken:

string

param clientToken:

Idempotency token used for the request.

This field is autopopulated if not provided.

rtype:

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."

        • 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.

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

AcceptConnectionProposal (new) Link ¶

Accepts a connection proposal which was generated at a supported partner's portal.

The proposal contains the Environment and bandwidth that were chosen on the partner's portal and cannot be modified.

Upon accepting the proposal a connection will be made between the AWS network as accessed via the selected Attach Point and the network previously selected network on the partner's portal.

See also: AWS API Documentation

Request Syntax

client.accept_connection_proposal(
    attachPoint={
        'directConnectGateway': 'string',
        'arn': 'string'
    },
    activationKey='string',
    description='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)
type attachPoint:

dict

param attachPoint:

[REQUIRED]

The Attach Point to which the connection should be associated.

  • directConnectGateway (string) --

    Identifies an DirectConnect Gateway attach point by DirectConnectGatewayID.

  • arn (string) --

    Identifies an attach point by full ARN.

type activationKey:

string

param activationKey:

[REQUIRED]

An Activation Key that was generated on a supported partner's portal. This key captures the desired parameters from the initial creation request.

The details of this request can be described using with DescribeConnectionProposal.

type description:

string

param description:

A description to distinguish this Connection.

type tags:

dict

param tags:

The tags to associate with the resulting Connection.

  • (string) --

    • (string) --

type clientToken:

string

param clientToken:

Idempotency token used for the request.

This field is autopopulated if not provided.

rtype:

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 created Connection object.

      • 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."

        • 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.

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

DeleteConnection (new) Link ¶

Deletes an existing Connection with the supplied identifier.

This operation will also inform the remote partner of your intention to delete your connection. Note, the partner may still require you to delete to fully clean up resources, but the network connectivity provided by the Connection will cease to exist.

See also: AWS API Documentation

Request Syntax

client.delete_connection(
    identifier='string',
    clientToken='string'
)
type identifier:

string

param identifier:

[REQUIRED]

The identifier of the Connection to be deleted.

type clientToken:

string

param clientToken:

Idempotency token used for the request.

This field is autopopulated if not provided.

rtype:

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 Connection object that has been marked for deletion.

      • 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."

        • 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.

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

ListAttachPoints (new) Link ¶

Lists all Attach Points the caller has access to that are valid for the specified Environment.

See also: AWS API Documentation

Request Syntax

client.list_attach_points(
    environmentId='string',
    maxResults=123,
    nextToken='string'
)
type environmentId:

string

param environmentId:

[REQUIRED]

The identifier of the Environment for which to list valid Attach Points.

type maxResults:

integer

param maxResults:

The max number of list results in a single paginated response.

type nextToken:

string

param nextToken:

A pagination token from a previous paginated response indicating you wish to get the next page.

rtype:

dict

returns:

Response Syntax

{
    'attachPoints': [
        {
            'type': 'DirectConnectGateway',
            'identifier': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • attachPoints (list) --

      The valid AttachPoint

      • (dict) --

        Describes a possible Attach Point for a Connection.

        • type (string) --

          The type of this AttachPoint, which will dictate the syntax of the identifier.

          Current types include:

          • ARN

          • DirectConnect Gateway

        • identifier (string) --

          The identifier for the specific type of the AttachPoint.

        • name (string) --

          The descriptive name of the identifier attach point.

    • nextToken (string) --

      A pagination token indicating that there are more results that can be fetched.

ListConnections (new) Link ¶

Lists all connection objects to which the caller has access.

Allows for optional filtering by the following properties:

  • state

  • environmentId

  • provider

  • attach point

Only Connection objects matching all filters will be returned.

See also: AWS API Documentation

Request Syntax

client.list_connections(
    maxResults=123,
    nextToken='string',
    state='available'|'requested'|'pending'|'down'|'deleting'|'deleted'|'failed'|'updating',
    environmentId='string',
    provider={
        'cloudServiceProvider': 'string',
        'lastMileProvider': 'string'
    },
    attachPoint={
        'directConnectGateway': 'string',
        'arn': 'string'
    }
)
type maxResults:

integer

param maxResults:

The max number of list results in a single paginated response.

type nextToken:

string

param nextToken:

A pagination token from a previous paginated response indicating you wish to get the next page of results.

type state:

string

param state:

Filter the results to only include Connection objects in the given Connection$state.

type environmentId:

string

param environmentId:

Filter the results to only include Connection objects on the given Environment.

type provider:

dict

param provider:

Filter the results to only include Connection objects to the given Provider.

  • 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.

type attachPoint:

dict

param attachPoint:

Filter results to only include Connection objects attached to the given AttachPoint.

  • directConnectGateway (string) --

    Identifies an DirectConnect Gateway attach point by DirectConnectGatewayID.

  • arn (string) --

    Identifies an attach point by full ARN.

rtype:

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.

          • 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

          • 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 pagination token for use in subsequent calls to fetch the next page of results.

ListEnvironments (new) Link ¶

Lists all of the environments that can produce connections that will land in the called AWS region.

See also: AWS API Documentation

Request Syntax

client.list_environments(
    maxResults=123,
    nextToken='string',
    provider={
        'cloudServiceProvider': 'string',
        'lastMileProvider': 'string'
    },
    location='string'
)
type maxResults:

integer

param maxResults:

The max number of list results in a single paginated response.

type nextToken:

string

param nextToken:

A pagination token from a previous paginated response indicating you wish to get the next page of results.

type provider:

dict

param provider:

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

  • 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.

type location:

string

param location:

Filter results to only include Environment objects that connect to a given location distiguisher.

rtype:

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.

          • 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 pagination token for use in subsequent calls to fetch the next page of results.

TagResource (new) Link ¶

Add new tags to the specified resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    arn='string',
    tags={
        'string': 'string'
    }
)
type arn:

string

param arn:

[REQUIRED]

The ARN of the resource that should receive the new tags.

type tags:

dict

param tags:

[REQUIRED]

A map of tags to apply to the specified resource.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetConnection (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_connection(
    identifier='string'
)
type identifier:

string

param identifier:

[REQUIRED]

The identifier of the requested Connection

rtype:

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."

        • 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.

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

GetEnvironment (new) Link ¶

Describes a specific Environment

See also: AWS API Documentation

Request Syntax

client.get_environment(
    id='string'
)
type id:

string

param id:

[REQUIRED]

The identifier of the specific Environment to describe.

rtype:

dict

returns:

Response Syntax

{
    'environment': {
        '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'
    }
}

Response Structure

  • (dict) --

    • environment (dict) --

      The requested Environment structure.

      • provider (dict) --

        The provider on the remote side of this Connection.

        • 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.

DescribeConnectionProposal (new) Link ¶

Describes the details of a connection proposal generated at a partner's portal.

See also: AWS API Documentation

Request Syntax

client.describe_connection_proposal(
    activationKey='string'
)
type activationKey:

string

param activationKey:

[REQUIRED]

An Activation Key that was generated on a supported partner's portal. This key captures the desired parameters from the initial creation request.

rtype:

dict

returns:

Response Syntax

{
    'bandwidth': 'string',
    'environmentId': 'string',
    'provider': {
        'cloudServiceProvider': 'string',
        'lastMileProvider': 'string'
    },
    'location': 'string'
}

Response Structure

  • (dict) --

    • bandwidth (string) --

      The bandwidth of the proposed Connection.

    • environmentId (string) --

      The identifier of the Environment upon which the Connection would be placed if this proposal were accepted.

    • provider (dict) --

      The partner provider of the specific Environment of the proposal.

      • 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 partner specific location distinguisher of the specific Environment of the proposal.

ListTagsForResource (new) Link ¶

List all current tags on the specified resource. Currently this supports Connection resources.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    arn='string'
)
type arn:

string

param arn:

[REQUIRED]

The resource ARN for which to list tags.

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • tags (dict) --

      The tags on the specified ARN.

      • (string) --

        • (string) --

UntagResource (new) Link ¶

Removes tags from the specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    arn='string',
    tagKeys=[
        'string',
    ]
)
type arn:

string

param arn:

[REQUIRED]

The ARN of the resource from which the specified tags should be removed.

type tagKeys:

list

param tagKeys:

[REQUIRED]

The list of tag keys that should be removed from the resource.

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UpdateConnection (new) Link ¶

Modifies an existing connection. Currently we support modifications to the connection's description and/or bandwidth.

See also: AWS API Documentation

Request Syntax

client.update_connection(
    identifier='string',
    description='string',
    bandwidth='string',
    clientToken='string'
)
type identifier:

string

param identifier:

[REQUIRED]

The identifier of the Connection that should be updated.

type description:

string

param description:

An updated description to apply to the Connection

type bandwidth:

string

param bandwidth:

Request a new bandwidth size on the given Connection.

Note that changes to the size may be subject to additional policy, and does require the remote partner provider to acknowledge and permit this new bandwidth size.

type clientToken:

string

param clientToken:

Idempotency token used for the request.

This field is autopopulated if not provided.

rtype:

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 updated 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."

        • 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.

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