:doc:`DirectConnect <../../directconnect>` / Client / update_direct_connect_gateway

*****************************
update_direct_connect_gateway
*****************************



.. py:method:: DirectConnect.Client.update_direct_connect_gateway(**kwargs)

  

  Updates the name of a current Direct Connect gateway.

  

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


  **Request Syntax**
  ::

    response = client.update_direct_connect_gateway(
        directConnectGatewayId='string',
        newDirectConnectGatewayName='string'
    )
    
  :type directConnectGatewayId: string
  :param directConnectGatewayId: **[REQUIRED]** 

    The ID of the Direct Connect gateway to update.

    

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

    The new name for the Direct Connect gateway.

    

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

    
    ::

      {
          'directConnectGateway': {
              'directConnectGatewayId': 'string',
              'directConnectGatewayName': 'string',
              'amazonSideAsn': 123,
              'ownerAccount': 'string',
              'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
              'stateChangeError': 'string',
              'tags': [
                  {
                      'key': 'string',
                      'value': 'string'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **directConnectGateway** *(dict) --* 

        Informaiton about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateways 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.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`DirectConnect.Client.exceptions.DirectConnectServerException`

  
  *   :py:class:`DirectConnect.Client.exceptions.DirectConnectClientException`

  