Backup / Client / create_restore_testing_plan

create_restore_testing_plan

Backup.Client.create_restore_testing_plan(**kwargs)

This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.

You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.

See also: AWS API Documentation

Request Syntax

response = client.create_restore_testing_plan(
    CreatorRequestId='string',
    RestoreTestingPlan={
        'RecoveryPointSelection': {
            'Algorithm': 'LATEST_WITHIN_WINDOW'|'RANDOM_WITHIN_WINDOW',
            'ExcludeVaults': [
                'string',
            ],
            'IncludeVaults': [
                'string',
            ],
            'RecoveryPointTypes': [
                'CONTINUOUS'|'SNAPSHOT',
            ],
            'SelectionWindowDays': 123
        },
        'RestoreTestingPlanName': 'string',
        'ScheduleExpression': 'string',
        'ScheduleExpressionTimezone': 'string',
        'StartWindowHours': 123
    },
    Tags={
        'string': 'string'
    }
)

Parameters:

• CreatorRequestId (string) – This is a unique string that identifies the request and allows failed requests to be retriedwithout the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.

• RestoreTestingPlan (dict) –

  [REQUIRED]

  A restore testing plan must contain a unique RestoreTestingPlanName string you create and must contain a ScheduleExpression cron. You may optionally include a StartWindowHours integer and a CreatorRequestId string.

  The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.

  • RecoveryPointSelection (dict) – [REQUIRED]

    Required: Algorithm; Required: Recovery point types; IncludeVaults (one or more). Optional: SelectionWindowDays (‘30’ if not specified); ExcludeVaults (list of selectors), defaults to empty list if not listed.

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

      • (string) –

    • SelectionWindowDays (integer) –

      Accepted values are integers from 1 to 365.

  • RestoreTestingPlanName (string) – [REQUIRED]

    The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.

  • ScheduleExpression (string) – [REQUIRED]

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

• Tags (dict) –

  Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: + - = . _ : /.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • CreationTime (datetime) –

    The date and time 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.087AM.

  • RestoreTestingPlanArn (string) –

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

  • RestoreTestingPlanName (string) –

    This unique string is the name of the restore testing plan.

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

Exceptions

• Backup.Client.exceptions.AlreadyExistsException

• Backup.Client.exceptions.ConflictException

• Backup.Client.exceptions.InvalidParameterValueException

• Backup.Client.exceptions.LimitExceededException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ServiceUnavailableException