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

****************************************
DescribeDirectConnectGatewayAssociations
****************************************



.. py:class:: DirectConnect.Paginator.DescribeDirectConnectGatewayAssociations

  ::

    
    paginator = client.get_paginator('describe_direct_connect_gateway_associations')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The ID of the Direct Connect gateway association.

      

    
    :type associatedGatewayId: string
    :param associatedGatewayId: 

      The ID of the associated gateway.

      

    
    :type directConnectGatewayId: string
    :param directConnectGatewayId: 

      The ID of the Direct Connect gateway.

      

    
    :type virtualGatewayId: string
    :param virtualGatewayId: 

      The ID of the virtual private gateway or transit 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**

      
      ::

        {
            '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'
                        },
                    ],
                    'associatedCoreNetwork': {
                        'id': 'string',
                        'ownerAccount': 'string',
                        'attachmentId': '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.

                  
            
          
            

            - **associatedCoreNetwork** *(dict) --* 

              The ID of the Cloud WAN core network associated with the Direct Connect gateway attachment.

              
              

              - **id** *(string) --* 

                The ID of the Cloud WAN core network that the Direct Connect gateway is associated to.

                
              

              - **ownerAccount** *(string) --* 

                The account owner of the Cloud WAN core network.

                
              

              - **attachmentId** *(string) --* 

                the ID of the Direct Connect gateway attachment.

                
          
            

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

          A token to resume pagination.

          
    