DirectConnect / Paginator / DescribeDirectConnectGateways


class DirectConnect.Paginator.DescribeDirectConnectGateways#
paginator = client.get_paginator('describe_direct_connect_gateways')

Creates an iterator that will paginate through responses from DirectConnect.Client.describe_direct_connect_gateways().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • directConnectGatewayId (string) – The ID of the Direct Connect gateway.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



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

      A token to resume pagination.