DescribeApiDestination
Retrieves details about an API destination.
Request Syntax
{
"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.
- Name
-
The name of the API destination to retrieve.
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",
"ConnectionArn": "string",
"CreationTime": number,
"Description": "string",
"HttpMethod": "string",
"InvocationEndpoint": "string",
"InvocationRateLimitPerSecond": number,
"LastModifiedTime": number,
"Name": "string"
}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 retrieved.
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 retrieved.
Type: String
Valid Values:
ACTIVE | INACTIVE - ConnectionArn
-
The ARN of the connection specified for the API destination retrieved.
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]+$ - CreationTime
-
A time stamp for the time that the API destination was created.
Type: Timestamp
- Description
-
The description for the API destination retrieved.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
.* - HttpMethod
-
The method to use to connect to the HTTP endpoint.
Type: String
Valid Values:
POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE - InvocationEndpoint
-
The URL to use to connect to the HTTP endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$ - InvocationRateLimitPerSecond
-
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.
Type: Integer
Valid Range: Minimum value of 1.
- LastModifiedTime
-
A time stamp for the time that the API destination was last modified.
Type: Timestamp
- Name
-
The name of the API destination retrieved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception occurs due to unexpected causes.
HTTP Status Code: 500
- ResourceNotFoundException
-
An entity that you specified does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
