Backup / Client / update_restore_testing_selection

update_restore_testing_selection

Backup.Client.update_restore_testing_selection(**kwargs)

Most elements except the RestoreTestingSelectionName can be updated with this request.

RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.

See also: AWS API Documentation

Request Syntax

response = client.update_restore_testing_selection(
    RestoreTestingPlanName='string',
    RestoreTestingSelection={
        'IamRoleArn': 'string',
        'ProtectedResourceArns': [
            'string',
        ],
        'ProtectedResourceConditions': {
            'StringEquals': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'StringNotEquals': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'RestoreMetadataOverrides': {
            'string': 'string'
        },
        'ValidationWindowHours': 123
    },
    RestoreTestingSelectionName='string'
)

Parameters:

• RestoreTestingPlanName (string) –

  [REQUIRED]

  The restore testing plan name is required to update the indicated testing plan.

• RestoreTestingSelection (dict) –

  [REQUIRED]

  To update your restore testing selection, you can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.

  • 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 a list of specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or you can include a wildcard: ProtectedResourceArns: ["*"], but not both.

    • (string) –

  • ProtectedResourceConditions (dict) –

    A list of conditions that you define for resources in your restore testing plan using tags.

    For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "true" },. Condition operators are case sensitive.

    • 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) – [REQUIRED]

          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) – [REQUIRED]

          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) – [REQUIRED]

          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) – [REQUIRED]

          The value of the key.

          Length Constraints: Maximum length of 256.

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

  • 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) –

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

• RestoreTestingSelectionName (string) –

  [REQUIRED]

  This is the required restore testing selection name of the restore testing selection you wish to update.

Return type:

dict

Returns:

Response Syntax

{
    'CreationTime': datetime(2015, 1, 1),
    'RestoreTestingPlanArn': 'string',
    'RestoreTestingPlanName': 'string',
    'RestoreTestingSelectionName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • CreationTime (datetime) –

    This is the time the resource testing selection was updated successfully.

  • RestoreTestingPlanArn (string) –

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

  • RestoreTestingPlanName (string) –

    This is the restore testing plan with which the updated restore testing selection is associated.

  • RestoreTestingSelectionName (string) –

    This is the returned restore testing selection name.

  • UpdateTime (datetime) –

    This is the time the update completed for the restore testing selection.

Exceptions

• Backup.Client.exceptions.ConflictException

• Backup.Client.exceptions.InvalidParameterValueException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ResourceNotFoundException

• Backup.Client.exceptions.ServiceUnavailableException