:doc:`Backup <../../backup>` / Client / get_restore_testing_plan

************************
get_restore_testing_plan
************************



.. py:method:: Backup.Client.get_restore_testing_plan(**kwargs)

  

  Returns ``RestoreTestingPlan`` details for the specified ``RestoreTestingPlanName``. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetRestoreTestingPlan>`_  


  **Request Syntax**
  ::

    response = client.get_restore_testing_plan(
        RestoreTestingPlanName='string'
    )
    
  :type RestoreTestingPlanName: string
  :param RestoreTestingPlanName: **[REQUIRED]** 

    Required unique name of the restore testing plan.

    

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

    
    ::

      {
          'RestoreTestingPlan': {
              'CreationTime': datetime(2015, 1, 1),
              'CreatorRequestId': 'string',
              'LastExecutionTime': datetime(2015, 1, 1),
              'LastUpdateTime': datetime(2015, 1, 1),
              'RecoveryPointSelection': {
                  'Algorithm': 'LATEST_WITHIN_WINDOW'|'RANDOM_WITHIN_WINDOW',
                  'ExcludeVaults': [
                      'string',
                  ],
                  'IncludeVaults': [
                      'string',
                  ],
                  'RecoveryPointTypes': [
                      'CONTINUOUS'|'SNAPSHOT',
                  ],
                  'SelectionWindowDays': 123
              },
              'RestoreTestingPlanArn': 'string',
              'RestoreTestingPlanName': 'string',
              'ScheduleExpression': 'string',
              'ScheduleExpressionTimezone': 'string',
              'StartWindowHours': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RestoreTestingPlan** *(dict) --* 

        Specifies the body of a restore testing plan. Includes ``RestoreTestingPlanName``.

        
        

        - **CreationTime** *(datetime) --* 

          The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of ``CreationTime`` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

          
        

        - **CreatorRequestId** *(string) --* 

          This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a ``CreatorRequestId`` that matches an existing backup plan, that plan is returned. This parameter is optional.

           

          If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

          
        

        - **LastExecutionTime** *(datetime) --* 

          The last time a restore test was run with the specified restore testing plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of ``LastExecutionDate`` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

          
        

        - **LastUpdateTime** *(datetime) --* 

          The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of ``LastUpdateTime`` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

          
        

        - **RecoveryPointSelection** *(dict) --* 

          The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

          
          

          - **Algorithm** *(string) --* 

            Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"

            
          

          - **ExcludeVaults** *(list) --* 

            Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.

            
            

            - *(string) --* 
        
          

          - **IncludeVaults** *(list) --* 

            Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:*:*:backup-vault:asdf-*", ...]

            
            

            - *(string) --* 
        
          

          - **RecoveryPointTypes** *(list) --* 

            These are the types of recovery points.

             

            Include ``SNAPSHOT`` to restore only snapshot recovery points; include ``CONTINUOUS`` to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for ``Algorithm``.

            
            

            - *(string) --* 
        
          

          - **SelectionWindowDays** *(integer) --* 

            Accepted values are integers from 1 to 365.

            
      
        

        - **RestoreTestingPlanArn** *(string) --* 

          An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

          
        

        - **RestoreTestingPlanName** *(string) --* 

          The restore testing plan name.

          
        

        - **ScheduleExpression** *(string) --* 

          A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, Backup will use the default expression ``cron(0 5 ? * * *)``.

          
        

        - **ScheduleExpressionTimezone** *(string) --* 

          Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

          
        

        - **StartWindowHours** *(integer) --* 

          Defaults to 24 hours.

           

          A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).

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

  
  *   :py:class:`Backup.Client.exceptions.ServiceUnavailableException`

  