:doc:`DirectConnect <../../directconnect>` / Paginator / DescribeDirectConnectGateways

*****************************
DescribeDirectConnectGateways
*****************************



.. py:class:: DirectConnect.Paginator.DescribeDirectConnectGateways

  ::

    
    paginator = client.get_paginator('describe_direct_connect_gateways')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DirectConnect.Client.describe_direct_connect_gateways`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeDirectConnectGateways>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          directConnectGatewayId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type directConnectGatewayId: string
    :param directConnectGatewayId: 

      The ID of the Direct Connect gateway.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'directConnectGateways': [
                {
                    'directConnectGatewayId': 'string',
                    'directConnectGatewayName': 'string',
                    'amazonSideAsn': 123,
                    'ownerAccount': 'string',
                    'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
                    'stateChangeError': 'string',
                    'tags': [
                        {
                            'key': 'string',
                            'value': '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 (AS) 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.

              
            

            - **tags** *(list) --* 

              Information about a tag.

              
              

              - *(dict) --* 

                Information about a tag.

                
                

                - **key** *(string) --* 

                  The key.

                  
                

                - **value** *(string) --* 

                  The value.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    