Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451299221.6 KB

Updates an API destination.

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

Headers

X-Amz-Target'AWSEvents.UpdateApiDestination' required

Request body

Namestring required

The name of the API destination to update.

Descriptionstring

The name of the API destination to update.

ConnectionArnstring

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

InvocationEndpointstring

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

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

The method to use for the API destination.

InvocationRateLimitPerSecondinteger

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

Response

Success

ApiDestinationArnstring

The ARN of the API destination that was updated.

ApiDestinationState'ACTIVE' | 'INACTIVE'

The state of the API destination that was updated.

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.