:doc:`EventBridge <../../events>` / Client / cancel_replay

*************
cancel_replay
*************



.. py:method:: EventBridge.Client.cancel_replay(**kwargs)

  

  Cancels the specified replay.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CancelReplay>`_  


  **Request Syntax**
  ::

    response = client.cancel_replay(
        ReplayName='string'
    )
    
  :type ReplayName: string
  :param ReplayName: **[REQUIRED]** 

    The name of the replay to cancel.

    

  
  
  :rtype: 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**
  
  *   :py:class:`EventBridge.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`EventBridge.Client.exceptions.ConcurrentModificationException`

  
  *   :py:class:`EventBridge.Client.exceptions.IllegalStatusException`

  
  *   :py:class:`EventBridge.Client.exceptions.InternalException`

  