Interconnect / Client / describe_connection_proposal

describe_connection_proposal

Interconnect.Client.describe_connection_proposal(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_connection_proposal(
    activationKey='string'
)
Parameters:

activationKey (string) –

[REQUIRED]

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

Return type:

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.

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

Exceptions

  • Interconnect.Client.exceptions.ResourceNotFoundException

  • Interconnect.Client.exceptions.InterconnectClientException

  • Interconnect.Client.exceptions.ThrottlingException

  • Interconnect.Client.exceptions.AccessDeniedException

  • Interconnect.Client.exceptions.InterconnectValidationException

  • Interconnect.Client.exceptions.ServiceQuotaExceededException

  • Interconnect.Client.exceptions.InterconnectServerException