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

**************************
associate_customer_gateway
**************************



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

  

  Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.

   

  You can only associate customer gateways that are connected to a VPN attachment on a transit gateway or core network registered in your global network. When you register a transit gateway or core network, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the `DescribeVpnConnections <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html>`__ EC2 API and filter by ``transit-gateway-id``.

   

  You cannot associate a customer gateway with more than one device and link.

  

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


  **Request Syntax**
  ::

    response = client.associate_customer_gateway(
        CustomerGatewayArn='string',
        GlobalNetworkId='string',
        DeviceId='string',
        LinkId='string'
    )
    
  :type CustomerGatewayArn: string
  :param CustomerGatewayArn: **[REQUIRED]** 

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

    

  
  :type GlobalNetworkId: string
  :param GlobalNetworkId: **[REQUIRED]** 

    The ID of the global network.

    

  
  :type DeviceId: string
  :param DeviceId: **[REQUIRED]** 

    The ID of the device.

    

  
  :type LinkId: string
  :param LinkId: 

    The ID of the link.

    

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

    
    ::

      {
          'CustomerGatewayAssociation': {
              'CustomerGatewayArn': 'string',
              'GlobalNetworkId': 'string',
              'DeviceId': 'string',
              'LinkId': 'string',
              'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **CustomerGatewayAssociation** *(dict) --* 

        The customer gateway association.

        
        

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

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

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

  
  *   :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`

  