DirectConnect / Client / describe_direct_connect_gateway_associations

describe_direct_connect_gateway_associations#

DirectConnect.Client.describe_direct_connect_gateway_associations(**kwargs)#

Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:

  • A Direct Connect gateway The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway.

  • A virtual private gateway The response contains the Direct Connect gateway.

  • A transit gateway The response contains the Direct Connect gateway.

  • A Direct Connect gateway and a virtual private gateway The response contains the association between the Direct Connect gateway and virtual private gateway.

  • A Direct Connect gateway and a transit gateway The response contains the association between the Direct Connect gateway and transit gateway.

See also: AWS API Documentation

Request Syntax

response = client.describe_direct_connect_gateway_associations(
    associationId='string',
    associatedGatewayId='string',
    directConnectGatewayId='string',
    maxResults=123,
    nextToken='string',
    virtualGatewayId='string'
)
Parameters:

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

  • associatedGatewayId (string) – The ID of the associated gateway.

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

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

  • virtualGatewayId (string) – The ID of the virtual private gateway or transit gateway.

Return type:

dict

Returns:

Response Syntax

{
    'directConnectGatewayAssociations': [
        {
            'directConnectGatewayId': 'string',
            'directConnectGatewayOwnerAccount': 'string',
            'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
            'stateChangeError': 'string',
            'associatedGateway': {
                'id': 'string',
                'type': 'virtualPrivateGateway'|'transitGateway',
                'ownerAccount': 'string',
                'region': 'string'
            },
            'associationId': 'string',
            'allowedPrefixesToDirectConnectGateway': [
                {
                    'cidr': 'string'
                },
            ],
            'virtualGatewayId': 'string',
            'virtualGatewayRegion': 'string',
            'virtualGatewayOwnerAccount': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • directConnectGatewayAssociations (list) –

      Information about the associations.

      • (dict) –

        Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

        • directConnectGatewayId (string) –

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount (string) –

          The ID of the Amazon Web Services account that owns the associated gateway.

        • associationState (string) –

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

          • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

          • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

          • updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.

        • stateChangeError (string) –

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

        • associatedGateway (dict) –

          Information about the associated gateway.

          • id (string) –

            The ID of the associated gateway.

          • type (string) –

            The type of associated gateway.

          • ownerAccount (string) –

            The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.

          • region (string) –

            The Region where the associated gateway is located.

        • associationId (string) –

          The ID of the Direct Connect gateway association.

        • allowedPrefixesToDirectConnectGateway (list) –

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • (dict) –

            Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

            • cidr (string) –

              The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • virtualGatewayId (string) –

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • virtualGatewayRegion (string) –

          The Amazon Web Services Region where the virtual private gateway is located.

        • virtualGatewayOwnerAccount (string) –

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

    • nextToken (string) –

      The token to retrieve the next page.

Exceptions