Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451299221.6 KB

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

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

Headers

X-Amz-Target'AWSEvents.CreateApiDestination' required

Request body

Namestring required

The name for the API destination to create.

Descriptionstring

A description for the API destination to create.

ConnectionArnstring required

The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

InvocationEndpointstring required

The URL to the HTTP invocation endpoint for the API destination.

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

The method to use for the request to the HTTP invocation endpoint.

InvocationRateLimitPerSecondinteger

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

Response

Success

ApiDestinationArnstring

The ARN of the API destination that was created by the request.

ApiDestinationState'ACTIVE' | 'INACTIVE'

The state of the API destination that was created by the request.

CreationTimestring date-time

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

LastModifiedTimestring date-time

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