Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListApiDestinations

Retrieves a list of API destination in the account in the current Region.

Request Syntax


{
   "ConnectionArn": "string",
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "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 specified 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

Limit

The maximum number of API destinations to include in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NamePrefix

A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

Type: String

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

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

Required: No

NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

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

Required: No

Response Syntax


{
   "ApiDestinations": [ 
      { 
         "ApiDestinationArn": "string",
         "ApiDestinationState": "string",
         "ConnectionArn": "string",
         "CreationTime": number,
         "HttpMethod": "string",
         "InvocationEndpoint": "string",
         "InvocationRateLimitPerSecond": number,
         "LastModifiedTime": number,
         "Name": "string"
      }
   ],
   "NextToken": "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.

ApiDestinations

An array of ApiDestination objects that include information about an API destination.

Type: Array of ApiDestination objects

NextToken

A token indicating there are more results available. If there are no more results, no token is included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

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

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