Backup / Client / list_restore_testing_selections

list_restore_testing_selections#

Backup.Client.list_restore_testing_selections(**kwargs)#

Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.

See also: AWS API Documentation

Request Syntax

response = client.list_restore_testing_selections(
    MaxResults=123,
    NextToken='string',
    RestoreTestingPlanName='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.

  • RestoreTestingPlanName (string) –

    [REQUIRED]

    Returns restore testing selections by the specified restore testing plan name.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'RestoreTestingSelections': [
        {
            'CreationTime': datetime(2015, 1, 1),
            'IamRoleArn': 'string',
            'ProtectedResourceType': 'string',
            'RestoreTestingPlanName': 'string',
            'RestoreTestingSelectionName': 'string',
            'ValidationWindowHours': 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.

    • RestoreTestingSelections (list) –

      The returned restore testing selections associated with the restore testing plan.

      • (dict) –

        This contains metadata about a restore testing selection.

        • CreationTime (datetime) –

          The date and time that a restore testing selection 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.

        • IamRoleArn (string) –

          The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

        • ProtectedResourceType (string) –

          The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.

        • RestoreTestingPlanName (string) –

          Unique string that is the name of the restore testing plan.

          The name cannot be changed after creation. The name must consist of only alphanumeric characters and underscores. Maximum length is 50.

        • RestoreTestingSelectionName (string) –

          Unique name of a restore testing selection.

        • ValidationWindowHours (integer) –

          This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.

          Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).

Exceptions

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.ResourceNotFoundException

  • Backup.Client.exceptions.ServiceUnavailableException