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

***************
describe_replay
***************



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

  

  Retrieves details about a replay. Use ``DescribeReplay`` to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use ``StartReplay`` and specify an ``EventStartTime`` and an ``EventEndTime`` that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use ``DescribeReplay`` to determine the progress of a replay. The value returned for ``EventLastReplayedTime`` indicates the time within the specified time range associated with the last event replayed.

  

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


  **Request Syntax**
  ::

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

    The name of the replay to retrieve.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ReplayName': 'string',
          'ReplayArn': 'string',
          'Description': 'string',
          'State': 'STARTING'|'RUNNING'|'CANCELLING'|'COMPLETED'|'CANCELLED'|'FAILED',
          'StateReason': 'string',
          'EventSourceArn': 'string',
          'Destination': {
              'Arn': 'string',
              'FilterArns': [
                  'string',
              ]
          },
          'EventStartTime': datetime(2015, 1, 1),
          'EventEndTime': datetime(2015, 1, 1),
          'EventLastReplayedTime': datetime(2015, 1, 1),
          'ReplayStartTime': datetime(2015, 1, 1),
          'ReplayEndTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ReplayName** *(string) --* 

        The name of the replay.

        
      

      - **ReplayArn** *(string) --* 

        The ARN of the replay.

        
      

      - **Description** *(string) --* 

        The description of the replay.

        
      

      - **State** *(string) --* 

        The current state of the replay.

        
      

      - **StateReason** *(string) --* 

        The reason that the replay is in the current state.

        
      

      - **EventSourceArn** *(string) --* 

        The ARN of the archive events were replayed from.

        
      

      - **Destination** *(dict) --* 

        A ``ReplayDestination`` object that contains details about the replay.

        
        

        - **Arn** *(string) --* 

          The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive.

          
        

        - **FilterArns** *(list) --* 

          A list of ARNs for rules to replay events to.

          
          

          - *(string) --* 
      
    
      

      - **EventStartTime** *(datetime) --* 

        The time stamp of the first event that was last replayed from the archive.

        
      

      - **EventEndTime** *(datetime) --* 

        The time stamp for the last event that was replayed from the archive.

        
      

      - **EventLastReplayedTime** *(datetime) --* 

        The time that the event was last replayed.

        
      

      - **ReplayStartTime** *(datetime) --* 

        A time stamp for the time that the replay started.

        
      

      - **ReplayEndTime** *(datetime) --* 

        A time stamp for the time that the replay stopped.

        
  
  **Exceptions**
  
  *   :py:class:`EventBridge.Client.exceptions.ResourceNotFoundException`

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

  