:doc:`NetworkManager <../../networkmanager>` / Client / get_customer_gateway_associations

*********************************
get_customer_gateway_associations
*********************************



.. py:method:: NetworkManager.Client.get_customer_gateway_associations(**kwargs)

  

  Gets the association information for customer gateways that are associated with devices and links in your global network.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkmanager-2019-07-05/GetCustomerGatewayAssociations>`_  


  **Request Syntax**
  ::

    response = client.get_customer_gateway_associations(
        GlobalNetworkId='string',
        CustomerGatewayArns=[
            'string',
        ],
        MaxResults=123,
        NextToken='string'
    )
    
  :type GlobalNetworkId: string
  :param GlobalNetworkId: **[REQUIRED]** 

    The ID of the global network.

    

  
  :type CustomerGatewayArns: list
  :param CustomerGatewayArns: 

    One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

    

  
    - *(string) --* 

    

  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next page of results.

    

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

    
    ::

      {
          'CustomerGatewayAssociations': [
              {
                  'CustomerGatewayArn': 'string',
                  'GlobalNetworkId': 'string',
                  'DeviceId': 'string',
                  'LinkId': 'string',
                  'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **CustomerGatewayAssociations** *(list) --* 

        The customer gateway associations.

        
        

        - *(dict) --* 

          Describes the association between a customer gateway, a device, and a link.

          
          

          - **CustomerGatewayArn** *(string) --* 

            The Amazon Resource Name (ARN) of the customer gateway.

            
          

          - **GlobalNetworkId** *(string) --* 

            The ID of the global network.

            
          

          - **DeviceId** *(string) --* 

            The ID of the device.

            
          

          - **LinkId** *(string) --* 

            The ID of the link.

            
          

          - **State** *(string) --* 

            The association state.

            
      
    
      

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

        The token for the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`NetworkManager.Client.exceptions.ValidationException`

  
  *   :py:class:`NetworkManager.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ConflictException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ThrottlingException`

  
  *   :py:class:`NetworkManager.Client.exceptions.InternalServerException`

  