Backup / Client / get_restore_testing_selection

get_restore_testing_selection#

Backup.Client.get_restore_testing_selection(**kwargs)#

Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.

See also: AWS API Documentation

Request Syntax

response = client.get_restore_testing_selection(
    RestoreTestingPlanName='string',
    RestoreTestingSelectionName='string'
)
Parameters:
  • RestoreTestingPlanName (string) –

    [REQUIRED]

    Required unique name of the restore testing plan.

  • RestoreTestingSelectionName (string) –

    [REQUIRED]

    Required unique name of the restore testing selection.

Return type:

dict

Returns:

Response Syntax

{
    'RestoreTestingSelection': {
        'CreationTime': datetime(2015, 1, 1),
        'CreatorRequestId': 'string',
        'IamRoleArn': 'string',
        'ProtectedResourceArns': [
            'string',
        ],
        'ProtectedResourceConditions': {
            'StringEquals': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'StringNotEquals': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'ProtectedResourceType': 'string',
        'RestoreMetadataOverrides': {
            'string': 'string'
        },
        'RestoreTestingPlanName': 'string',
        'RestoreTestingSelectionName': 'string',
        'ValidationWindowHours': 123
    }
}

Response Structure

  • (dict) –

    • RestoreTestingSelection (dict) –

      Unique name of the 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, 201812: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.

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

      • ProtectedResourceArns (list) –

        You can include specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or you can include a wildcard: ProtectedResourceArns: ["*"], but not both.

        • (string) –

      • ProtectedResourceConditions (dict) –

        In a resource testing selection, this parameter filters by specific conditions such as StringEquals or StringNotEquals.

        • StringEquals (list) –

          Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called “exact matching.”

          • (dict) –

            Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /

            • Key (string) –

              The tag key (String). The key can’t start with aws:.

              Length Constraints: Minimum length of 1. Maximum length of 128.

              Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$

            • Value (string) –

              The value of the key.

              Length Constraints: Maximum length of 256.

              Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

        • StringNotEquals (list) –

          Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called “negated matching.”

          • (dict) –

            Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /

            • Key (string) –

              The tag key (String). The key can’t start with aws:.

              Length Constraints: Minimum length of 1. Maximum length of 128.

              Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$

            • Value (string) –

              The value of the key.

              Length Constraints: Maximum length of 256.

              Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

      • ProtectedResourceType (string) –

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

      • RestoreMetadataOverrides (dict) –

        You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.

        See the complete list of restore testing inferred metadata.

        • (string) –

          • (string) –

      • RestoreTestingPlanName (string) –

        The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.

      • RestoreTestingSelectionName (string) –

        This is the unique name of the restore testing selection that belongs to the related restore testing plan.

      • ValidationWindowHours (integer) –

        This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.

Exceptions

  • Backup.Client.exceptions.ResourceNotFoundException

  • Backup.Client.exceptions.ServiceUnavailableException