DirectConnect / Client / describe_direct_connect_gateways

describe_direct_connect_gateways#

DirectConnect.Client.describe_direct_connect_gateways(**kwargs)#

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

See also: AWS API Documentation

Request Syntax

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

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

Return type:

dict

Returns:

Response Syntax

{
    'directConnectGateways': [
        {
            'directConnectGatewayId': 'string',
            'directConnectGatewayName': 'string',
            'amazonSideAsn': 123,
            'ownerAccount': 'string',
            'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
            'stateChangeError': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • directConnectGateways (list) –

      The Direct Connect gateways.

      • (dict) –

        Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.

        • directConnectGatewayId (string) –

          The ID of the Direct Connect gateway.

        • directConnectGatewayName (string) –

          The name of the Direct Connect gateway.

        • amazonSideAsn (integer) –

          The autonomous system number (ASN) for the Amazon side of the connection.

        • ownerAccount (string) –

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

        • directConnectGatewayState (string) –

          The state of the Direct Connect gateway. The following are the possible values:

          • pending: The initial state after calling CreateDirectConnectGateway.

          • available: The Direct Connect gateway is ready for use.

          • deleting: The initial state after calling DeleteDirectConnectGateway.

          • deleted: The Direct Connect gateway is deleted and cannot pass traffic.

        • 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