EventBridge / Client / list_api_destinations

list_api_destinations#

EventBridge.Client.list_api_destinations(**kwargs)#

Retrieves a list of API destination in the account in the current Region.

See also: AWS API Documentation

Request Syntax

response = client.list_api_destinations(
    NamePrefix='string',
    ConnectionArn='string',
    NextToken='string',
    Limit=123
)
Parameters:

  • NamePrefix (string) – A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

  • ConnectionArn (string) – The ARN of the connection specified for the API destination.

  • NextToken (string) – The token returned by a previous call to retrieve the next set of results.

  • Limit (integer) – The maximum number of API destinations to include in the response.

Return type:

dict

Returns:

Response Syntax

{
    'ApiDestinations': [
        {
            'ApiDestinationArn': 'string',
            'Name': '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ApiDestinations (list) –

      An array of ApiDestination objects that include information about an API destination.

      • (dict) –

        Contains details about an API destination.

        • ApiDestinationArn (string) –

          The ARN of the API destination.

        • Name (string) –

          The name of the API destination.

        • ApiDestinationState (string) –

          The state of the API destination.

        • ConnectionArn (string) –

          The ARN of the connection specified for the API destination.

        • InvocationEndpoint (string) –

          The URL to the endpoint for the API destination.

        • HttpMethod (string) –

          The method to use to connect to the HTTP endpoint.

        • InvocationRateLimitPerSecond (integer) –

          The maximum number of invocations per second to send to the HTTP endpoint.

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

    • NextToken (string) –

      A token you can use in a subsequent request to retrieve the next set of results.

Exceptions

  • EventBridge.Client.exceptions.InternalException