EventBridge / Client / cancel_replay

cancel_replay#

EventBridge.Client.cancel_replay(**kwargs)#

Cancels the specified replay.

See also: AWS API Documentation

Request Syntax

response = client.cancel_replay(
    ReplayName='string'
)
Parameters:

ReplayName (string) –

[REQUIRED]

The name of the replay to cancel.

Return type:

dict

Returns:

Response Syntax

{
    'ReplayArn': 'string',
    'State': 'STARTING'|'RUNNING'|'CANCELLING'|'COMPLETED'|'CANCELLED'|'FAILED',
    'StateReason': 'string'
}

Response Structure

  • (dict) –

    • ReplayArn (string) –

      The ARN of the replay to cancel.

    • State (string) –

      The current state of the replay.

    • StateReason (string) –

      The reason that the replay is in the current state.

Exceptions

  • EventBridge.Client.exceptions.ResourceNotFoundException

  • EventBridge.Client.exceptions.ConcurrentModificationException

  • EventBridge.Client.exceptions.IllegalStatusException

  • EventBridge.Client.exceptions.InternalException