DirectConnect / Client / describe_direct_connect_gateway_attachments

describe_direct_connect_gateway_attachments#

DirectConnect.Client.describe_direct_connect_gateway_attachments(**kwargs)#

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

See also: AWS API Documentation

Request Syntax

response = client.describe_direct_connect_gateway_attachments(
    directConnectGatewayId='string',
    virtualInterfaceId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • directConnectGatewayId (string) – The ID of the Direct Connect gateway.

  • virtualInterfaceId (string) – The ID of the virtual interface.

  • maxResults (integer) –

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

  • nextToken (string) – The token provided in the previous call to retrieve the next page.

Return type:

dict

Returns:

Response Syntax

{
    'directConnectGatewayAttachments': [
        {
            'directConnectGatewayId': 'string',
            'virtualInterfaceId': 'string',
            'virtualInterfaceRegion': 'string',
            'virtualInterfaceOwnerAccount': 'string',
            'attachmentState': 'attaching'|'attached'|'detaching'|'detached',
            'attachmentType': 'TransitVirtualInterface'|'PrivateVirtualInterface',
            'stateChangeError': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • directConnectGatewayAttachments (list) –

      The attachments.

      • (dict) –

        Information about an attachment between a Direct Connect gateway and a virtual interface.

        • directConnectGatewayId (string) –

          The ID of the Direct Connect gateway.

        • virtualInterfaceId (string) –

          The ID of the virtual interface.

        • virtualInterfaceRegion (string) –

          The Amazon Web Services Region where the virtual interface is located.

        • virtualInterfaceOwnerAccount (string) –

          The ID of the Amazon Web Services account that owns the virtual interface.

        • attachmentState (string) –

          The state of the attachment. The following are the possible values:

          • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.

          • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

          • detaching: The initial state after calling DeleteVirtualInterface.

          • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

        • attachmentType (string) –

          The type of attachment.

        • stateChangeError (string) –

          The error message if the state of an object failed to advance.

    • nextToken (string) –

      The token to retrieve the next page.

Exceptions

  • DirectConnect.Client.exceptions.DirectConnectServerException

  • DirectConnect.Client.exceptions.DirectConnectClientException