CancelReplay
Cancels the specified replay.
Request Syntax
{
"ReplayName": "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.
- ReplayName
-
The name of the replay to cancel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+Required: Yes
Response Syntax
{
"ReplayArn": "string",
"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.
- ReplayArn
-
The ARN of the replay to cancel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/[\.\-_A-Za-z0-9]+$ - State
-
The current state of the replay.
Type: String
Valid Values:
STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED - StateReason
-
The reason that the replay is in the current state.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
.*
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
- IllegalStatusException
-
An error occurred because a replay can be canceled only when the state is Running or Starting.
HTTP Status Code: 400
- 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:
