ListReplays - Amazon EventBridge
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

ListReplays

Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.

Request Syntax

{
   "EventSourceArn": "string",
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "string",
   "State": "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.

EventSourceArn

The ARN of the archive from which the events are replayed.

Type: String

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

Required: No

Limit

The maximum number of replays to retrieve.

Type: Integer

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

Required: No

NamePrefix

A name prefix to filter the replays returned. Only replays with name that match 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

State

The state of the replay.

Type: String

Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED

Required: No

Response Syntax

{
   "NextToken": "string",
   "Replays": [ 
      { 
         "EventEndTime": number,
         "EventLastReplayedTime": number,
         "EventSourceArn": "string",
         "EventStartTime": number,
         "ReplayEndTime": number,
         "ReplayName": "string",
         "ReplayStartTime": number,
         "State": "string",
         "StateReason": "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.

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.

Replays

An array of Replay objects that contain information about the replay.

Type: Array of Replay objects

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: