Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateApiDestination

Updates an API destination.

Request Syntax


{
   "ConnectionArn": "string",
   "Description": "string",
   "HttpMethod": "string",
   "InvocationEndpoint": "string",
   "InvocationRateLimitPerSecond": number,
   "Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConnectionArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$

Required: No

Description

The name of the API destination to update.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

HttpMethod

The method to use for the API destination.

Type: String

Required: No

InvocationEndpoint

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$

Required: No

InvocationRateLimitPerSecond

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Name

The name of the API destination to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax


{
   "ApiDestinationArn": "string",
   "ApiDestinationState": "string",
   "CreationTime": number,
   "LastModifiedTime": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApiDestinationArn

The ARN of the API destination that was updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-destination\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$

ApiDestinationState

The state of the API destination that was updated.

Type: String

Valid Values: ACTIVE | INACTIVE

CreationTime

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

Type: Timestamp

LastModifiedTime

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400