Backup / Client / list_restore_testing_plans

list_restore_testing_plans#

Backup.Client.list_restore_testing_plans(**kwargs)#

Returns a list of restore testing plans.

See also: AWS API Documentation

Request Syntax

response = client.list_restore_testing_plans(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of items to be returned.

  • NextToken (string) – The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'RestoreTestingPlans': [
        {
            'CreationTime': datetime(2015, 1, 1),
            'LastExecutionTime': datetime(2015, 1, 1),
            'LastUpdateTime': datetime(2015, 1, 1),
            'RestoreTestingPlanArn': 'string',
            'RestoreTestingPlanName': 'string',
            'ScheduleExpression': 'string',
            'ScheduleExpressionTimezone': 'string',
            'StartWindowHours': 123
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.

    • RestoreTestingPlans (list) –

      This is a returned list of restore testing plans.

      • (dict) –

        This contains metadata about a restore testing plan.

        • 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.

        • 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.

        • RestoreTestingPlanArn (string) –

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

        • RestoreTestingPlanName (string) –

          This is the restore testing plan name.

        • ScheduleExpression (string) –

          A CRON expression in specified timezone when a restore testing plan is executed.

        • 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