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

************************
describe_api_destination
************************



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

  

  Retrieves details about an API destination.

  

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


  **Request Syntax**
  ::

    response = client.describe_api_destination(
        Name='string'
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

    The name of the API destination to retrieve.

    

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

    
    ::

      {
          'ApiDestinationArn': 'string',
          'Name': 'string',
          'Description': 'string',
          'ApiDestinationState': 'ACTIVE'|'INACTIVE',
          'ConnectionArn': 'string',
          'InvocationEndpoint': 'string',
          'HttpMethod': 'POST'|'GET'|'HEAD'|'OPTIONS'|'PUT'|'PATCH'|'DELETE',
          'InvocationRateLimitPerSecond': 123,
          'CreationTime': datetime(2015, 1, 1),
          'LastModifiedTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The ARN of the API destination retrieved.

        
      

      - **Name** *(string) --* 

        The name of the API destination retrieved.

        
      

      - **Description** *(string) --* 

        The description for the API destination retrieved.

        
      

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

        The state of the API destination retrieved.

        
      

      - **ConnectionArn** *(string) --* 

        The ARN of the connection specified for the API destination retrieved.

        
      

      - **InvocationEndpoint** *(string) --* 

        The URL to use to connect to the HTTP endpoint.

        
      

      - **HttpMethod** *(string) --* 

        The method to use to connect to the HTTP endpoint.

        
      

      - **InvocationRateLimitPerSecond** *(integer) --* 

        The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

        
      

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

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

  