:doc:`EventBridge <../../events>` / Client / update_api_destination

**********************
update_api_destination
**********************



.. py:method:: EventBridge.Client.update_api_destination(**kwargs)

  

  Updates an API destination.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateApiDestination>`_  


  **Request Syntax**
  ::

    response = client.update_api_destination(
        Name='string',
        Description='string',
        ConnectionArn='string',
        InvocationEndpoint='string',
        HttpMethod='POST'|'GET'|'HEAD'|'OPTIONS'|'PUT'|'PATCH'|'DELETE',
        InvocationRateLimitPerSecond=123
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

    The name of the API destination to update.

    

  
  :type Description: string
  :param Description: 

    The name of the API destination to update.

    

  
  :type ConnectionArn: string
  :param ConnectionArn: 

    The ARN of the connection to use for the API destination.

    

  
  :type InvocationEndpoint: string
  :param InvocationEndpoint: 

    The URL to the endpoint to use for the API destination.

    

  
  :type HttpMethod: string
  :param HttpMethod: 

    The method to use for the API destination.

    

  
  :type InvocationRateLimitPerSecond: integer
  :param InvocationRateLimitPerSecond: 

    The maximum number of invocations per second to send to the API destination.

    

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

    
    ::

      {
          'ApiDestinationArn': 'string',
          'ApiDestinationState': 'ACTIVE'|'INACTIVE',
          'CreationTime': datetime(2015, 1, 1),
          'LastModifiedTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ApiDestinationArn** *(string) --* 

        The ARN of the API destination that was updated.

        
      

      - **ApiDestinationState** *(string) --* 

        The state of the API destination that was updated.

        
      

      - **CreationTime** *(datetime) --* 

        A time stamp for the time that the API destination was created.

        
      

      - **LastModifiedTime** *(datetime) --* 

        A time stamp for the time that the API destination was last modified.

        
  
  **Exceptions**
  
  *   :py:class:`EventBridge.Client.exceptions.ConcurrentModificationException`

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

  
  *   :py:class:`EventBridge.Client.exceptions.InternalException`

  
  *   :py:class:`EventBridge.Client.exceptions.LimitExceededException`

  