Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456332247.5 KB

Retrieves details about an API destination.

post/#X-Amz-Target=AWSEvents.DescribeApiDestination

Headers

X-Amz-Target'AWSEvents.DescribeApiDestination' required

Request body

Namestring required

The name of the API destination to retrieve.

Response

Success

ApiDestinationArnstring

The ARN of the API destination retrieved.

Namestring

The name of the API destination retrieved.

Descriptionstring

The description for the API destination retrieved.

ApiDestinationState'ACTIVE' | 'INACTIVE'

The state of the API destination retrieved.

ConnectionArnstring

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

InvocationEndpointstring

The URL to use to connect to the HTTP endpoint.

HttpMethod'POST' | 'GET' | 'HEAD' | 'OPTIONS' | 'PUT' | 'PATCH' | 'DELETE'

The method to use to connect to the HTTP endpoint.

InvocationRateLimitPerSecondinteger

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.

CreationTimestring date-time

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

LastModifiedTimestring date-time

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