AWS SDK for PHP 3.x

Service ID: backup

Version: 2018-11-15

This page describes the parameters and results for the operations of the AWS Backup (2018-11-15), and shows how to use the Aws\Backup\BackupClient object to call the described operations. This documentation is specific to the 2018-11-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelLegalHold ( array $params = [] ): This action removes the specified legal hold on a recovery point.
CreateBackupPlan ( array $params = [] ): Creates a backup plan using a backup plan name and backup rules.
CreateBackupSelection ( array $params = [] ): Creates a JSON document that specifies a set of resources to assign to a backup plan.
CreateBackupVault ( array $params = [] ): Creates a logical container where backups are stored.
CreateFramework ( array $params = [] ): Creates a framework with one or more controls.
CreateLegalHold ( array $params = [] ): This action creates a legal hold on a recovery point (backup).
CreateLogicallyAirGappedBackupVault ( array $params = [] ): This request creates a logical container to where backups may be copied.
CreateReportPlan ( array $params = [] ): Creates a report plan.
CreateRestoreTestingPlan ( array $params = [] ): This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
CreateRestoreTestingSelection ( array $params = [] ): This request can be sent after CreateRestoreTestingPlan request returns successfully.
DeleteBackupPlan ( array $params = [] ): Deletes a backup plan.
DeleteBackupSelection ( array $params = [] ): Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
DeleteBackupVault ( array $params = [] ): Deletes the backup vault identified by its name.
DeleteBackupVaultAccessPolicy ( array $params = [] ): Deletes the policy document that manages permissions on a backup vault.
DeleteBackupVaultLockConfiguration ( array $params = [] ): Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
DeleteBackupVaultNotifications ( array $params = [] ): Deletes event notifications for the specified backup vault.
DeleteFramework ( array $params = [] ): Deletes the framework specified by a framework name.
DeleteRecoveryPoint ( array $params = [] ): Deletes the recovery point specified by a recovery point ID.
DeleteReportPlan ( array $params = [] ): Deletes the report plan specified by a report plan name.
DeleteRestoreTestingPlan ( array $params = [] ): This request deletes the specified restore testing plan.
DeleteRestoreTestingSelection ( array $params = [] ): Input the Restore Testing Plan name and Restore Testing Selection name.
DescribeBackupJob ( array $params = [] ): Returns backup job details for the specified BackupJobId.
DescribeBackupVault ( array $params = [] ): Returns metadata about a backup vault specified by its name.
DescribeCopyJob ( array $params = [] ): Returns metadata associated with creating a copy of a resource.
DescribeFramework ( array $params = [] ): Returns the framework details for the specified FrameworkName.
DescribeGlobalSettings ( array $params = [] ): Describes whether the Amazon Web Services account is opted in to cross-account backup.
DescribeProtectedResource ( array $params = [] ): Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
DescribeRecoveryPoint ( array $params = [] ): Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
DescribeRegionSettings ( array $params = [] ): Returns the current service opt-in settings for the Region.
DescribeReportJob ( array $params = [] ): Returns the details associated with creating a report as specified by its ReportJobId.
DescribeReportPlan ( array $params = [] ): Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
DescribeRestoreJob ( array $params = [] ): Returns metadata associated with a restore job that is specified by a job ID.
DisassociateRecoveryPoint ( array $params = [] ): Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS.
DisassociateRecoveryPointFromParent ( array $params = [] ): This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
ExportBackupPlanTemplate ( array $params = [] ): Returns the backup plan that is specified by the plan ID as a backup template.
GetBackupPlan ( array $params = [] ): Returns BackupPlan details for the specified BackupPlanId.
GetBackupPlanFromJSON ( array $params = [] ): Returns a valid JSON document specifying a backup plan or an error.
GetBackupPlanFromTemplate ( array $params = [] ): Returns the template specified by its templateId as a backup plan.
GetBackupSelection ( array $params = [] ): Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
GetBackupVaultAccessPolicy ( array $params = [] ): Returns the access policy document that is associated with the named backup vault.
GetBackupVaultNotifications ( array $params = [] ): Returns event notifications for the specified backup vault.
GetLegalHold ( array $params = [] ): This action returns details for a specified legal hold.
GetRecoveryPointRestoreMetadata ( array $params = [] ): Returns a set of metadata key-value pairs that were used to create the backup.
GetRestoreJobMetadata ( array $params = [] ): This request returns the metadata for the specified restore job.
GetRestoreTestingInferredMetadata ( array $params = [] ): This request returns the minimal required set of metadata needed to start a restore job with secure default settings.
GetRestoreTestingPlan ( array $params = [] ): Returns RestoreTestingPlan details for the specified RestoreTestingPlanName.
GetRestoreTestingSelection ( array $params = [] ): Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
GetSupportedResourceTypes ( array $params = [] ): Returns the Amazon Web Services resource types supported by Backup.
ListBackupJobSummaries ( array $params = [] ): This is a request for a summary of backup jobs created or running within the most recent 30 days.
ListBackupJobs ( array $params = [] ): Returns a list of existing backup jobs for an authenticated account for the last 30 days.
ListBackupPlanTemplates ( array $params = [] ): Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
ListBackupPlanVersions ( array $params = [] ): Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
ListBackupPlans ( array $params = [] ): Returns a list of all active backup plans for an authenticated account.
ListBackupSelections ( array $params = [] ): Returns an array containing metadata of the resources associated with the target backup plan.
ListBackupVaults ( array $params = [] ): Returns a list of recovery point storage containers along with information about them.
ListCopyJobSummaries ( array $params = [] ): This request obtains a list of copy jobs created or running within the the most recent 30 days.
ListCopyJobs ( array $params = [] ): Returns metadata about your copy jobs.
ListFrameworks ( array $params = [] ): Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
ListLegalHolds ( array $params = [] ): This action returns metadata about active and previous legal holds.
ListProtectedResources ( array $params = [] ): Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
ListProtectedResourcesByBackupVault ( array $params = [] ): This request lists the protected resources corresponding to each backup vault.
ListRecoveryPointsByBackupVault ( array $params = [] ): Returns detailed information about the recovery points stored in a backup vault.
ListRecoveryPointsByLegalHold ( array $params = [] ): This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
ListRecoveryPointsByResource ( array $params = [] ): Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
ListReportJobs ( array $params = [] ): Returns details about your report jobs.
ListReportPlans ( array $params = [] ): Returns a list of your report plans.
ListRestoreJobSummaries ( array $params = [] ): This request obtains a summary of restore jobs created or running within the the most recent 30 days.
ListRestoreJobs ( array $params = [] ): Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
ListRestoreJobsByProtectedResource ( array $params = [] ): This returns restore jobs that contain the specified protected resource.
ListRestoreTestingPlans ( array $params = [] ): Returns a list of restore testing plans.
ListRestoreTestingSelections ( array $params = [] ): Returns a list of restore testing selections.
ListTags ( array $params = [] ): Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
PutBackupVaultAccessPolicy ( array $params = [] ): Sets a resource-based policy that is used to manage access permissions on the target backup vault.
PutBackupVaultLockConfiguration ( array $params = [] ): Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault.
PutBackupVaultNotifications ( array $params = [] ): Turns on notifications on a backup vault for the specified topic and events.
PutRestoreValidationResult ( array $params = [] ): This request allows you to send your independent self-run restore test validation results.
StartBackupJob ( array $params = [] ): Starts an on-demand backup job for the specified resource.
StartCopyJob ( array $params = [] ): Starts a job to create a one-time copy of the specified resource.
StartReportJob ( array $params = [] ): Starts an on-demand report job for the specified report plan.
StartRestoreJob ( array $params = [] ): Recovers the saved resource identified by an Amazon Resource Name (ARN).
StopBackupJob ( array $params = [] ): Attempts to cancel a job to create a one-time backup of a resource.
TagResource ( array $params = [] ): Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
UntagResource ( array $params = [] ): Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
UpdateBackupPlan ( array $params = [] ): Updates an existing backup plan identified by its backupPlanId with the input document in JSON format.
UpdateFramework ( array $params = [] ): Updates an existing framework identified by its FrameworkName with the input document in JSON format.
UpdateGlobalSettings ( array $params = [] ): Updates whether the Amazon Web Services account is opted in to cross-account backup.
UpdateRecoveryPointLifecycle ( array $params = [] ): Sets the transition lifecycle of a recovery point.
UpdateRegionSettings ( array $params = [] ): Updates the current service opt-in settings for the Region.
UpdateReportPlan ( array $params = [] ): Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.
UpdateRestoreTestingPlan ( array $params = [] ): This request will send changes to your specified restore testing plan.
UpdateRestoreTestingSelection ( array $params = [] ): Most elements except the RestoreTestingSelectionName can be updated with this request.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListBackupJobSummaries
ListBackupJobs
ListBackupPlanTemplates
ListBackupPlanVersions
ListBackupPlans
ListBackupSelections
ListBackupVaults
ListCopyJobSummaries
ListCopyJobs
ListFrameworks
ListLegalHolds
ListProtectedResources
ListProtectedResourcesByBackupVault
ListRecoveryPointsByBackupVault
ListRecoveryPointsByLegalHold
ListRecoveryPointsByResource
ListReportJobs
ListReportPlans
ListRestoreJobSummaries
ListRestoreJobs
ListRestoreJobsByProtectedResource
ListRestoreTestingPlans
ListRestoreTestingSelections
ListTags

Operations

CancelLegalHold

$result = $client->cancelLegalHold([/* ... */]);
$promise = $client->cancelLegalHoldAsync([/* ... */]);

This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

Parameter Syntax

$result = $client->cancelLegalHold([
    'CancelDescription' => '<string>', // REQUIRED
    'LegalHoldId' => '<string>', // REQUIRED
    'RetainRecordInDays' => <integer>,
]);

Parameter Details

Members

CancelDescription

Required: Yes
Type: string

String describing the reason for removing the legal hold.

LegalHoldId

Required: Yes
Type: string

Legal hold ID required to remove the specified legal hold on a recovery point.

RetainRecordInDays

Type: long (int|float)

The integer amount in days specifying amount of days after this API operation to remove legal hold.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
InvalidResourceStateException:
Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

CreateBackupPlan

$result = $client->createBackupPlan([/* ... */]);
$promise = $client->createBackupPlanAsync([/* ... */]);

Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.

If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Parameter Syntax

$result = $client->createBackupPlan([
    'BackupPlan' => [ // REQUIRED
        'AdvancedBackupSettings' => [
            [
                'BackupOptions' => ['<string>', ...],
                'ResourceType' => '<string>',
            ],
            // ...
        ],
        'BackupPlanName' => '<string>', // REQUIRED
        'Rules' => [ // REQUIRED
            [
                'CompletionWindowMinutes' => <integer>,
                'CopyActions' => [
                    [
                        'DestinationBackupVaultArn' => '<string>', // REQUIRED
                        'Lifecycle' => [
                            'DeleteAfterDays' => <integer>,
                            'MoveToColdStorageAfterDays' => <integer>,
                            'OptInToArchiveForSupportedResources' => true || false,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                    'OptInToArchiveForSupportedResources' => true || false,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleName' => '<string>', // REQUIRED
                'ScheduleExpression' => '<string>',
                'ScheduleExpressionTimezone' => '<string>',
                'StartWindowMinutes' => <integer>,
                'TargetBackupVaultName' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'BackupPlanTags' => ['<string>', ...],
    'CreatorRequestId' => '<string>',
]);

Parameter Details

Members

BackupPlan

Required: Yes
Type: BackupPlanInput structure

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

BackupPlanTags

Type: Associative array of custom strings keys (TagKey) to strings

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

CreatorRequestId

Type: string

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.

Result Syntax

[
    'AdvancedBackupSettings' => [
        [
            'BackupOptions' => ['<string>', ...],
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'BackupPlanArn' => '<string>',
    'BackupPlanId' => '<string>',
    'CreationDate' => <DateTime>,
    'VersionId' => '<string>',
]

Result Details

Members

AdvancedBackupSettings

Type: Array of AdvancedBackupSetting structures

A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

BackupPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanId

Type: string

Uniquely identifies a backup plan.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

VersionId

Type: string

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

Errors

LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
AlreadyExistsException:
The required resource already exists.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

CreateBackupSelection

$result = $client->createBackupSelection([/* ... */]);
$promise = $client->createBackupSelectionAsync([/* ... */]);

Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.

Parameter Syntax

$result = $client->createBackupSelection([
    'BackupPlanId' => '<string>', // REQUIRED
    'BackupSelection' => [ // REQUIRED
        'Conditions' => [
            'StringEquals' => [
                [
                    'ConditionKey' => '<string>',
                    'ConditionValue' => '<string>',
                ],
                // ...
            ],
            'StringLike' => [
                [
                    'ConditionKey' => '<string>',
                    'ConditionValue' => '<string>',
                ],
                // ...
            ],
            'StringNotEquals' => [
                [
                    'ConditionKey' => '<string>',
                    'ConditionValue' => '<string>',
                ],
                // ...
            ],
            'StringNotLike' => [
                [
                    'ConditionKey' => '<string>',
                    'ConditionValue' => '<string>',
                ],
                // ...
            ],
        ],
        'IamRoleArn' => '<string>', // REQUIRED
        'ListOfTags' => [
            [
                'ConditionKey' => '<string>', // REQUIRED
                'ConditionType' => 'STRINGEQUALS', // REQUIRED
                'ConditionValue' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'NotResources' => ['<string>', ...],
        'Resources' => ['<string>', ...],
        'SelectionName' => '<string>', // REQUIRED
    ],
    'CreatorRequestId' => '<string>',
]);

Parameter Details

Members

BackupPlanId

Required: Yes
Type: string

Uniquely identifies the backup plan to be associated with the selection of resources.

BackupSelection

Required: Yes
Type: BackupSelection structure

Specifies the body of a request to assign a set of resources to a backup plan.

CreatorRequestId

Type: string

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

Result Syntax

[
    'BackupPlanId' => '<string>',
    'CreationDate' => <DateTime>,
    'SelectionId' => '<string>',
]

Result Details

Members

BackupPlanId

Type: string

Uniquely identifies a backup plan.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

SelectionId

Type: string

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

Errors

LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
AlreadyExistsException:
The required resource already exists.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

CreateBackupVault

$result = $client->createBackupVault([/* ... */]);
$promise = $client->createBackupVaultAsync([/* ... */]);

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Parameter Syntax

$result = $client->createBackupVault([
    'BackupVaultName' => '<string>', // REQUIRED
    'BackupVaultTags' => ['<string>', ...],
    'CreatorRequestId' => '<string>',
    'EncryptionKeyArn' => '<string>',
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

BackupVaultTags

Type: Associative array of custom strings keys (TagKey) to strings

Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

CreatorRequestId

Type: string

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

EncryptionKeyArn

Type: string

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Result Syntax

[
    'BackupVaultArn' => '<string>',
    'BackupVaultName' => '<string>',
    'CreationDate' => <DateTime>,
]

Result Details

Members

BackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultName

Type: string

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
AlreadyExistsException:
The required resource already exists.

CreateFramework

$result = $client->createFramework([/* ... */]);
$promise = $client->createFrameworkAsync([/* ... */]);

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

Parameter Syntax

$result = $client->createFramework([
    'FrameworkControls' => [ // REQUIRED
        [
            'ControlInputParameters' => [
                [
                    'ParameterName' => '<string>',
                    'ParameterValue' => '<string>',
                ],
                // ...
            ],
            'ControlName' => '<string>', // REQUIRED
            'ControlScope' => [
                'ComplianceResourceIds' => ['<string>', ...],
                'ComplianceResourceTypes' => ['<string>', ...],
                'Tags' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'FrameworkDescription' => '<string>',
    'FrameworkName' => '<string>', // REQUIRED
    'FrameworkTags' => ['<string>', ...],
    'IdempotencyToken' => '<string>',
]);

Parameter Details

Members

FrameworkControls

Required: Yes
Type: Array of FrameworkControl structures

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

FrameworkDescription

Type: string

An optional description of the framework with a maximum of 1,024 characters.

FrameworkName

Required: Yes
Type: string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

FrameworkTags

Type: Associative array of custom strings keys (string) to strings

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

IdempotencyToken

Type: string

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Result Syntax

[
    'FrameworkArn' => '<string>',
    'FrameworkName' => '<string>',
]

Result Details

Members

FrameworkArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

FrameworkName

Type: string

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Errors

AlreadyExistsException:
The required resource already exists.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

CreateLegalHold

$result = $client->createLegalHold([/* ... */]);
$promise = $client->createLegalHoldAsync([/* ... */]);

This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

Parameter Syntax

$result = $client->createLegalHold([
    'Description' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>',
    'RecoveryPointSelection' => [
        'DateRange' => [
            'FromDate' => <integer || string || DateTime>, // REQUIRED
            'ToDate' => <integer || string || DateTime>, // REQUIRED
        ],
        'ResourceIdentifiers' => ['<string>', ...],
        'VaultNames' => ['<string>', ...],
    ],
    'Tags' => ['<string>', ...],
    'Title' => '<string>', // REQUIRED
]);

Parameter Details

Members

Description

Required: Yes
Type: string

This is the string description of the legal hold.

IdempotencyToken

Type: string

This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

RecoveryPointSelection

Type: RecoveryPointSelection structure

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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: + - = . _ : /.

Title

Required: Yes
Type: string

This is the string title of the legal hold.

Result Syntax

[
    'CreationDate' => <DateTime>,
    'Description' => '<string>',
    'LegalHoldArn' => '<string>',
    'LegalHoldId' => '<string>',
    'RecoveryPointSelection' => [
        'DateRange' => [
            'FromDate' => <DateTime>,
            'ToDate' => <DateTime>,
        ],
        'ResourceIdentifiers' => ['<string>', ...],
        'VaultNames' => ['<string>', ...],
    ],
    'Status' => 'CREATING|ACTIVE|CANCELING|CANCELED',
    'Title' => '<string>',
]

Result Details

Members

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

Time in number format when legal hold was created.

Description

Type: string

This is the returned string description of the legal hold.

LegalHoldArn

Type: string

This is the ARN (Amazon Resource Number) of the created legal hold.

LegalHoldId

Type: string

Legal hold ID returned for the specified legal hold on a recovery point.

RecoveryPointSelection

Type: RecoveryPointSelection structure

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

Status

Type: string

This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

Title

Type: string

This is the string title of the legal hold returned after creating the legal hold.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

CreateLogicallyAirGappedBackupVault

$result = $client->createLogicallyAirGappedBackupVault([/* ... */]);
$promise = $client->createLogicallyAirGappedBackupVaultAsync([/* ... */]);

This request creates a logical container to where backups may be copied.

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Parameter Syntax

$result = $client->createLogicallyAirGappedBackupVault([
    'BackupVaultName' => '<string>', // REQUIRED
    'BackupVaultTags' => ['<string>', ...],
    'CreatorRequestId' => '<string>',
    'MaxRetentionDays' => <integer>, // REQUIRED
    'MinRetentionDays' => <integer>, // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

This is the name of the vault that is being created.

BackupVaultTags

Type: Associative array of custom strings keys (TagKey) to strings

These are the tags that will be included in the newly-created vault.

CreatorRequestId

Type: string

This is the ID of the creation request.

This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

MaxRetentionDays

Required: Yes
Type: long (int|float)

This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

MinRetentionDays

Required: Yes
Type: long (int|float)

This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

Result Syntax

[
    'BackupVaultArn' => '<string>',
    'BackupVaultName' => '<string>',
    'CreationDate' => <DateTime>,
    'VaultState' => 'CREATING|AVAILABLE|FAILED',
]

Result Details

Members

BackupVaultArn

Type: string

This is the ARN (Amazon Resource Name) of the vault being created.

BackupVaultName

Type: string

The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the vault was created.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

VaultState

Type: string

This is the current state of the vault.

Errors

AlreadyExistsException:
The required resource already exists.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

CreateReportPlan

$result = $client->createReportPlan([/* ... */]);
$promise = $client->createReportPlanAsync([/* ... */]);

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Parameter Syntax

$result = $client->createReportPlan([
    'IdempotencyToken' => '<string>',
    'ReportDeliveryChannel' => [ // REQUIRED
        'Formats' => ['<string>', ...],
        'S3BucketName' => '<string>', // REQUIRED
        'S3KeyPrefix' => '<string>',
    ],
    'ReportPlanDescription' => '<string>',
    'ReportPlanName' => '<string>', // REQUIRED
    'ReportPlanTags' => ['<string>', ...],
    'ReportSetting' => [ // REQUIRED
        'Accounts' => ['<string>', ...],
        'FrameworkArns' => ['<string>', ...],
        'NumberOfFrameworks' => <integer>,
        'OrganizationUnits' => ['<string>', ...],
        'Regions' => ['<string>', ...],
        'ReportTemplate' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

IdempotencyToken

Type: string

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

ReportDeliveryChannel

Required: Yes
Type: ReportDeliveryChannel structure

A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

ReportPlanDescription

Type: string

An optional description of the report plan with a maximum of 1,024 characters.

ReportPlanName

Required: Yes
Type: string

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

ReportPlanTags

Type: Associative array of custom strings keys (string) to strings

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

ReportSetting

Required: Yes
Type: ReportSetting structure

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'ReportPlanArn' => '<string>',
    'ReportPlanName' => '<string>',
]

Result Details

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a backup vault is 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.

ReportPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

ReportPlanName

Type: string

The unique name of the report plan.

Errors

AlreadyExistsException:
The required resource already exists.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
MissingParameterValueException:
Indicates that a required parameter is missing.

CreateRestoreTestingPlan

$result = $client->createRestoreTestingPlan([/* ... */]);
$promise = $client->createRestoreTestingPlanAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createRestoreTestingPlan([
    'CreatorRequestId' => '<string>',
    'RestoreTestingPlan' => [ // REQUIRED
        'RecoveryPointSelection' => [ // REQUIRED
            'Algorithm' => 'LATEST_WITHIN_WINDOW|RANDOM_WITHIN_WINDOW',
            'ExcludeVaults' => ['<string>', ...],
            'IncludeVaults' => ['<string>', ...],
            'RecoveryPointTypes' => ['<string>', ...],
            'SelectionWindowDays' => <integer>,
        ],
        'RestoreTestingPlanName' => '<string>', // REQUIRED
        'ScheduleExpression' => '<string>', // REQUIRED
        'ScheduleExpressionTimezone' => '<string>',
        'StartWindowHours' => <integer>,
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

CreatorRequestId

Type: 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

Required: Yes
Type: RestoreTestingPlanForCreate structure

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.

Tags

Type: Associative array of custom strings keys (String) to strings

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: + - = . _ : /.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'RestoreTestingPlanArn' => '<string>',
    'RestoreTestingPlanName' => '<string>',
]

Result Details

Members

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Required: Yes
Type: string

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

RestoreTestingPlanName

Required: Yes
Type: 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.

Errors

AlreadyExistsException:
The required resource already exists.
ConflictException:
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

CreateRestoreTestingSelection

$result = $client->createRestoreTestingSelection([/* ... */]);
$promise = $client->createRestoreTestingSelectionAsync([/* ... */]);

This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.

This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:

ProtectedResourceArns
ProtectedResourceConditions

Each protected resource type can have one single value.

A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns.

Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.

Parameter Syntax

$result = $client->createRestoreTestingSelection([
    'CreatorRequestId' => '<string>',
    'RestoreTestingPlanName' => '<string>', // REQUIRED
    'RestoreTestingSelection' => [ // REQUIRED
        'IamRoleArn' => '<string>', // REQUIRED
        'ProtectedResourceArns' => ['<string>', ...],
        'ProtectedResourceConditions' => [
            'StringEquals' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'StringNotEquals' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'ProtectedResourceType' => '<string>', // REQUIRED
        'RestoreMetadataOverrides' => ['<string>', ...],
        'RestoreTestingSelectionName' => '<string>', // REQUIRED
        'ValidationWindowHours' => <integer>,
    ],
]);

Parameter Details

Members

CreatorRequestId

Type: string

This is an optional unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

RestoreTestingPlanName

Required: Yes
Type: string

Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.

RestoreTestingSelection

Required: Yes
Type: RestoreTestingSelectionForCreate structure

This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:

ProtectedResourceArns
ProtectedResourceConditions

Each protected resource type can have one single value.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'RestoreTestingPlanArn' => '<string>',
    'RestoreTestingPlanName' => '<string>',
    'RestoreTestingSelectionName' => '<string>',
]

Result Details

Members

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

RestoreTestingPlanArn

Required: Yes
Type: string

This is the ARN of the restore testing plan with which the restore testing selection is associated.

RestoreTestingPlanName

Required: Yes
Type: string

Unique string that 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.

RestoreTestingSelectionName

Required: Yes
Type: string

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

Errors

AlreadyExistsException:
The required resource already exists.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
MissingParameterValueException:
Indicates that a required parameter is missing.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DeleteBackupPlan

$result = $client->deleteBackupPlan([/* ... */]);
$promise = $client->deleteBackupPlanAsync([/* ... */]);

Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.

Parameter Syntax

$result = $client->deleteBackupPlan([
    'BackupPlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupPlanId

Required: Yes
Type: string

Uniquely identifies a backup plan.

Result Syntax

[
    'BackupPlanArn' => '<string>',
    'BackupPlanId' => '<string>',
    'DeletionDate' => <DateTime>,
    'VersionId' => '<string>',
]

Result Details

Members

BackupPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanId

Type: string

Uniquely identifies a backup plan.

DeletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

VersionId

Type: string

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

DeleteBackupSelection

$result = $client->deleteBackupSelection([/* ... */]);
$promise = $client->deleteBackupSelectionAsync([/* ... */]);

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

Parameter Syntax

$result = $client->deleteBackupSelection([
    'BackupPlanId' => '<string>', // REQUIRED
    'SelectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupPlanId

Required: Yes
Type: string

Uniquely identifies a backup plan.

SelectionId

Required: Yes
Type: string

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DeleteBackupVault

$result = $client->deleteBackupVault([/* ... */]);
$promise = $client->deleteBackupVaultAsync([/* ... */]);

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

Parameter Syntax

$result = $client->deleteBackupVault([
    'BackupVaultName' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

DeleteBackupVaultAccessPolicy

$result = $client->deleteBackupVaultAccessPolicy([/* ... */]);
$promise = $client->deleteBackupVaultAccessPolicyAsync([/* ... */]);

Deletes the policy document that manages permissions on a backup vault.

Parameter Syntax

$result = $client->deleteBackupVaultAccessPolicy([
    'BackupVaultName' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DeleteBackupVaultLockConfiguration

$result = $client->deleteBackupVaultLockConfiguration([/* ... */]);
$promise = $client->deleteBackupVaultLockConfigurationAsync([/* ... */]);

Deletes Backup Vault Lock from a backup vault specified by a backup vault name.

If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.

Parameter Syntax

$result = $client->deleteBackupVaultLockConfiguration([
    'BackupVaultName' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

The name of the backup vault from which to delete Backup Vault Lock.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DeleteBackupVaultNotifications

$result = $client->deleteBackupVaultNotifications([/* ... */]);
$promise = $client->deleteBackupVaultNotificationsAsync([/* ... */]);

Deletes event notifications for the specified backup vault.

Parameter Syntax

$result = $client->deleteBackupVaultNotifications([
    'BackupVaultName' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DeleteFramework

$result = $client->deleteFramework([/* ... */]);
$promise = $client->deleteFrameworkAsync([/* ... */]);

Deletes the framework specified by a framework name.

Parameter Syntax

$result = $client->deleteFramework([
    'FrameworkName' => '<string>', // REQUIRED
]);

Parameter Details

Members

FrameworkName

Required: Yes
Type: string

The unique name of a framework.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
ConflictException:
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

DeleteRecoveryPoint

$result = $client->deleteRecoveryPoint([/* ... */]);
$promise = $client->deleteRecoveryPointAsync([/* ... */]);

Deletes the recovery point specified by a recovery point ID.

If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.

When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state.

EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions.

If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.

Parameter Syntax

$result = $client->deleteRecoveryPoint([
    'BackupVaultName' => '<string>', // REQUIRED
    'RecoveryPointArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

RecoveryPointArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidResourceStateException:
Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

DeleteReportPlan

$result = $client->deleteReportPlan([/* ... */]);
$promise = $client->deleteReportPlanAsync([/* ... */]);

Deletes the report plan specified by a report plan name.

Parameter Syntax

$result = $client->deleteReportPlan([
    'ReportPlanName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ReportPlanName

Required: Yes
Type: string

The unique name of a report plan.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ConflictException:
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

DeleteRestoreTestingPlan

$result = $client->deleteRestoreTestingPlan([/* ... */]);
$promise = $client->deleteRestoreTestingPlanAsync([/* ... */]);

This request deletes the specified restore testing plan.

Deletion can only successfully occur if all associated restore testing selections are deleted first.

Parameter Syntax

$result = $client->deleteRestoreTestingPlan([
    'RestoreTestingPlanName' => '<string>', // REQUIRED
]);

Parameter Details

Members

RestoreTestingPlanName

Required: Yes
Type: string

Required unique name of the restore testing plan you wish to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DeleteRestoreTestingSelection

$result = $client->deleteRestoreTestingSelection([/* ... */]);
$promise = $client->deleteRestoreTestingSelectionAsync([/* ... */]);

Input the Restore Testing Plan name and Restore Testing Selection name.

All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.

Parameter Syntax

$result = $client->deleteRestoreTestingSelection([
    'RestoreTestingPlanName' => '<string>', // REQUIRED
    'RestoreTestingSelectionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

RestoreTestingPlanName

Required: Yes
Type: string

Required unique name of the restore testing plan that contains the restore testing selection you wish to delete.

RestoreTestingSelectionName

Required: Yes
Type: string

Required unique name of the restore testing selection you wish to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DescribeBackupJob

$result = $client->describeBackupJob([/* ... */]);
$promise = $client->describeBackupJobAsync([/* ... */]);

Returns backup job details for the specified BackupJobId.

Parameter Syntax

$result = $client->describeBackupJob([
    'BackupJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupJobId

Required: Yes
Type: string

Uniquely identifies a request to Backup to back up a resource.

Result Syntax

[
    'AccountId' => '<string>',
    'BackupJobId' => '<string>',
    'BackupOptions' => ['<string>', ...],
    'BackupSizeInBytes' => <integer>,
    'BackupType' => '<string>',
    'BackupVaultArn' => '<string>',
    'BackupVaultName' => '<string>',
    'BytesTransferred' => <integer>,
    'ChildJobsInState' => [<integer>, ...],
    'CompletionDate' => <DateTime>,
    'CreatedBy' => [
        'BackupPlanArn' => '<string>',
        'BackupPlanId' => '<string>',
        'BackupPlanVersion' => '<string>',
        'BackupRuleId' => '<string>',
    ],
    'CreationDate' => <DateTime>,
    'ExpectedCompletionDate' => <DateTime>,
    'IamRoleArn' => '<string>',
    'InitiationDate' => <DateTime>,
    'IsParent' => true || false,
    'MessageCategory' => '<string>',
    'NumberOfChildJobs' => <integer>,
    'ParentJobId' => '<string>',
    'PercentDone' => '<string>',
    'RecoveryPointArn' => '<string>',
    'ResourceArn' => '<string>',
    'ResourceName' => '<string>',
    'ResourceType' => '<string>',
    'StartBy' => <DateTime>,
    'State' => 'CREATED|PENDING|RUNNING|ABORTING|ABORTED|COMPLETED|FAILED|EXPIRED|PARTIAL',
    'StatusMessage' => '<string>',
]

Result Details

Members

AccountId

Type: string

Returns the account ID that owns the backup job.

BackupJobId

Type: string

Uniquely identifies a request to Backup to back up a resource.

BackupOptions

Type: Associative array of custom strings keys (BackupOptionKey) to strings

Represents the options specified as part of backup plan or on-demand backup job.

BackupSizeInBytes

Type: long (int|float)

The size, in bytes, of a backup.

BackupType

Type: string

Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.

BackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultName

Type: string

BytesTransferred

Type: long (int|float)

The size in bytes transferred to a backup vault at the time that the job status was queried.

ChildJobsInState

Type: Associative array of custom strings keys (BackupJobState) to long (int|float)s

This returns the statistics of the included child (nested) backup jobs.

CompletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreatedBy

Type: RecoveryPointCreator structure

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

ExpectedCompletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

IamRoleArn

Type: string

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

InitiationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

This is the date a backup job was initiated.

IsParent

Type: boolean

This returns the boolean value that a backup job is a parent (composite) job.

MessageCategory

Type: string

This is the job count for the specified message category.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.

NumberOfChildJobs

Type: long (int|float)

This returns the number of child (nested) backup jobs.

ParentJobId

Type: string

This returns the parent (composite) resource backup job ID.

PercentDone

Type: string

Contains an estimated percentage that is complete of a job at the time the job status was queried.

RecoveryPointArn

Type: string

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceArn

Type: string

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

ResourceName

Type: string

This is the non-unique name of the resource that belongs to the specified backup.

ResourceType

Type: string

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

StartBy

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

State

Type: string

The current state of a backup job.

StatusMessage

Type: string

A detailed message explaining the status of the job to back up a resource.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
DependencyFailureException:
A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

DescribeBackupVault

$result = $client->describeBackupVault([/* ... */]);
$promise = $client->describeBackupVaultAsync([/* ... */]);

Returns metadata about a backup vault specified by its name.

Parameter Syntax

$result = $client->describeBackupVault([
    'BackupVaultAccountId' => '<string>',
    'BackupVaultName' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultAccountId

Type: string

This is the account ID of the specified backup vault.

BackupVaultName

Required: Yes
Type: string

Result Syntax

[
    'BackupVaultArn' => '<string>',
    'BackupVaultName' => '<string>',
    'CreationDate' => <DateTime>,
    'CreatorRequestId' => '<string>',
    'EncryptionKeyArn' => '<string>',
    'LockDate' => <DateTime>,
    'Locked' => true || false,
    'MaxRetentionDays' => <integer>,
    'MinRetentionDays' => <integer>,
    'NumberOfRecoveryPoints' => <integer>,
    'VaultType' => 'BACKUP_VAULT|LOGICALLY_AIR_GAPPED_BACKUP_VAULT',
]

Result Details

Members

BackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultName

Type: string

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreatorRequestId

Type: string

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

EncryptionKeyArn

Type: string

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

LockDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when Backup Vault Lock configuration cannot be changed or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Locked

Type: boolean

A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.

MaxRetentionDays

Type: long (int|float)

The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

MinRetentionDays

Type: long (int|float)

The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

NumberOfRecoveryPoints

Type: long (int|float)

The number of recovery points that are stored in a backup vault.

VaultType

Type: string

This is the type of vault described.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DescribeCopyJob

$result = $client->describeCopyJob([/* ... */]);
$promise = $client->describeCopyJobAsync([/* ... */]);

Returns metadata associated with creating a copy of a resource.

Parameter Syntax

$result = $client->describeCopyJob([
    'CopyJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CopyJobId

Required: Yes
Type: string

Uniquely identifies a copy job.

Result Syntax

[
    'CopyJob' => [
        'AccountId' => '<string>',
        'BackupSizeInBytes' => <integer>,
        'ChildJobsInState' => [<integer>, ...],
        'CompletionDate' => <DateTime>,
        'CompositeMemberIdentifier' => '<string>',
        'CopyJobId' => '<string>',
        'CreatedBy' => [
            'BackupPlanArn' => '<string>',
            'BackupPlanId' => '<string>',
            'BackupPlanVersion' => '<string>',
            'BackupRuleId' => '<string>',
        ],
        'CreationDate' => <DateTime>,
        'DestinationBackupVaultArn' => '<string>',
        'DestinationRecoveryPointArn' => '<string>',
        'IamRoleArn' => '<string>',
        'IsParent' => true || false,
        'MessageCategory' => '<string>',
        'NumberOfChildJobs' => <integer>,
        'ParentJobId' => '<string>',
        'ResourceArn' => '<string>',
        'ResourceName' => '<string>',
        'ResourceType' => '<string>',
        'SourceBackupVaultArn' => '<string>',
        'SourceRecoveryPointArn' => '<string>',
        'State' => 'CREATED|RUNNING|COMPLETED|FAILED|PARTIAL',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

CopyJob

Type: CopyJob structure

Contains detailed information about a copy job.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DescribeFramework

$result = $client->describeFramework([/* ... */]);
$promise = $client->describeFrameworkAsync([/* ... */]);

Returns the framework details for the specified FrameworkName.

Parameter Syntax

$result = $client->describeFramework([
    'FrameworkName' => '<string>', // REQUIRED
]);

Parameter Details

Members

FrameworkName

Required: Yes
Type: string

The unique name of a framework.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'DeploymentStatus' => '<string>',
    'FrameworkArn' => '<string>',
    'FrameworkControls' => [
        [
            'ControlInputParameters' => [
                [
                    'ParameterName' => '<string>',
                    'ParameterValue' => '<string>',
                ],
                // ...
            ],
            'ControlName' => '<string>',
            'ControlScope' => [
                'ComplianceResourceIds' => ['<string>', ...],
                'ComplianceResourceTypes' => ['<string>', ...],
                'Tags' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'FrameworkDescription' => '<string>',
    'FrameworkName' => '<string>',
    'FrameworkStatus' => '<string>',
    'IdempotencyToken' => '<string>',
]

Result Details

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

DeploymentStatus

Type: string

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

FrameworkArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

FrameworkControls

Type: Array of FrameworkControl structures

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

FrameworkDescription

Type: string

An optional description of the framework.

FrameworkName

Type: string

The unique name of a framework.

FrameworkStatus

Type: string

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

ACTIVE when recording is turned on for all resources governed by the framework.
PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
INACTIVE when recording is turned off for all resources governed by the framework.
UNAVAILABLE when Backup is unable to validate recording status at this time.

IdempotencyToken

Type: string

A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DescribeGlobalSettings

$result = $client->describeGlobalSettings([/* ... */]);
$promise = $client->describeGlobalSettingsAsync([/* ... */]);

Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2

Parameter Syntax

$result = $client->describeGlobalSettings([
]);

Parameter Details

Members

Result Syntax

[
    'GlobalSettings' => ['<string>', ...],
    'LastUpdateTime' => <DateTime>,
]

Result Details

Members

GlobalSettings

Type: Associative array of custom strings keys (GlobalSettingsName) to strings

The status of the flag isCrossAccountBackupEnabled.

LastUpdateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the flag isCrossAccountBackupEnabled was last 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.

Errors

InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DescribeProtectedResource

$result = $client->describeProtectedResource([/* ... */]);
$promise = $client->describeProtectedResourceAsync([/* ... */]);

Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.

Parameter Syntax

$result = $client->describeProtectedResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Result Syntax

[
    'LastBackupTime' => <DateTime>,
    'LastBackupVaultArn' => '<string>',
    'LastRecoveryPointArn' => '<string>',
    'LatestRestoreExecutionTimeMinutes' => <integer>,
    'LatestRestoreJobCreationDate' => <DateTime>,
    'LatestRestoreRecoveryPointCreationDate' => <DateTime>,
    'ResourceArn' => '<string>',
    'ResourceName' => '<string>',
    'ResourceType' => '<string>',
]

Result Details

Members

LastBackupTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

LastBackupVaultArn

Type: string

This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.

LastRecoveryPointArn

Type: string

This is the ARN (Amazon Resource Name) of the most recent recovery point.

LatestRestoreExecutionTimeMinutes

Type: long (int|float)

This is the time in minutes the most recent restore job took to complete.

LatestRestoreJobCreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

This is the creation date of the most recent restore job.

LatestRestoreRecoveryPointCreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

This is the date the most recent recovery point was created.

ResourceArn

Type: string

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

ResourceName

Type: string

This is the non-unique name of the resource that belongs to the specified backup.

ResourceType

Type: string

The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.

Errors

MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

DescribeRecoveryPoint

$result = $client->describeRecoveryPoint([/* ... */]);
$promise = $client->describeRecoveryPointAsync([/* ... */]);

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Parameter Syntax

$result = $client->describeRecoveryPoint([
    'BackupVaultAccountId' => '<string>',
    'BackupVaultName' => '<string>', // REQUIRED
    'RecoveryPointArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultAccountId

Type: string

This is the account ID of the specified backup vault.

BackupVaultName

Required: Yes
Type: string

RecoveryPointArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Result Syntax

[
    'BackupSizeInBytes' => <integer>,
    'BackupVaultArn' => '<string>',
    'BackupVaultName' => '<string>',
    'CalculatedLifecycle' => [
        'DeleteAt' => <DateTime>,
        'MoveToColdStorageAt' => <DateTime>,
    ],
    'CompletionDate' => <DateTime>,
    'CompositeMemberIdentifier' => '<string>',
    'CreatedBy' => [
        'BackupPlanArn' => '<string>',
        'BackupPlanId' => '<string>',
        'BackupPlanVersion' => '<string>',
        'BackupRuleId' => '<string>',
    ],
    'CreationDate' => <DateTime>,
    'EncryptionKeyArn' => '<string>',
    'IamRoleArn' => '<string>',
    'IsEncrypted' => true || false,
    'IsParent' => true || false,
    'LastRestoreTime' => <DateTime>,
    'Lifecycle' => [
        'DeleteAfterDays' => <integer>,
        'MoveToColdStorageAfterDays' => <integer>,
        'OptInToArchiveForSupportedResources' => true || false,
    ],
    'ParentRecoveryPointArn' => '<string>',
    'RecoveryPointArn' => '<string>',
    'ResourceArn' => '<string>',
    'ResourceName' => '<string>',
    'ResourceType' => '<string>',
    'SourceBackupVaultArn' => '<string>',
    'Status' => 'COMPLETED|PARTIAL|DELETING|EXPIRED',
    'StatusMessage' => '<string>',
    'StorageClass' => 'WARM|COLD|DELETED',
    'VaultType' => 'BACKUP_VAULT|LOGICALLY_AIR_GAPPED_BACKUP_VAULT',
]

Result Details

Members

BackupSizeInBytes

Type: long (int|float)

The size, in bytes, of a backup.

BackupVaultArn

Type: string

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultName

Type: string

CalculatedLifecycle

Type: CalculatedLifecycle structure

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

CompletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CompositeMemberIdentifier

Type: string

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

CreatedBy

Type: RecoveryPointCreator structure

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

EncryptionKeyArn

Type: string

The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

IamRoleArn

Type: string

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

IsEncrypted

Type: boolean

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

IsParent

Type: boolean

This returns the boolean value that a recovery point is a parent (composite) job.

LastRestoreTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Lifecycle

Type: Lifecycle structure

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

ParentRecoveryPointArn

Type: string

This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

RecoveryPointArn

Type: string

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceArn

Type: string

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

ResourceName

Type: string

This is the non-unique name of the resource that belongs to the specified backup.

ResourceType

Type: string

The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

SourceBackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.

Status

Type: string

A status code specifying the state of the recovery point.

PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.

EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.

STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.

To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.

For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.

StatusMessage

Type: string

A status message explaining the status of the recovery point.

StorageClass

Type: string

Specifies the storage class of the recovery point. Valid values are WARM or COLD.

VaultType

Type: string

This is the type of vault in which the described recovery point is stored.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DescribeRegionSettings

$result = $client->describeRegionSettings([/* ... */]);
$promise = $client->describeRegionSettingsAsync([/* ... */]);

Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.

Parameter Syntax

$result = $client->describeRegionSettings([
]);

Parameter Details

Members

Result Syntax

[
    'ResourceTypeManagementPreference' => [true || false, ...],
    'ResourceTypeOptInPreference' => [true || false, ...],
]

Result Details

Members

ResourceTypeManagementPreference

Type: Associative array of custom strings keys (ResourceType) to booleans

Returns whether Backup fully manages the backups for a resource type.

For the benefits of full Backup management, see Full Backup management.

For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.

If "DynamoDB":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.

ResourceTypeOptInPreference

Type: Associative array of custom strings keys (ResourceType) to booleans

Returns a list of all services along with the opt-in preferences in the Region.

Errors

ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DescribeReportJob

$result = $client->describeReportJob([/* ... */]);
$promise = $client->describeReportJobAsync([/* ... */]);

Returns the details associated with creating a report as specified by its ReportJobId.

Parameter Syntax

$result = $client->describeReportJob([
    'ReportJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ReportJobId

Required: Yes
Type: string

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

Result Syntax

[
    'ReportJob' => [
        'CompletionTime' => <DateTime>,
        'CreationTime' => <DateTime>,
        'ReportDestination' => [
            'S3BucketName' => '<string>',
            'S3Keys' => ['<string>', ...],
        ],
        'ReportJobId' => '<string>',
        'ReportPlanArn' => '<string>',
        'ReportTemplate' => '<string>',
        'Status' => '<string>',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ReportJob

Type: ReportJob structure

A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.

Errors

ServiceUnavailableException:
The request failed due to a temporary failure of the server.
MissingParameterValueException:
Indicates that a required parameter is missing.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

DescribeReportPlan

$result = $client->describeReportPlan([/* ... */]);
$promise = $client->describeReportPlanAsync([/* ... */]);

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Parameter Syntax

$result = $client->describeReportPlan([
    'ReportPlanName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ReportPlanName

Required: Yes
Type: string

The unique name of a report plan.

Result Syntax

[
    'ReportPlan' => [
        'CreationTime' => <DateTime>,
        'DeploymentStatus' => '<string>',
        'LastAttemptedExecutionTime' => <DateTime>,
        'LastSuccessfulExecutionTime' => <DateTime>,
        'ReportDeliveryChannel' => [
            'Formats' => ['<string>', ...],
            'S3BucketName' => '<string>',
            'S3KeyPrefix' => '<string>',
        ],
        'ReportPlanArn' => '<string>',
        'ReportPlanDescription' => '<string>',
        'ReportPlanName' => '<string>',
        'ReportSetting' => [
            'Accounts' => ['<string>', ...],
            'FrameworkArns' => ['<string>', ...],
            'NumberOfFrameworks' => <integer>,
            'OrganizationUnits' => ['<string>', ...],
            'Regions' => ['<string>', ...],
            'ReportTemplate' => '<string>',
        ],
    ],
]

Result Details

Members

ReportPlan

Type: ReportPlan structure

Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

DescribeRestoreJob

$result = $client->describeRestoreJob([/* ... */]);
$promise = $client->describeRestoreJobAsync([/* ... */]);

Returns metadata associated with a restore job that is specified by a job ID.

Parameter Syntax

$result = $client->describeRestoreJob([
    'RestoreJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

RestoreJobId

Required: Yes
Type: string

Uniquely identifies the job that restores a recovery point.

Result Syntax

[
    'AccountId' => '<string>',
    'BackupSizeInBytes' => <integer>,
    'CompletionDate' => <DateTime>,
    'CreatedBy' => [
        'RestoreTestingPlanArn' => '<string>',
    ],
    'CreatedResourceArn' => '<string>',
    'CreationDate' => <DateTime>,
    'DeletionStatus' => 'DELETING|FAILED|SUCCESSFUL',
    'DeletionStatusMessage' => '<string>',
    'ExpectedCompletionTimeMinutes' => <integer>,
    'IamRoleArn' => '<string>',
    'PercentDone' => '<string>',
    'RecoveryPointArn' => '<string>',
    'RecoveryPointCreationDate' => <DateTime>,
    'ResourceType' => '<string>',
    'RestoreJobId' => '<string>',
    'Status' => 'PENDING|RUNNING|COMPLETED|ABORTED|FAILED',
    'StatusMessage' => '<string>',
    'ValidationStatus' => 'FAILED|SUCCESSFUL|TIMED_OUT|VALIDATING',
    'ValidationStatusMessage' => '<string>',
]

Result Details

Members

AccountId

Type: string

Returns the account ID that owns the restore job.

BackupSizeInBytes

Type: long (int|float)

The size, in bytes, of the restored resource.

CompletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreatedBy

Type: RestoreJobCreator structure

Contains identifying information about the creation of a restore job.

CreatedResourceArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

DeletionStatus

Type: string

This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.

DeletionStatusMessage

Type: string

This describes the restore job deletion status.

ExpectedCompletionTimeMinutes

Type: long (int|float)

The amount of time in minutes that a job restoring a recovery point is expected to take.

IamRoleArn

Type: string

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

PercentDone

Type: string

Contains an estimated percentage that is complete of a job at the time the job status was queried.

RecoveryPointArn

Type: string

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

RecoveryPointCreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

This is the creation date of the recovery point made by the specifed restore job.

ResourceType

Type: string

Returns metadata associated with a restore job listed by resource type.

RestoreJobId

Type: string

Uniquely identifies the job that restores a recovery point.

Status

Type: string

Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

StatusMessage

Type: string

A message showing the status of a job to restore a recovery point.

ValidationStatus

Type: string

This is the status of validation run on the indicated restore job.

ValidationStatusMessage

Type: string

This describes the status of validation run on the indicated restore job.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
DependencyFailureException:
A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

DisassociateRecoveryPoint

$result = $client->disassociateRecoveryPoint([/* ... */]);
$promise = $client->disassociateRecoveryPointAsync([/* ... */]);

Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.

Does not support snapshot backup recovery points.

Parameter Syntax

$result = $client->disassociateRecoveryPoint([
    'BackupVaultName' => '<string>', // REQUIRED
    'RecoveryPointArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

The unique name of an Backup vault.

RecoveryPointArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidResourceStateException:
Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

DisassociateRecoveryPointFromParent

$result = $client->disassociateRecoveryPointFromParent([/* ... */]);
$promise = $client->disassociateRecoveryPointFromParentAsync([/* ... */]);

This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.

Parameter Syntax

$result = $client->disassociateRecoveryPointFromParent([
    'BackupVaultName' => '<string>', // REQUIRED
    'RecoveryPointArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

This is the name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

RecoveryPointArn

Required: Yes
Type: string

This is the Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

ExportBackupPlanTemplate

$result = $client->exportBackupPlanTemplate([/* ... */]);
$promise = $client->exportBackupPlanTemplateAsync([/* ... */]);

Returns the backup plan that is specified by the plan ID as a backup template.

Parameter Syntax

$result = $client->exportBackupPlanTemplate([
    'BackupPlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupPlanId

Required: Yes
Type: string

Uniquely identifies a backup plan.

Result Syntax

[
    'BackupPlanTemplateJson' => '<string>',
]

Result Details

Members

BackupPlanTemplateJson

Type: string

The body of a backup plan template in JSON format.

This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

GetBackupPlan

$result = $client->getBackupPlan([/* ... */]);
$promise = $client->getBackupPlanAsync([/* ... */]);

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Parameter Syntax

$result = $client->getBackupPlan([
    'BackupPlanId' => '<string>', // REQUIRED
    'VersionId' => '<string>',
]);

Parameter Details

Members

BackupPlanId

Required: Yes
Type: string

Uniquely identifies a backup plan.

VersionId

Type: string

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Result Syntax

[
    'AdvancedBackupSettings' => [
        [
            'BackupOptions' => ['<string>', ...],
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'BackupPlan' => [
        'AdvancedBackupSettings' => [
            [
                'BackupOptions' => ['<string>', ...],
                'ResourceType' => '<string>',
            ],
            // ...
        ],
        'BackupPlanName' => '<string>',
        'Rules' => [
            [
                'CompletionWindowMinutes' => <integer>,
                'CopyActions' => [
                    [
                        'DestinationBackupVaultArn' => '<string>',
                        'Lifecycle' => [
                            'DeleteAfterDays' => <integer>,
                            'MoveToColdStorageAfterDays' => <integer>,
                            'OptInToArchiveForSupportedResources' => true || false,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                    'OptInToArchiveForSupportedResources' => true || false,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleId' => '<string>',
                'RuleName' => '<string>',
                'ScheduleExpression' => '<string>',
                'ScheduleExpressionTimezone' => '<string>',
                'StartWindowMinutes' => <integer>,
                'TargetBackupVaultName' => '<string>',
            ],
            // ...
        ],
    ],
    'BackupPlanArn' => '<string>',
    'BackupPlanId' => '<string>',
    'CreationDate' => <DateTime>,
    'CreatorRequestId' => '<string>',
    'DeletionDate' => <DateTime>,
    'LastExecutionDate' => <DateTime>,
    'VersionId' => '<string>',
]

Result Details

Members

AdvancedBackupSettings

Type: Array of AdvancedBackupSetting structures

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

BackupPlan

Type: BackupPlan structure

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

BackupPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanId

Type: string

Uniquely identifies a backup plan.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

CreatorRequestId

Type: string

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

DeletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

LastExecutionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time a job to back up resources was run with this backup 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.

VersionId

Type: string

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

GetBackupPlanFromJSON

$result = $client->getBackupPlanFromJSON([/* ... */]);
$promise = $client->getBackupPlanFromJSONAsync([/* ... */]);

Returns a valid JSON document specifying a backup plan or an error.

Parameter Syntax

$result = $client->getBackupPlanFromJSON([
    'BackupPlanTemplateJson' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupPlanTemplateJson

Required: Yes
Type: string

A customer-supplied backup plan document in JSON format.

Result Syntax

[
    'BackupPlan' => [
        'AdvancedBackupSettings' => [
            [
                'BackupOptions' => ['<string>', ...],
                'ResourceType' => '<string>',
            ],
            // ...
        ],
        'BackupPlanName' => '<string>',
        'Rules' => [
            [
                'CompletionWindowMinutes' => <integer>,
                'CopyActions' => [
                    [
                        'DestinationBackupVaultArn' => '<string>',
                        'Lifecycle' => [
                            'DeleteAfterDays' => <integer>,
                            'MoveToColdStorageAfterDays' => <integer>,
                            'OptInToArchiveForSupportedResources' => true || false,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                    'OptInToArchiveForSupportedResources' => true || false,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleId' => '<string>',
                'RuleName' => '<string>',
                'ScheduleExpression' => '<string>',
                'ScheduleExpressionTimezone' => '<string>',
                'StartWindowMinutes' => <integer>,
                'TargetBackupVaultName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

BackupPlan

Type: BackupPlan structure

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Errors

LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

GetBackupPlanFromTemplate

$result = $client->getBackupPlanFromTemplate([/* ... */]);
$promise = $client->getBackupPlanFromTemplateAsync([/* ... */]);

Returns the template specified by its templateId as a backup plan.

Parameter Syntax

$result = $client->getBackupPlanFromTemplate([
    'BackupPlanTemplateId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupPlanTemplateId

Required: Yes
Type: string

Uniquely identifies a stored backup plan template.

Result Syntax

[
    'BackupPlanDocument' => [
        'AdvancedBackupSettings' => [
            [
                'BackupOptions' => ['<string>', ...],
                'ResourceType' => '<string>',
            ],
            // ...
        ],
        'BackupPlanName' => '<string>',
        'Rules' => [
            [
                'CompletionWindowMinutes' => <integer>,
                'CopyActions' => [
                    [
                        'DestinationBackupVaultArn' => '<string>',
                        'Lifecycle' => [
                            'DeleteAfterDays' => <integer>,
                            'MoveToColdStorageAfterDays' => <integer>,
                            'OptInToArchiveForSupportedResources' => true || false,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                    'OptInToArchiveForSupportedResources' => true || false,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleId' => '<string>',
                'RuleName' => '<string>',
                'ScheduleExpression' => '<string>',
                'ScheduleExpressionTimezone' => '<string>',
                'StartWindowMinutes' => <integer>,
                'TargetBackupVaultName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

BackupPlanDocument

Type: BackupPlan structure

Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

GetBackupSelection

$result = $client->getBackupSelection([/* ... */]);
$promise = $client->getBackupSelectionAsync([/* ... */]);

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

Parameter Syntax

$result = $client->getBackupSelection([
    'BackupPlanId' => '<string>', // REQUIRED
    'SelectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupPlanId

Required: Yes
Type: string

Uniquely identifies a backup plan.

SelectionId

Required: Yes
Type: string

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

Result Syntax

[
    'BackupPlanId' => '<string>',
    'BackupSelection' => [
        'Conditions' => [
            'StringEquals' => [
                [
                    'ConditionKey' => '<string>',
                    'ConditionValue' => '<string>',
                ],
                // ...
            ],
            'StringLike' => [
                [
                    'ConditionKey' => '<string>',
                    'ConditionValue' => '<string>',
                ],
                // ...
            ],
            'StringNotEquals' => [
                [
                    'ConditionKey' => '<string>',
                    'ConditionValue' => '<string>',
                ],
                // ...
            ],
            'StringNotLike' => [
                [
                    'ConditionKey' => '<string>',
                    'ConditionValue' => '<string>',
                ],
                // ...
            ],
        ],
        'IamRoleArn' => '<string>',
        'ListOfTags' => [
            [
                'ConditionKey' => '<string>',
                'ConditionType' => 'STRINGEQUALS',
                'ConditionValue' => '<string>',
            ],
            // ...
        ],
        'NotResources' => ['<string>', ...],
        'Resources' => ['<string>', ...],
        'SelectionName' => '<string>',
    ],
    'CreationDate' => <DateTime>,
    'CreatorRequestId' => '<string>',
    'SelectionId' => '<string>',
]

Result Details

Members

BackupPlanId

Type: string

Uniquely identifies a backup plan.

BackupSelection

Type: BackupSelection structure

Specifies the body of a request to assign a set of resources to a backup plan.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

CreatorRequestId

Type: string

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

SelectionId

Type: string

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

GetBackupVaultAccessPolicy

$result = $client->getBackupVaultAccessPolicy([/* ... */]);
$promise = $client->getBackupVaultAccessPolicyAsync([/* ... */]);

Returns the access policy document that is associated with the named backup vault.

Parameter Syntax

$result = $client->getBackupVaultAccessPolicy([
    'BackupVaultName' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

Result Syntax

[
    'BackupVaultArn' => '<string>',
    'BackupVaultName' => '<string>',
    'Policy' => '<string>',
]

Result Details

Members

BackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultName

Type: string

Policy

Type: string

The backup vault access policy document in JSON format.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

GetBackupVaultNotifications

$result = $client->getBackupVaultNotifications([/* ... */]);
$promise = $client->getBackupVaultNotificationsAsync([/* ... */]);

Returns event notifications for the specified backup vault.

Parameter Syntax

$result = $client->getBackupVaultNotifications([
    'BackupVaultName' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

Result Syntax

[
    'BackupVaultArn' => '<string>',
    'BackupVaultEvents' => ['<string>', ...],
    'BackupVaultName' => '<string>',
    'SNSTopicArn' => '<string>',
]

Result Details

Members

BackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultEvents

Type: Array of strings

An array of events that indicate the status of jobs to back up resources to the backup vault.

BackupVaultName

Type: string

SNSTopicArn

Type: string

An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

GetLegalHold

$result = $client->getLegalHold([/* ... */]);
$promise = $client->getLegalHoldAsync([/* ... */]);

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

Parameter Syntax

$result = $client->getLegalHold([
    'LegalHoldId' => '<string>', // REQUIRED
]);

Parameter Details

Members

LegalHoldId

Required: Yes
Type: string

This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.

Result Syntax

[
    'CancelDescription' => '<string>',
    'CancellationDate' => <DateTime>,
    'CreationDate' => <DateTime>,
    'Description' => '<string>',
    'LegalHoldArn' => '<string>',
    'LegalHoldId' => '<string>',
    'RecoveryPointSelection' => [
        'DateRange' => [
            'FromDate' => <DateTime>,
            'ToDate' => <DateTime>,
        ],
        'ResourceIdentifiers' => ['<string>', ...],
        'VaultNames' => ['<string>', ...],
    ],
    'RetainRecordUntil' => <DateTime>,
    'Status' => 'CREATING|ACTIVE|CANCELING|CANCELED',
    'Title' => '<string>',
]

Result Details

Members

CancelDescription

Type: string

String describing the reason for removing the legal hold.

CancellationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

Time in number when legal hold was cancelled.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

Time in number format when legal hold was created.

Description

Type: string

This is the returned string description of the legal hold.

LegalHoldArn

Type: string

This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

LegalHoldId

Type: string

This is the returned ID associated with a specified legal hold.

RecoveryPointSelection

Type: RecoveryPointSelection structure

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

RetainRecordUntil

Type: timestamp (string|DateTime or anything parsable by strtotime)

This is the date and time until which the legal hold record will be retained.

Status

Type: string

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

Title

Type: string

This is the string title of the legal hold.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

GetRecoveryPointRestoreMetadata

$result = $client->getRecoveryPointRestoreMetadata([/* ... */]);
$promise = $client->getRecoveryPointRestoreMetadataAsync([/* ... */]);

Returns a set of metadata key-value pairs that were used to create the backup.

Parameter Syntax

$result = $client->getRecoveryPointRestoreMetadata([
    'BackupVaultAccountId' => '<string>',
    'BackupVaultName' => '<string>', // REQUIRED
    'RecoveryPointArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultAccountId

Type: string

This is the account ID of the specified backup vault.

BackupVaultName

Required: Yes
Type: string

RecoveryPointArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Result Syntax

[
    'BackupVaultArn' => '<string>',
    'RecoveryPointArn' => '<string>',
    'ResourceType' => '<string>',
    'RestoreMetadata' => ['<string>', ...],
]

Result Details

Members

BackupVaultArn

Type: string

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

RecoveryPointArn

Type: string

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceType

Type: string

This is the resource type associated with the recovery point.

RestoreMetadata

Type: Associative array of custom strings keys (MetadataKey) to strings

The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

GetRestoreJobMetadata

$result = $client->getRestoreJobMetadata([/* ... */]);
$promise = $client->getRestoreJobMetadataAsync([/* ... */]);

This request returns the metadata for the specified restore job.

Parameter Syntax

$result = $client->getRestoreJobMetadata([
    'RestoreJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

RestoreJobId

Required: Yes
Type: string

This is a unique identifier of a restore job within Backup.

Result Syntax

[
    'Metadata' => ['<string>', ...],
    'RestoreJobId' => '<string>',
]

Result Details

Members

Metadata

Type: Associative array of custom strings keys (MetadataKey) to strings

This contains the metadata of the specified backup job.

RestoreJobId

Type: string

This is a unique identifier of a restore job within Backup.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

GetRestoreTestingInferredMetadata

$result = $client->getRestoreTestingInferredMetadata([/* ... */]);
$promise = $client->getRestoreTestingInferredMetadataAsync([/* ... */]);

This request returns the minimal required set of metadata needed to start a restore job with secure default settings. BackupVaultName and RecoveryPointArn are required parameters. BackupVaultAccountId is an optional parameter.

Parameter Syntax

$result = $client->getRestoreTestingInferredMetadata([
    'BackupVaultAccountId' => '<string>',
    'BackupVaultName' => '<string>', // REQUIRED
    'RecoveryPointArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultAccountId

Type: string

This is the account ID of the specified backup vault.

BackupVaultName

Required: Yes
Type: string

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web ServicesRegion where they are created. They consist of letters, numbers, and hyphens.

RecoveryPointArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Result Syntax

[
    'InferredMetadata' => ['<string>', ...],
]

Result Details

Members

InferredMetadata

Required: Yes
Type: Associative array of custom strings keys (string) to strings

This is a string map of the metadata inferred from the request.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

GetRestoreTestingPlan

$result = $client->getRestoreTestingPlan([/* ... */]);
$promise = $client->getRestoreTestingPlanAsync([/* ... */]);

Returns RestoreTestingPlan details for the specified RestoreTestingPlanName. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.

Parameter Syntax

$result = $client->getRestoreTestingPlan([
    'RestoreTestingPlanName' => '<string>', // REQUIRED
]);

Parameter Details

Members

RestoreTestingPlanName

Required: Yes
Type: string

Required unique name of the restore testing plan.

Result Syntax

[
    'RestoreTestingPlan' => [
        'CreationTime' => <DateTime>,
        'CreatorRequestId' => '<string>',
        'LastExecutionTime' => <DateTime>,
        'LastUpdateTime' => <DateTime>,
        'RecoveryPointSelection' => [
            'Algorithm' => 'LATEST_WITHIN_WINDOW|RANDOM_WITHIN_WINDOW',
            'ExcludeVaults' => ['<string>', ...],
            'IncludeVaults' => ['<string>', ...],
            'RecoveryPointTypes' => ['<string>', ...],
            'SelectionWindowDays' => <integer>,
        ],
        'RestoreTestingPlanArn' => '<string>',
        'RestoreTestingPlanName' => '<string>',
        'ScheduleExpression' => '<string>',
        'ScheduleExpressionTimezone' => '<string>',
        'StartWindowHours' => <integer>,
    ],
]

Result Details

Members

RestoreTestingPlan

Required: Yes
Type: RestoreTestingPlanForGet structure

Specifies the body of a restore testing plan. Includes RestoreTestingPlanName.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

GetRestoreTestingSelection

$result = $client->getRestoreTestingSelection([/* ... */]);
$promise = $client->getRestoreTestingSelectionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getRestoreTestingSelection([
    'RestoreTestingPlanName' => '<string>', // REQUIRED
    'RestoreTestingSelectionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

RestoreTestingPlanName

Required: Yes
Type: string

Required unique name of the restore testing plan.

RestoreTestingSelectionName

Required: Yes
Type: string

Required unique name of the restore testing selection.

Result Syntax

[
    'RestoreTestingSelection' => [
        'CreationTime' => <DateTime>,
        'CreatorRequestId' => '<string>',
        'IamRoleArn' => '<string>',
        'ProtectedResourceArns' => ['<string>', ...],
        'ProtectedResourceConditions' => [
            'StringEquals' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'StringNotEquals' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'ProtectedResourceType' => '<string>',
        'RestoreMetadataOverrides' => ['<string>', ...],
        'RestoreTestingPlanName' => '<string>',
        'RestoreTestingSelectionName' => '<string>',
        'ValidationWindowHours' => <integer>,
    ],
]

Result Details

Members

RestoreTestingSelection

Required: Yes
Type: RestoreTestingSelectionForGet structure

Unique name of the restore testing selection.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

GetSupportedResourceTypes

$result = $client->getSupportedResourceTypes([/* ... */]);
$promise = $client->getSupportedResourceTypesAsync([/* ... */]);

Returns the Amazon Web Services resource types supported by Backup.

Parameter Syntax

$result = $client->getSupportedResourceTypes([
]);

Parameter Details

Members

Result Syntax

[
    'ResourceTypes' => ['<string>', ...],
]

Result Details

Members

ResourceTypes

Type: Array of strings

Contains a string with the supported Amazon Web Services resource types:

Aurora for Amazon Aurora
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSX for Amazon FSx
RDS for Amazon Relational Database Service
Storage Gateway for Storage Gateway
DocDB for Amazon DocumentDB (with MongoDB compatibility)
Neptune for Amazon Neptune

Errors

ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListBackupJobSummaries

$result = $client->listBackupJobSummaries([/* ... */]);
$promise = $client->listBackupJobSummariesAsync([/* ... */]);

This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Parameter Syntax

$result = $client->listBackupJobSummaries([
    'AccountId' => '<string>',
    'AggregationPeriod' => 'ONE_DAY|SEVEN_DAYS|FOURTEEN_DAYS',
    'MaxResults' => <integer>,
    'MessageCategory' => '<string>',
    'NextToken' => '<string>',
    'ResourceType' => '<string>',
    'State' => 'CREATED|PENDING|RUNNING|ABORTING|ABORTED|COMPLETED|FAILED|EXPIRED|PARTIAL|AGGREGATE_ALL|ANY',
]);

Parameter Details

Members

AccountId

Type: string

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

AggregationPeriod

Type: string

This is the period that sets the boundaries for returned results.

Acceptable values include

ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.

MaxResults

Type: int

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

MessageCategory

Type: string

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

NextToken

Type: string

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

ResourceType

Type: string

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

State

Type: string

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

Result Syntax

[
    'AggregationPeriod' => '<string>',
    'BackupJobSummaries' => [
        [
            'AccountId' => '<string>',
            'Count' => <integer>,
            'EndTime' => <DateTime>,
            'MessageCategory' => '<string>',
            'Region' => '<string>',
            'ResourceType' => '<string>',
            'StartTime' => <DateTime>,
            'State' => 'CREATED|PENDING|RUNNING|ABORTING|ABORTED|COMPLETED|FAILED|EXPIRED|PARTIAL|AGGREGATE_ALL|ANY',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AggregationPeriod

Type: string

This is the period that sets the boundaries for returned results.

ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.

BackupJobSummaries

Type: Array of BackupJobSummary structures

This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

NextToken

Type: string

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListBackupJobs

$result = $client->listBackupJobs([/* ... */]);
$promise = $client->listBackupJobsAsync([/* ... */]);

Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.

Parameter Syntax

$result = $client->listBackupJobs([
    'ByAccountId' => '<string>',
    'ByBackupVaultName' => '<string>',
    'ByCompleteAfter' => <integer || string || DateTime>,
    'ByCompleteBefore' => <integer || string || DateTime>,
    'ByCreatedAfter' => <integer || string || DateTime>,
    'ByCreatedBefore' => <integer || string || DateTime>,
    'ByMessageCategory' => '<string>',
    'ByParentJobId' => '<string>',
    'ByResourceArn' => '<string>',
    'ByResourceType' => '<string>',
    'ByState' => 'CREATED|PENDING|RUNNING|ABORTING|ABORTED|COMPLETED|FAILED|EXPIRED|PARTIAL',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ByAccountId

Type: string

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

If used from an Organizations management account, passing * returns all jobs across the organization.

ByBackupVaultName

Type: string

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

ByCompleteAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

ByCompleteBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

ByCreatedAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only backup jobs that were created after the specified date.

ByCreatedBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only backup jobs that were created before the specified date.

ByMessageCategory

Type: string

This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters.

View Monitoring

The wildcard () returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

ByParentJobId

Type: string

This is a filter to list child (nested) jobs based on parent job ID.

ByResourceArn

Type: string

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

ByResourceType

Type: string

Returns only backup jobs for the specified resources:

Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines

ByState

Type: string

Returns only backup jobs that are in the specified state.

To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

GET /backup-jobs/?state=COMPLETED

GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: 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 next token.

Result Syntax

[
    'BackupJobs' => [
        [
            'AccountId' => '<string>',
            'BackupJobId' => '<string>',
            'BackupOptions' => ['<string>', ...],
            'BackupSizeInBytes' => <integer>,
            'BackupType' => '<string>',
            'BackupVaultArn' => '<string>',
            'BackupVaultName' => '<string>',
            'BytesTransferred' => <integer>,
            'CompletionDate' => <DateTime>,
            'CreatedBy' => [
                'BackupPlanArn' => '<string>',
                'BackupPlanId' => '<string>',
                'BackupPlanVersion' => '<string>',
                'BackupRuleId' => '<string>',
            ],
            'CreationDate' => <DateTime>,
            'ExpectedCompletionDate' => <DateTime>,
            'IamRoleArn' => '<string>',
            'InitiationDate' => <DateTime>,
            'IsParent' => true || false,
            'MessageCategory' => '<string>',
            'ParentJobId' => '<string>',
            'PercentDone' => '<string>',
            'RecoveryPointArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceName' => '<string>',
            'ResourceType' => '<string>',
            'StartBy' => <DateTime>,
            'State' => 'CREATED|PENDING|RUNNING|ABORTING|ABORTED|COMPLETED|FAILED|EXPIRED|PARTIAL',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

BackupJobs

Type: Array of BackupJob structures

An array of structures containing metadata about your backup jobs returned in JSON format.

NextToken

Type: string

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListBackupPlanTemplates

$result = $client->listBackupPlanTemplates([/* ... */]);
$promise = $client->listBackupPlanTemplatesAsync([/* ... */]);

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

Parameter Syntax

$result = $client->listBackupPlanTemplates([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'BackupPlanTemplatesList' => [
        [
            'BackupPlanTemplateId' => '<string>',
            'BackupPlanTemplateName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

BackupPlanTemplatesList

Type: Array of BackupPlanTemplatesListMember structures

An array of template list items containing metadata about your saved templates.

NextToken

Type: string

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

ListBackupPlanVersions

$result = $client->listBackupPlanVersions([/* ... */]);
$promise = $client->listBackupPlanVersionsAsync([/* ... */]);

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

Parameter Syntax

$result = $client->listBackupPlanVersions([
    'BackupPlanId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

BackupPlanId

Required: Yes
Type: string

Uniquely identifies a backup plan.

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'BackupPlanVersionsList' => [
        [
            'AdvancedBackupSettings' => [
                [
                    'BackupOptions' => ['<string>', ...],
                    'ResourceType' => '<string>',
                ],
                // ...
            ],
            'BackupPlanArn' => '<string>',
            'BackupPlanId' => '<string>',
            'BackupPlanName' => '<string>',
            'CreationDate' => <DateTime>,
            'CreatorRequestId' => '<string>',
            'DeletionDate' => <DateTime>,
            'LastExecutionDate' => <DateTime>,
            'VersionId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

BackupPlanVersionsList

Type: Array of BackupPlansListMember structures

An array of version list items containing metadata about your backup plans.

NextToken

Type: string

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListBackupPlans

$result = $client->listBackupPlans([/* ... */]);
$promise = $client->listBackupPlansAsync([/* ... */]);

Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

Parameter Syntax

$result = $client->listBackupPlans([
    'IncludeDeleted' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

IncludeDeleted

Type: boolean

A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'BackupPlansList' => [
        [
            'AdvancedBackupSettings' => [
                [
                    'BackupOptions' => ['<string>', ...],
                    'ResourceType' => '<string>',
                ],
                // ...
            ],
            'BackupPlanArn' => '<string>',
            'BackupPlanId' => '<string>',
            'BackupPlanName' => '<string>',
            'CreationDate' => <DateTime>,
            'CreatorRequestId' => '<string>',
            'DeletionDate' => <DateTime>,
            'LastExecutionDate' => <DateTime>,
            'VersionId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

BackupPlansList

Type: Array of BackupPlansListMember structures

An array of backup plan list items containing metadata about your saved backup plans.

NextToken

Type: string

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListBackupSelections

$result = $client->listBackupSelections([/* ... */]);
$promise = $client->listBackupSelectionsAsync([/* ... */]);

Returns an array containing metadata of the resources associated with the target backup plan.

Parameter Syntax

$result = $client->listBackupSelections([
    'BackupPlanId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

BackupPlanId

Required: Yes
Type: string

Uniquely identifies a backup plan.

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'BackupSelectionsList' => [
        [
            'BackupPlanId' => '<string>',
            'CreationDate' => <DateTime>,
            'CreatorRequestId' => '<string>',
            'IamRoleArn' => '<string>',
            'SelectionId' => '<string>',
            'SelectionName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

BackupSelectionsList

Type: Array of BackupSelectionsListMember structures

An array of backup selection list items containing metadata about each resource in the list.

NextToken

Type: string

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListBackupVaults

$result = $client->listBackupVaults([/* ... */]);
$promise = $client->listBackupVaultsAsync([/* ... */]);

Returns a list of recovery point storage containers along with information about them.

Parameter Syntax

$result = $client->listBackupVaults([
    'ByShared' => true || false,
    'ByVaultType' => 'BACKUP_VAULT|LOGICALLY_AIR_GAPPED_BACKUP_VAULT',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ByShared

Type: boolean

This parameter will sort the list of vaults by shared vaults.

ByVaultType

Type: string

This parameter will sort the list of vaults by vault type.

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'BackupVaultList' => [
        [
            'BackupVaultArn' => '<string>',
            'BackupVaultName' => '<string>',
            'CreationDate' => <DateTime>,
            'CreatorRequestId' => '<string>',
            'EncryptionKeyArn' => '<string>',
            'LockDate' => <DateTime>,
            'Locked' => true || false,
            'MaxRetentionDays' => <integer>,
            'MinRetentionDays' => <integer>,
            'NumberOfRecoveryPoints' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

BackupVaultList

Type: Array of BackupVaultListMember structures

An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

NextToken

Type: string

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListCopyJobSummaries

$result = $client->listCopyJobSummaries([/* ... */]);
$promise = $client->listCopyJobSummariesAsync([/* ... */]);

This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Parameter Syntax

$result = $client->listCopyJobSummaries([
    'AccountId' => '<string>',
    'AggregationPeriod' => 'ONE_DAY|SEVEN_DAYS|FOURTEEN_DAYS',
    'MaxResults' => <integer>,
    'MessageCategory' => '<string>',
    'NextToken' => '<string>',
    'ResourceType' => '<string>',
    'State' => 'CREATED|RUNNING|ABORTING|ABORTED|COMPLETING|COMPLETED|FAILING|FAILED|PARTIAL|AGGREGATE_ALL|ANY',
]);

Parameter Details

Members

AccountId

Type: string

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

AggregationPeriod

Type: string

This is the period that sets the boundaries for returned results.

ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.

MaxResults

Type: int

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

MessageCategory

Type: string

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

NextToken

Type: string

ResourceType

Type: string

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

State

Type: string

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Result Syntax

[
    'AggregationPeriod' => '<string>',
    'CopyJobSummaries' => [
        [
            'AccountId' => '<string>',
            'Count' => <integer>,
            'EndTime' => <DateTime>,
            'MessageCategory' => '<string>',
            'Region' => '<string>',
            'ResourceType' => '<string>',
            'StartTime' => <DateTime>,
            'State' => 'CREATED|RUNNING|ABORTING|ABORTED|COMPLETING|COMPLETED|FAILING|FAILED|PARTIAL|AGGREGATE_ALL|ANY',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AggregationPeriod

Type: string

This is the period that sets the boundaries for returned results.

ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.

CopyJobSummaries

Type: Array of CopyJobSummary structures

This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

NextToken

Type: string

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListCopyJobs

$result = $client->listCopyJobs([/* ... */]);
$promise = $client->listCopyJobsAsync([/* ... */]);

Returns metadata about your copy jobs.

Parameter Syntax

$result = $client->listCopyJobs([
    'ByAccountId' => '<string>',
    'ByCompleteAfter' => <integer || string || DateTime>,
    'ByCompleteBefore' => <integer || string || DateTime>,
    'ByCreatedAfter' => <integer || string || DateTime>,
    'ByCreatedBefore' => <integer || string || DateTime>,
    'ByDestinationVaultArn' => '<string>',
    'ByMessageCategory' => '<string>',
    'ByParentJobId' => '<string>',
    'ByResourceArn' => '<string>',
    'ByResourceType' => '<string>',
    'ByState' => 'CREATED|RUNNING|COMPLETED|FAILED|PARTIAL',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ByAccountId

Type: string

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

ByCompleteAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

ByCompleteBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

ByCreatedAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only copy jobs that were created after the specified date.

ByCreatedBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only copy jobs that were created before the specified date.

ByDestinationVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

ByMessageCategory

Type: string

This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS.

View Monitoring for a list of accepted strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

ByParentJobId

Type: string

This is a filter to list child (nested) jobs based on parent job ID.

ByResourceArn

Type: string

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

ByResourceType

Type: string

Returns only backup jobs for the specified resources:

Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines

ByState

Type: string

Returns only copy jobs that are in the specified state.

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: 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 next token.

Result Syntax

[
    'CopyJobs' => [
        [
            'AccountId' => '<string>',
            'BackupSizeInBytes' => <integer>,
            'ChildJobsInState' => [<integer>, ...],
            'CompletionDate' => <DateTime>,
            'CompositeMemberIdentifier' => '<string>',
            'CopyJobId' => '<string>',
            'CreatedBy' => [
                'BackupPlanArn' => '<string>',
                'BackupPlanId' => '<string>',
                'BackupPlanVersion' => '<string>',
                'BackupRuleId' => '<string>',
            ],
            'CreationDate' => <DateTime>,
            'DestinationBackupVaultArn' => '<string>',
            'DestinationRecoveryPointArn' => '<string>',
            'IamRoleArn' => '<string>',
            'IsParent' => true || false,
            'MessageCategory' => '<string>',
            'NumberOfChildJobs' => <integer>,
            'ParentJobId' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceName' => '<string>',
            'ResourceType' => '<string>',
            'SourceBackupVaultArn' => '<string>',
            'SourceRecoveryPointArn' => '<string>',
            'State' => 'CREATED|RUNNING|COMPLETED|FAILED|PARTIAL',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

CopyJobs

Type: Array of CopyJob structures

An array of structures containing metadata about your copy jobs returned in JSON format.

NextToken

Type: string

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListFrameworks

$result = $client->listFrameworks([/* ... */]);
$promise = $client->listFrameworksAsync([/* ... */]);

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

Parameter Syntax

$result = $client->listFrameworks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

NextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Result Syntax

[
    'Frameworks' => [
        [
            'CreationTime' => <DateTime>,
            'DeploymentStatus' => '<string>',
            'FrameworkArn' => '<string>',
            'FrameworkDescription' => '<string>',
            'FrameworkName' => '<string>',
            'NumberOfControls' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Frameworks

Type: Array of Framework structures

A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.

NextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListLegalHolds

$result = $client->listLegalHolds([/* ... */]);
$promise = $client->listLegalHoldsAsync([/* ... */]);

This action returns metadata about active and previous legal holds.

Parameter Syntax

$result = $client->listLegalHolds([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of resource list items to be returned.

NextToken

Type: string

Result Syntax

[
    'LegalHolds' => [
        [
            'CancellationDate' => <DateTime>,
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
            'LegalHoldArn' => '<string>',
            'LegalHoldId' => '<string>',
            'Status' => 'CREATING|ACTIVE|CANCELING|CANCELED',
            'Title' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

LegalHolds

Type: Array of LegalHold structures

This is an array of returned legal holds, both active and previous.

NextToken

Type: string

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListProtectedResources

$result = $client->listProtectedResources([/* ... */]);
$promise = $client->listProtectedResourcesAsync([/* ... */]);

Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

Parameter Syntax

$result = $client->listProtectedResources([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Results' => [
        [
            'LastBackupTime' => <DateTime>,
            'LastBackupVaultArn' => '<string>',
            'LastRecoveryPointArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceName' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Results

Type: Array of ProtectedResource structures

An array of resources successfully backed up by Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListProtectedResourcesByBackupVault

$result = $client->listProtectedResourcesByBackupVault([/* ... */]);
$promise = $client->listProtectedResourcesByBackupVaultAsync([/* ... */]);

This request lists the protected resources corresponding to each backup vault.

Parameter Syntax

$result = $client->listProtectedResourcesByBackupVault([
    'BackupVaultAccountId' => '<string>',
    'BackupVaultName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

BackupVaultAccountId

Type: string

This is the list of protected resources by backup vault within the vault(s) you specify by account ID.

BackupVaultName

Required: Yes
Type: string

This is the list of protected resources by backup vault within the vault(s) you specify by name.

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Results' => [
        [
            'LastBackupTime' => <DateTime>,
            'LastBackupVaultArn' => '<string>',
            'LastRecoveryPointArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceName' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Results

Type: Array of ProtectedResource structures

These are the results returned for the request ListProtectedResourcesByBackupVault.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListRecoveryPointsByBackupVault

$result = $client->listRecoveryPointsByBackupVault([/* ... */]);
$promise = $client->listRecoveryPointsByBackupVaultAsync([/* ... */]);

Returns detailed information about the recovery points stored in a backup vault.

Parameter Syntax

$result = $client->listRecoveryPointsByBackupVault([
    'BackupVaultAccountId' => '<string>',
    'BackupVaultName' => '<string>', // REQUIRED
    'ByBackupPlanId' => '<string>',
    'ByCreatedAfter' => <integer || string || DateTime>,
    'ByCreatedBefore' => <integer || string || DateTime>,
    'ByParentRecoveryPointArn' => '<string>',
    'ByResourceArn' => '<string>',
    'ByResourceType' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

BackupVaultAccountId

Type: string

This parameter will sort the list of recovery points by account ID.

BackupVaultName

Required: Yes
Type: string

Backup vault name might not be available when a supported service creates the backup.

ByBackupPlanId

Type: string

Returns only recovery points that match the specified backup plan ID.

ByCreatedAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only recovery points that were created after the specified timestamp.

ByCreatedBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only recovery points that were created before the specified timestamp.

ByParentRecoveryPointArn

Type: string

This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

ByResourceArn

Type: string

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

ByResourceType

Type: string

Returns only recovery points that match the specified resource type(s):

Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'RecoveryPoints' => [
        [
            'BackupSizeInBytes' => <integer>,
            'BackupVaultArn' => '<string>',
            'BackupVaultName' => '<string>',
            'CalculatedLifecycle' => [
                'DeleteAt' => <DateTime>,
                'MoveToColdStorageAt' => <DateTime>,
            ],
            'CompletionDate' => <DateTime>,
            'CompositeMemberIdentifier' => '<string>',
            'CreatedBy' => [
                'BackupPlanArn' => '<string>',
                'BackupPlanId' => '<string>',
                'BackupPlanVersion' => '<string>',
                'BackupRuleId' => '<string>',
            ],
            'CreationDate' => <DateTime>,
            'EncryptionKeyArn' => '<string>',
            'IamRoleArn' => '<string>',
            'IsEncrypted' => true || false,
            'IsParent' => true || false,
            'LastRestoreTime' => <DateTime>,
            'Lifecycle' => [
                'DeleteAfterDays' => <integer>,
                'MoveToColdStorageAfterDays' => <integer>,
                'OptInToArchiveForSupportedResources' => true || false,
            ],
            'ParentRecoveryPointArn' => '<string>',
            'RecoveryPointArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceName' => '<string>',
            'ResourceType' => '<string>',
            'SourceBackupVaultArn' => '<string>',
            'Status' => 'COMPLETED|PARTIAL|DELETING|EXPIRED',
            'StatusMessage' => '<string>',
            'VaultType' => 'BACKUP_VAULT|LOGICALLY_AIR_GAPPED_BACKUP_VAULT',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

RecoveryPoints

Type: Array of RecoveryPointByBackupVault structures

An array of objects that contain detailed information about recovery points saved in a backup vault.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListRecoveryPointsByLegalHold

$result = $client->listRecoveryPointsByLegalHold([/* ... */]);
$promise = $client->listRecoveryPointsByLegalHoldAsync([/* ... */]);

This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

Parameter Syntax

$result = $client->listRecoveryPointsByLegalHold([
    'LegalHoldId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

LegalHoldId

Required: Yes
Type: string

This is the ID of the legal hold.

MaxResults

Type: int

This is the maximum number of resource list items to be returned.

NextToken

Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'RecoveryPoints' => [
        [
            'BackupVaultName' => '<string>',
            'RecoveryPointArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

This return is the next item following a partial list of returned resources.

RecoveryPoints

Type: Array of RecoveryPointMember structures

This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListRecoveryPointsByResource

$result = $client->listRecoveryPointsByResource([/* ... */]);
$promise = $client->listRecoveryPointsByResourceAsync([/* ... */]);

Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).

For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

Parameter Syntax

$result = $client->listRecoveryPointsByResource([
    'ManagedByAWSBackupOnly' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ManagedByAWSBackupOnly

Type: boolean

This attribute filters recovery points based on ownership.

If this is set to TRUE, the response will contain recovery points associated with the selected resources that are managed by Backup.

If this is set to FALSE, the response will contain all recovery points associated with the selected resource.

Type: Boolean

MaxResults

Type: int

The maximum number of items to be returned.

Amazon RDS requires a value of at least 20.

NextToken

Type: string

ResourceArn

Required: Yes
Type: string

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Result Syntax

[
    'NextToken' => '<string>',
    'RecoveryPoints' => [
        [
            'BackupSizeBytes' => <integer>,
            'BackupVaultName' => '<string>',
            'CreationDate' => <DateTime>,
            'EncryptionKeyArn' => '<string>',
            'IsParent' => true || false,
            'ParentRecoveryPointArn' => '<string>',
            'RecoveryPointArn' => '<string>',
            'ResourceName' => '<string>',
            'Status' => 'COMPLETED|PARTIAL|DELETING|EXPIRED',
            'StatusMessage' => '<string>',
            'VaultType' => 'BACKUP_VAULT|LOGICALLY_AIR_GAPPED_BACKUP_VAULT',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

RecoveryPoints

Type: Array of RecoveryPointByResource structures

An array of objects that contain detailed information about recovery points of the specified resource type.

Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListReportJobs

$result = $client->listReportJobs([/* ... */]);
$promise = $client->listReportJobsAsync([/* ... */]);

Returns details about your report jobs.

Parameter Syntax

$result = $client->listReportJobs([
    'ByCreationAfter' => <integer || string || DateTime>,
    'ByCreationBefore' => <integer || string || DateTime>,
    'ByReportPlanName' => '<string>',
    'ByStatus' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ByCreationAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

ByCreationBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

ByReportPlanName

Type: string

Returns only report jobs with the specified report plan name.

ByStatus

Type: string

Returns only report jobs that are in the specified status. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

MaxResults

Type: int

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

NextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Result Syntax

[
    'NextToken' => '<string>',
    'ReportJobs' => [
        [
            'CompletionTime' => <DateTime>,
            'CreationTime' => <DateTime>,
            'ReportDestination' => [
                'S3BucketName' => '<string>',
                'S3Keys' => ['<string>', ...],
            ],
            'ReportJobId' => '<string>',
            'ReportPlanArn' => '<string>',
            'ReportTemplate' => '<string>',
            'Status' => '<string>',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

ReportJobs

Type: Array of ReportJob structures

Details about your report jobs in JSON format.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

ListReportPlans

$result = $client->listReportPlans([/* ... */]);
$promise = $client->listReportPlansAsync([/* ... */]);

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Parameter Syntax

$result = $client->listReportPlans([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

NextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Result Syntax

[
    'NextToken' => '<string>',
    'ReportPlans' => [
        [
            'CreationTime' => <DateTime>,
            'DeploymentStatus' => '<string>',
            'LastAttemptedExecutionTime' => <DateTime>,
            'LastSuccessfulExecutionTime' => <DateTime>,
            'ReportDeliveryChannel' => [
                'Formats' => ['<string>', ...],
                'S3BucketName' => '<string>',
                'S3KeyPrefix' => '<string>',
            ],
            'ReportPlanArn' => '<string>',
            'ReportPlanDescription' => '<string>',
            'ReportPlanName' => '<string>',
            'ReportSetting' => [
                'Accounts' => ['<string>', ...],
                'FrameworkArns' => ['<string>', ...],
                'NumberOfFrameworks' => <integer>,
                'OrganizationUnits' => ['<string>', ...],
                'Regions' => ['<string>', ...],
                'ReportTemplate' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

ReportPlans

Type: Array of ReportPlan structures

A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListRestoreJobSummaries

$result = $client->listRestoreJobSummaries([/* ... */]);
$promise = $client->listRestoreJobSummariesAsync([/* ... */]);

This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Parameter Syntax

$result = $client->listRestoreJobSummaries([
    'AccountId' => '<string>',
    'AggregationPeriod' => 'ONE_DAY|SEVEN_DAYS|FOURTEEN_DAYS',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => '<string>',
    'State' => 'CREATED|PENDING|RUNNING|ABORTED|COMPLETED|FAILED|AGGREGATE_ALL|ANY',
]);

Parameter Details

Members

AccountId

Type: string

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

AggregationPeriod

Type: string

This is the period that sets the boundaries for returned results.

Acceptable values include

ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.

MaxResults

Type: int

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

NextToken

Type: string

ResourceType

Type: string

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

State

Type: string

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Result Syntax

[
    'AggregationPeriod' => '<string>',
    'NextToken' => '<string>',
    'RestoreJobSummaries' => [
        [
            'AccountId' => '<string>',
            'Count' => <integer>,
            'EndTime' => <DateTime>,
            'Region' => '<string>',
            'ResourceType' => '<string>',
            'StartTime' => <DateTime>,
            'State' => 'CREATED|PENDING|RUNNING|ABORTED|COMPLETED|FAILED|AGGREGATE_ALL|ANY',
        ],
        // ...
    ],
]

Result Details

Members

AggregationPeriod

Type: string

This is the period that sets the boundaries for returned results.

ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.

NextToken

Type: string

RestoreJobSummaries

Type: Array of RestoreJobSummary structures

This return contains a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListRestoreJobs

$result = $client->listRestoreJobs([/* ... */]);
$promise = $client->listRestoreJobsAsync([/* ... */]);

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

Parameter Syntax

$result = $client->listRestoreJobs([
    'ByAccountId' => '<string>',
    'ByCompleteAfter' => <integer || string || DateTime>,
    'ByCompleteBefore' => <integer || string || DateTime>,
    'ByCreatedAfter' => <integer || string || DateTime>,
    'ByCreatedBefore' => <integer || string || DateTime>,
    'ByResourceType' => '<string>',
    'ByRestoreTestingPlanArn' => '<string>',
    'ByStatus' => 'PENDING|RUNNING|COMPLETED|ABORTED|FAILED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ByAccountId

Type: string

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

ByCompleteAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

ByCompleteBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

ByCreatedAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only restore jobs that were created after the specified date.

ByCreatedBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only restore jobs that were created before the specified date.

ByResourceType

Type: string

Include this parameter to return only restore jobs for the specified resources:

Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines

ByRestoreTestingPlanArn

Type: string

This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).

ByStatus

Type: string

Returns only restore jobs associated with the specified job status.

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'RestoreJobs' => [
        [
            'AccountId' => '<string>',
            'BackupSizeInBytes' => <integer>,
            'CompletionDate' => <DateTime>,
            'CreatedBy' => [
                'RestoreTestingPlanArn' => '<string>',
            ],
            'CreatedResourceArn' => '<string>',
            'CreationDate' => <DateTime>,
            'DeletionStatus' => 'DELETING|FAILED|SUCCESSFUL',
            'DeletionStatusMessage' => '<string>',
            'ExpectedCompletionTimeMinutes' => <integer>,
            'IamRoleArn' => '<string>',
            'PercentDone' => '<string>',
            'RecoveryPointArn' => '<string>',
            'RecoveryPointCreationDate' => <DateTime>,
            'ResourceType' => '<string>',
            'RestoreJobId' => '<string>',
            'Status' => 'PENDING|RUNNING|COMPLETED|ABORTED|FAILED',
            'StatusMessage' => '<string>',
            'ValidationStatus' => 'FAILED|SUCCESSFUL|TIMED_OUT|VALIDATING',
            'ValidationStatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

RestoreJobs

Type: Array of RestoreJobsListMember structures

An array of objects that contain detailed information about jobs to restore saved resources.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListRestoreJobsByProtectedResource

$result = $client->listRestoreJobsByProtectedResource([/* ... */]);
$promise = $client->listRestoreJobsByProtectedResourceAsync([/* ... */]);

This returns restore jobs that contain the specified protected resource.

You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.

Parameter Syntax

$result = $client->listRestoreJobsByProtectedResource([
    'ByRecoveryPointCreationDateAfter' => <integer || string || DateTime>,
    'ByRecoveryPointCreationDateBefore' => <integer || string || DateTime>,
    'ByStatus' => 'PENDING|RUNNING|COMPLETED|ABORTED|FAILED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ByRecoveryPointCreationDateAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only restore jobs of recovery points that were created after the specified date.

ByRecoveryPointCreationDateBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns only restore jobs of recovery points that were created before the specified date.

ByStatus

Type: string

Returns only restore jobs associated with the specified job status.

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

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

ResourceArn

Required: Yes
Type: string

Returns only restore jobs that match the specified resource Amazon Resource Name (ARN).

Result Syntax

[
    'NextToken' => '<string>',
    'RestoreJobs' => [
        [
            'AccountId' => '<string>',
            'BackupSizeInBytes' => <integer>,
            'CompletionDate' => <DateTime>,
            'CreatedBy' => [
                'RestoreTestingPlanArn' => '<string>',
            ],
            'CreatedResourceArn' => '<string>',
            'CreationDate' => <DateTime>,
            'DeletionStatus' => 'DELETING|FAILED|SUCCESSFUL',
            'DeletionStatusMessage' => '<string>',
            'ExpectedCompletionTimeMinutes' => <integer>,
            'IamRoleArn' => '<string>',
            'PercentDone' => '<string>',
            'RecoveryPointArn' => '<string>',
            'RecoveryPointCreationDate' => <DateTime>,
            'ResourceType' => '<string>',
            'RestoreJobId' => '<string>',
            'Status' => 'PENDING|RUNNING|COMPLETED|ABORTED|FAILED',
            'StatusMessage' => '<string>',
            'ValidationStatus' => 'FAILED|SUCCESSFUL|TIMED_OUT|VALIDATING',
            'ValidationStatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: 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 youto return more items in your list starting at the location pointed to by the next token

RestoreJobs

Type: Array of RestoreJobsListMember structures

An array of objects that contain detailed information about jobs to restore saved resources.>

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListRestoreTestingPlans

$result = $client->listRestoreTestingPlans([/* ... */]);
$promise = $client->listRestoreTestingPlansAsync([/* ... */]);

Returns a list of restore testing plans.

Parameter Syntax

$result = $client->listRestoreTestingPlans([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'RestoreTestingPlans' => [
        [
            'CreationTime' => <DateTime>,
            'LastExecutionTime' => <DateTime>,
            'LastUpdateTime' => <DateTime>,
            'RestoreTestingPlanArn' => '<string>',
            'RestoreTestingPlanName' => '<string>',
            'ScheduleExpression' => '<string>',
            'ScheduleExpressionTimezone' => '<string>',
            'StartWindowHours' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

RestoreTestingPlans

Required: Yes
Type: Array of RestoreTestingPlanForList structures

This is a returned list of restore testing plans.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

ListRestoreTestingSelections

$result = $client->listRestoreTestingSelections([/* ... */]);
$promise = $client->listRestoreTestingSelectionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listRestoreTestingSelections([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RestoreTestingPlanName' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

RestoreTestingPlanName

Required: Yes
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'RestoreTestingSelections' => [
        [
            'CreationTime' => <DateTime>,
            'IamRoleArn' => '<string>',
            'ProtectedResourceType' => '<string>',
            'RestoreTestingPlanName' => '<string>',
            'RestoreTestingSelectionName' => '<string>',
            'ValidationWindowHours' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

RestoreTestingSelections

Required: Yes
Type: Array of RestoreTestingSelectionForList structures

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

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.

Parameter Syntax

$result = $client->listTags([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of items to be returned.

NextToken

Type: string

ResourceArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members

NextToken

Type: string

Tags

Type: Associative array of custom strings keys (TagKey) to strings

To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

PutBackupVaultAccessPolicy

$result = $client->putBackupVaultAccessPolicy([/* ... */]);
$promise = $client->putBackupVaultAccessPolicyAsync([/* ... */]);

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

Parameter Syntax

$result = $client->putBackupVaultAccessPolicy([
    'BackupVaultName' => '<string>', // REQUIRED
    'Policy' => '<string>',
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

Policy

Type: string

The backup vault access policy document in JSON format.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

PutBackupVaultLockConfiguration

$result = $client->putBackupVaultLockConfiguration([/* ... */]);
$promise = $client->putBackupVaultLockConfigurationAsync([/* ... */]);

Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.

Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.

Parameter Syntax

$result = $client->putBackupVaultLockConfiguration([
    'BackupVaultName' => '<string>', // REQUIRED
    'ChangeableForDays' => <integer>,
    'MaxRetentionDays' => <integer>,
    'MinRetentionDays' => <integer>,
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

The Backup Vault Lock configuration that specifies the name of the backup vault it protects.

ChangeableForDays

Type: long (int|float)

The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.

Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set ChangeableForDays to 3 or greater.

Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.

If this parameter is not specified, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration at any time.

MaxRetentionDays

Type: long (int|float)

The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).

If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.

If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.

MinRetentionDays

Type: long (int|float)

The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).

If this parameter is not specified, Vault Lock will not enforce a minimum retention period.

If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

PutBackupVaultNotifications

$result = $client->putBackupVaultNotifications([/* ... */]);
$promise = $client->putBackupVaultNotificationsAsync([/* ... */]);

Turns on notifications on a backup vault for the specified topic and events.

Parameter Syntax

$result = $client->putBackupVaultNotifications([
    'BackupVaultEvents' => ['<string>', ...], // REQUIRED
    'BackupVaultName' => '<string>', // REQUIRED
    'SNSTopicArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultEvents

Required: Yes
Type: Array of strings

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

The following events are supported:

BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

BackupVaultName

Required: Yes
Type: string

SNSTopicArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

PutRestoreValidationResult

$result = $client->putRestoreValidationResult([/* ... */]);
$promise = $client->putRestoreValidationResultAsync([/* ... */]);

This request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage.

Parameter Syntax

$result = $client->putRestoreValidationResult([
    'RestoreJobId' => '<string>', // REQUIRED
    'ValidationStatus' => 'FAILED|SUCCESSFUL|TIMED_OUT|VALIDATING', // REQUIRED
    'ValidationStatusMessage' => '<string>',
]);

Parameter Details

Members

RestoreJobId

Required: Yes
Type: string

This is a unique identifier of a restore job within Backup.

ValidationStatus

Required: Yes
Type: string

This is the status of your restore validation.

ValidationStatusMessage

Type: string

This is an optional message string you can input to describe the validation status for the restore test validation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
MissingParameterValueException:
Indicates that a required parameter is missing.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

StartBackupJob

$result = $client->startBackupJob([/* ... */]);
$promise = $client->startBackupJobAsync([/* ... */]);

Starts an on-demand backup job for the specified resource.

Parameter Syntax

$result = $client->startBackupJob([
    'BackupOptions' => ['<string>', ...],
    'BackupVaultName' => '<string>', // REQUIRED
    'CompleteWindowMinutes' => <integer>,
    'IamRoleArn' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>',
    'Lifecycle' => [
        'DeleteAfterDays' => <integer>,
        'MoveToColdStorageAfterDays' => <integer>,
        'OptInToArchiveForSupportedResources' => true || false,
    ],
    'RecoveryPointTags' => ['<string>', ...],
    'ResourceArn' => '<string>', // REQUIRED
    'StartWindowMinutes' => <integer>,
]);

Parameter Details

Members

BackupOptions

Type: Associative array of custom strings keys (BackupOptionKey) to strings

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

BackupVaultName

Required: Yes
Type: string

CompleteWindowMinutes

Type: long (int|float)

A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000 minutes).

IamRoleArn

Required: Yes
Type: string

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

IdempotencyToken

Type: string

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Lifecycle

Type: Lifecycle structure

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

This parameter has a maximum value of 100 years (36,500 days).

RecoveryPointTags

Type: Associative array of custom strings keys (TagKey) to strings

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

ResourceArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

StartWindowMinutes

Type: long (int|float)

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

This parameter has a maximum value of 100 years (52,560,000 minutes).

During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

Result Syntax

[
    'BackupJobId' => '<string>',
    'CreationDate' => <DateTime>,
    'IsParent' => true || false,
    'RecoveryPointArn' => '<string>',
]

Result Details

Members

BackupJobId

Type: string

Uniquely identifies a request to Backup to back up a resource.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

IsParent

Type: boolean

This is a returned boolean value indicating this is a parent (composite) backup job.

RecoveryPointArn

Type: string

Note: This field is only returned for Amazon EFS and Advanced DynamoDB resources.

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

StartCopyJob

$result = $client->startCopyJob([/* ... */]);
$promise = $client->startCopyJobAsync([/* ... */]);

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

Parameter Syntax

$result = $client->startCopyJob([
    'DestinationBackupVaultArn' => '<string>', // REQUIRED
    'IamRoleArn' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>',
    'Lifecycle' => [
        'DeleteAfterDays' => <integer>,
        'MoveToColdStorageAfterDays' => <integer>,
        'OptInToArchiveForSupportedResources' => true || false,
    ],
    'RecoveryPointArn' => '<string>', // REQUIRED
    'SourceBackupVaultName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DestinationBackupVaultArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

IamRoleArn

Required: Yes
Type: string

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

IdempotencyToken

Type: string

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Lifecycle

Type: Lifecycle structure

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

RecoveryPointArn

Required: Yes
Type: string

An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

SourceBackupVaultName

Required: Yes
Type: string

The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Result Syntax

[
    'CopyJobId' => '<string>',
    'CreationDate' => <DateTime>,
    'IsParent' => true || false,
]

Result Details

Members

CopyJobId

Type: string

Uniquely identifies a copy job.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

IsParent

Type: boolean

This is a returned boolean value indicating this is a parent (composite) copy job.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

StartReportJob

$result = $client->startReportJob([/* ... */]);
$promise = $client->startReportJobAsync([/* ... */]);

Starts an on-demand report job for the specified report plan.

Parameter Syntax

$result = $client->startReportJob([
    'IdempotencyToken' => '<string>',
    'ReportPlanName' => '<string>', // REQUIRED
]);

Parameter Details

Members

IdempotencyToken

Type: string

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

ReportPlanName

Required: Yes
Type: string

The unique name of a report plan.

Result Syntax

[
    'ReportJobId' => '<string>',
]

Result Details

Members

ReportJobId

Type: string

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

Errors

InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
MissingParameterValueException:
Indicates that a required parameter is missing.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.

StartRestoreJob

$result = $client->startRestoreJob([/* ... */]);
$promise = $client->startRestoreJobAsync([/* ... */]);

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->startRestoreJob([
    'CopySourceTagsToRestoredResource' => true || false,
    'IamRoleArn' => '<string>',
    'IdempotencyToken' => '<string>',
    'Metadata' => ['<string>', ...], // REQUIRED
    'RecoveryPointArn' => '<string>', // REQUIRED
    'ResourceType' => '<string>',
]);

Parameter Details

Members

CopySourceTagsToRestoredResource

Type: boolean

This is an optional parameter. If this equals True, tags included in the backup will be copied to the restored resource.

This can only be applied to backups created through Backup.

IamRoleArn

Type: 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.

IdempotencyToken

Type: string

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Metadata

Required: Yes
Type: Associative array of custom strings keys (MetadataKey) to strings

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
PerformanceMode: Specifies the throughput mode of the file system.
CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".

RecoveryPointArn

Required: Yes
Type: string

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceType

Type: string

Starts a job to restore a recovery point for one of the following resources:

Aurora for Amazon Aurora
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
CloudFormation for CloudFormation
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines

Result Syntax

[
    'RestoreJobId' => '<string>',
]

Result Details

Members

RestoreJobId

Type: string

Uniquely identifies the job that restores a recovery point.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

StopBackupJob

$result = $client->stopBackupJob([/* ... */]);
$promise = $client->stopBackupJobAsync([/* ... */]);

Attempts to cancel a job to create a one-time backup of a resource.

This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.

Parameter Syntax

$result = $client->stopBackupJob([
    'BackupJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupJobId

Required: Yes
Type: string

Uniquely identifies a request to Backup to back up a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

MissingParameterValueException:
Indicates that a required parameter is missing.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: [{"Key":"string","Value":"string"}].

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeyList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

TagKeyList

Required: Yes
Type: Array of strings

A list of keys to identify which key-value tags to remove from a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

UpdateBackupPlan

$result = $client->updateBackupPlan([/* ... */]);
$promise = $client->updateBackupPlanAsync([/* ... */]);

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

Parameter Syntax

$result = $client->updateBackupPlan([
    'BackupPlan' => [ // REQUIRED
        'AdvancedBackupSettings' => [
            [
                'BackupOptions' => ['<string>', ...],
                'ResourceType' => '<string>',
            ],
            // ...
        ],
        'BackupPlanName' => '<string>', // REQUIRED
        'Rules' => [ // REQUIRED
            [
                'CompletionWindowMinutes' => <integer>,
                'CopyActions' => [
                    [
                        'DestinationBackupVaultArn' => '<string>', // REQUIRED
                        'Lifecycle' => [
                            'DeleteAfterDays' => <integer>,
                            'MoveToColdStorageAfterDays' => <integer>,
                            'OptInToArchiveForSupportedResources' => true || false,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                    'OptInToArchiveForSupportedResources' => true || false,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleName' => '<string>', // REQUIRED
                'ScheduleExpression' => '<string>',
                'ScheduleExpressionTimezone' => '<string>',
                'StartWindowMinutes' => <integer>,
                'TargetBackupVaultName' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'BackupPlanId' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupPlan

Required: Yes
Type: BackupPlanInput structure

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

BackupPlanId

Required: Yes
Type: string

Uniquely identifies a backup plan.

Result Syntax

[
    'AdvancedBackupSettings' => [
        [
            'BackupOptions' => ['<string>', ...],
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'BackupPlanArn' => '<string>',
    'BackupPlanId' => '<string>',
    'CreationDate' => <DateTime>,
    'VersionId' => '<string>',
]

Result Details

Members

AdvancedBackupSettings

Type: Array of AdvancedBackupSetting structures

Contains a list of BackupOptions for each resource type.

BackupPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanId

Type: string

Uniquely identifies a backup plan.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

VersionId

Type: string

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

UpdateFramework

$result = $client->updateFramework([/* ... */]);
$promise = $client->updateFrameworkAsync([/* ... */]);

Updates an existing framework identified by its FrameworkName with the input document in JSON format.

Parameter Syntax

$result = $client->updateFramework([
    'FrameworkControls' => [
        [
            'ControlInputParameters' => [
                [
                    'ParameterName' => '<string>',
                    'ParameterValue' => '<string>',
                ],
                // ...
            ],
            'ControlName' => '<string>', // REQUIRED
            'ControlScope' => [
                'ComplianceResourceIds' => ['<string>', ...],
                'ComplianceResourceTypes' => ['<string>', ...],
                'Tags' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'FrameworkDescription' => '<string>',
    'FrameworkName' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>',
]);

Parameter Details

Members

FrameworkControls

Type: Array of FrameworkControl structures

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

FrameworkDescription

Type: string

An optional description of the framework with a maximum 1,024 characters.

FrameworkName

Required: Yes
Type: string

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

IdempotencyToken

Type: string

A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'FrameworkArn' => '<string>',
    'FrameworkName' => '<string>',
]

Result Details

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

FrameworkArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

FrameworkName

Type: string

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Errors

AlreadyExistsException:
The required resource already exists.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
LimitExceededException:
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ConflictException:
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

UpdateGlobalSettings

$result = $client->updateGlobalSettings([/* ... */]);
$promise = $client->updateGlobalSettingsAsync([/* ... */]);

Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.

Parameter Syntax

$result = $client->updateGlobalSettings([
    'GlobalSettings' => ['<string>', ...],
]);

Parameter Details

Members

GlobalSettings

Type: Associative array of custom strings keys (GlobalSettingsName) to strings

A value for isCrossAccountBackupEnabled and a Region. Example: update-global-settings --global-settings isCrossAccountBackupEnabled=false --region us-west-2.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request failed due to a temporary failure of the server.
MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

UpdateRecoveryPointLifecycle

$result = $client->updateRecoveryPointLifecycle([/* ... */]);
$promise = $client->updateRecoveryPointLifecycleAsync([/* ... */]);

Sets the transition lifecycle of a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

This operation does not support continuous backups.

Parameter Syntax

$result = $client->updateRecoveryPointLifecycle([
    'BackupVaultName' => '<string>', // REQUIRED
    'Lifecycle' => [
        'DeleteAfterDays' => <integer>,
        'MoveToColdStorageAfterDays' => <integer>,
        'OptInToArchiveForSupportedResources' => true || false,
    ],
    'RecoveryPointArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

Lifecycle

Type: Lifecycle structure

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

RecoveryPointArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Result Syntax

[
    'BackupVaultArn' => '<string>',
    'CalculatedLifecycle' => [
        'DeleteAt' => <DateTime>,
        'MoveToColdStorageAt' => <DateTime>,
    ],
    'Lifecycle' => [
        'DeleteAfterDays' => <integer>,
        'MoveToColdStorageAfterDays' => <integer>,
        'OptInToArchiveForSupportedResources' => true || false,
    ],
    'RecoveryPointArn' => '<string>',
]

Result Details

Members

BackupVaultArn

Type: string

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

CalculatedLifecycle

Type: CalculatedLifecycle structure

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

Lifecycle

Type: Lifecycle structure

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

RecoveryPointArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
InvalidRequestException:
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
MissingParameterValueException:
Indicates that a required parameter is missing.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

UpdateRegionSettings

$result = $client->updateRegionSettings([/* ... */]);
$promise = $client->updateRegionSettingsAsync([/* ... */]);

Updates the current service opt-in settings for the Region.

Use the DescribeRegionSettings API to determine the resource types that are supported.

Parameter Syntax

$result = $client->updateRegionSettings([
    'ResourceTypeManagementPreference' => [true || false, ...],
    'ResourceTypeOptInPreference' => [true || false, ...],
]);

Parameter Details

Members

ResourceTypeManagementPreference

Type: Associative array of custom strings keys (ResourceType) to booleans

Enables or disables full Backup management of backups for a resource type. To enable full Backup management for DynamoDB along with Backup's advanced DynamoDB backup features, follow the procedure to enable advanced DynamoDB backup programmatically.

ResourceTypeOptInPreference

Type: Associative array of custom strings keys (ResourceType) to booleans

Updates the list of services along with the opt-in preferences for the Region.

If resource assignments are only based on tags, then service opt-in settings are applied. If a resource type is explicitly assigned to a backup plan, such as Amazon S3, Amazon EC2, or Amazon RDS, it will be included in the backup even if the opt-in is not enabled for that particular service. If both a resource type and tags are specified in a resource assignment, the resource type specified in the backup plan takes priority over the tag condition. Service opt-in settings are disregarded in this situation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request failed due to a temporary failure of the server.
MissingParameterValueException:
Indicates that a required parameter is missing.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.

UpdateReportPlan

$result = $client->updateReportPlan([/* ... */]);
$promise = $client->updateReportPlanAsync([/* ... */]);

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

Parameter Syntax

$result = $client->updateReportPlan([
    'IdempotencyToken' => '<string>',
    'ReportDeliveryChannel' => [
        'Formats' => ['<string>', ...],
        'S3BucketName' => '<string>', // REQUIRED
        'S3KeyPrefix' => '<string>',
    ],
    'ReportPlanDescription' => '<string>',
    'ReportPlanName' => '<string>', // REQUIRED
    'ReportSetting' => [
        'Accounts' => ['<string>', ...],
        'FrameworkArns' => ['<string>', ...],
        'NumberOfFrameworks' => <integer>,
        'OrganizationUnits' => ['<string>', ...],
        'Regions' => ['<string>', ...],
        'ReportTemplate' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

IdempotencyToken

Type: string

A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

ReportDeliveryChannel

Type: ReportDeliveryChannel structure

A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

ReportPlanDescription

Type: string

An optional description of the report plan with a maximum 1,024 characters.

ReportPlanName

Required: Yes
Type: string

The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

ReportSetting

Type: ReportSetting structure

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'ReportPlanArn' => '<string>',
    'ReportPlanName' => '<string>',
]

Result Details

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a report plan is 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.

ReportPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

ReportPlanName

Type: string

The unique name of the report plan.

Errors

ResourceNotFoundException:
A resource that is required for the action doesn't exist.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.
MissingParameterValueException:
Indicates that a required parameter is missing.
ConflictException:
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

UpdateRestoreTestingPlan

$result = $client->updateRestoreTestingPlan([/* ... */]);
$promise = $client->updateRestoreTestingPlanAsync([/* ... */]);

This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created.

RecoveryPointSelection can contain:

Algorithm
ExcludeVaults
IncludeVaults
RecoveryPointTypes
SelectionWindowDays

Parameter Syntax

$result = $client->updateRestoreTestingPlan([
    'RestoreTestingPlan' => [ // REQUIRED
        'RecoveryPointSelection' => [
            'Algorithm' => 'LATEST_WITHIN_WINDOW|RANDOM_WITHIN_WINDOW',
            'ExcludeVaults' => ['<string>', ...],
            'IncludeVaults' => ['<string>', ...],
            'RecoveryPointTypes' => ['<string>', ...],
            'SelectionWindowDays' => <integer>,
        ],
        'ScheduleExpression' => '<string>',
        'ScheduleExpressionTimezone' => '<string>',
        'StartWindowHours' => <integer>,
    ],
    'RestoreTestingPlanName' => '<string>', // REQUIRED
]);

Parameter Details

Members

RestoreTestingPlan

Required: Yes
Type: RestoreTestingPlanForUpdate structure

Specifies the body of a restore testing plan.

RestoreTestingPlanName

Required: Yes
Type: string

This is the restore testing plan name you wish to update.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'RestoreTestingPlanArn' => '<string>',
    'RestoreTestingPlanName' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

This is the time the resource testing plan was created.

RestoreTestingPlanArn

Required: Yes
Type: string

Unique ARN (Amazon Resource Name) of the restore testing plan.

RestoreTestingPlanName

Required: Yes
Type: string

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

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

ConflictException:
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

UpdateRestoreTestingSelection

$result = $client->updateRestoreTestingSelection([/* ... */]);
$promise = $client->updateRestoreTestingSelectionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateRestoreTestingSelection([
    'RestoreTestingPlanName' => '<string>', // REQUIRED
    'RestoreTestingSelection' => [ // REQUIRED
        'IamRoleArn' => '<string>',
        'ProtectedResourceArns' => ['<string>', ...],
        'ProtectedResourceConditions' => [
            'StringEquals' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'StringNotEquals' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'RestoreMetadataOverrides' => ['<string>', ...],
        'ValidationWindowHours' => <integer>,
    ],
    'RestoreTestingSelectionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

RestoreTestingPlanName

Required: Yes
Type: string

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

RestoreTestingSelection

Required: Yes
Type: RestoreTestingSelectionForUpdate structure

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.

RestoreTestingSelectionName

Required: Yes
Type: string

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

Result Syntax

[
    'CreationTime' => <DateTime>,
    'RestoreTestingPlanArn' => '<string>',
    'RestoreTestingPlanName' => '<string>',
    'RestoreTestingSelectionName' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

RestoreTestingPlanArn

Required: Yes
Type: string

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

RestoreTestingPlanName

Required: Yes
Type: string

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

RestoreTestingSelectionName

Required: Yes
Type: string

This is the returned restore testing selection name.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

ConflictException:
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
InvalidParameterValueException:
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException:
Indicates that a required parameter is missing.
ResourceNotFoundException:
A resource that is required for the action doesn't exist.
ServiceUnavailableException:
The request failed due to a temporary failure of the server.

Shapes

AdvancedBackupSetting

Description

A list of backup options for each resource type.

Members

BackupOptions

Type: Associative array of custom strings keys (BackupOptionKey) to strings

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values:

Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

If you specify an invalid option, you get an InvalidParameterValueException exception.

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

ResourceType

Type: string

Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

Valid values: EC2.

AlreadyExistsException

Description

The required resource already exists.

Members

Arn

Type: string

Code

Type: string

Context

Type: string

CreatorRequestId

Type: string

Message

Type: string

Type

Type: string

BackupJob

Description

Contains detailed information about a backup job.

Members

AccountId

Type: string

The account ID that owns the backup job.

BackupJobId

Type: string

Uniquely identifies a request to Backup to back up a resource.

BackupOptions

Type: Associative array of custom strings keys (BackupOptionKey) to strings

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

BackupSizeInBytes

Type: long (int|float)

The size, in bytes, of a backup.

BackupType

Type: string

Represents the type of backup for a backup job.

BackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultName

Type: string

BytesTransferred

Type: long (int|float)

The size in bytes transferred to a backup vault at the time that the job status was queried.

CompletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreatedBy

Type: RecoveryPointCreator structure

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

ExpectedCompletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

IamRoleArn

Type: string

Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

InitiationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

This is the date on which the backup job was initiated.

IsParent

Type: boolean

This is a boolean value indicating this is a parent (composite) backup job.

MessageCategory

Type: string

This parameter is the job count for the specified message category.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

ParentJobId

Type: string

This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.

PercentDone

Type: string

Contains an estimated percentage complete of a job at the time the job status was queried.

RecoveryPointArn

Type: string

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceArn

Type: string

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

ResourceName

Type: string

This is the non-unique name of the resource that belongs to the specified backup.

ResourceType

Type: string

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

StartBy

Type: timestamp (string|DateTime or anything parsable by strtotime)

State

Type: string

The current state of a backup job.

StatusMessage

Type: string

A detailed message explaining the status of the job to back up a resource.

BackupJobSummary

Description

This is a summary of jobs created or running within the most recent 30 days.

The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Members

AccountId

Type: string

The account ID that owns the jobs within the summary.

Count

Type: int

The value as a number of jobs in a job summary.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The value of time in number format of a job end time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

MessageCategory

Type: string

This parameter is the job count for the specified message category.

Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

Region

Type: string

The Amazon Web Services Regions within the job summary.

ResourceType

Type: string

This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The value of time in number format of a job start time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

State

Type: string

This value is job count for jobs with the specified state.

BackupPlan

Description

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of Amazon Web Services resources.

Members

AdvancedBackupSettings

Type: Array of AdvancedBackupSetting structures

Contains a list of BackupOptions for each resource type.

BackupPlanName

Required: Yes
Type: string

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

Rules

Required: Yes
Type: Array of BackupRule structures

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

BackupPlanInput

Description

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task.

Members

AdvancedBackupSettings

Type: Array of AdvancedBackupSetting structures

Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

BackupPlanName

Required: Yes
Type: string

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

Rules

Required: Yes
Type: Array of BackupRuleInput structures

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

BackupPlanTemplatesListMember

Description

An object specifying metadata associated with a backup plan template.

Members

BackupPlanTemplateId

Type: string

Uniquely identifies a stored backup plan template.

BackupPlanTemplateName

Type: string

The optional display name of a backup plan template.

BackupPlansListMember

Description

Contains metadata about a backup plan.

Members

AdvancedBackupSettings

Type: Array of AdvancedBackupSetting structures

Contains a list of BackupOptions for a resource type.

BackupPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanId

Type: string

Uniquely identifies a backup plan.

BackupPlanName

Type: string

The display name of a saved backup plan.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreatorRequestId

Type: string

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

DeletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

LastExecutionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time a job to back up resources was run with this rule. 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.

VersionId

Type: string

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

BackupRule

Description

Specifies a scheduled task used to back up a selection of resources.

Members

CompletionWindowMinutes

Type: long (int|float)

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

CopyActions

Type: Array of CopyAction structures

An array of CopyAction objects, which contains the details of the copy operation.

EnableContinuousBackup

Type: boolean

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

Lifecycle

Type: Lifecycle structure

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

RecoveryPointTags

Type: Associative array of custom strings keys (TagKey) to strings

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

RuleId

Type: string

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

RuleName

Required: Yes
Type: string

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

ScheduleExpression

Type: string

A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

ScheduleExpressionTimezone

Type: string

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.

StartWindowMinutes

Type: long (int|float)

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.

TargetBackupVaultName

Required: Yes
Type: string

BackupRuleInput

Description

Specifies a scheduled task used to back up a selection of resources.

Members

CompletionWindowMinutes

Type: long (int|float)

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

CopyActions

Type: Array of CopyAction structures

An array of CopyAction objects, which contains the details of the copy operation.

EnableContinuousBackup

Type: boolean

Lifecycle

Type: Lifecycle structure

This parameter has a maximum value of 100 years (36,500 days).

RecoveryPointTags

Type: Associative array of custom strings keys (TagKey) to strings

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

RuleName

Required: Yes
Type: string

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

ScheduleExpression

Type: string

A CRON expression in UTC specifying when Backup initiates a backup job.

ScheduleExpressionTimezone

Type: string

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.

StartWindowMinutes

Type: long (int|float)

This parameter has a maximum value of 100 years (52,560,000 minutes).

TargetBackupVaultName

Required: Yes
Type: string

BackupSelection

Description

Used to specify a set of resources to a backup plan.

Specifying your desired Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.

Members

Conditions

Type: Conditions structure

A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "true" },. Condition operators are case sensitive.

Conditions differs from ListOfTags as follows:

When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. ListOfTags only supports StringEquals.

IamRoleArn

Required: Yes
Type: string

The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

ListOfTags

Type: Array of Condition structures

ListOfTags differs from Conditions as follows:

When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
ListOfTags only supports StringEquals. Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.

NotResources

Type: Array of strings

A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.

Resources

Type: Array of strings

A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.

SelectionName

Required: Yes
Type: string

The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.

BackupSelectionsListMember

Description

Contains metadata about a BackupSelection object.

Members

BackupPlanId

Type: string

Uniquely identifies a backup plan.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

CreatorRequestId

Type: string

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

IamRoleArn

Type: string

Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

SelectionId

Type: string

Uniquely identifies a request to assign a set of resources to a backup plan.

SelectionName

Type: string

The display name of a resource selection document.

BackupVaultListMember

Description

Contains metadata about a backup vault.

Members

BackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultName

Type: string

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreatorRequestId

Type: string

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

EncryptionKeyArn

Type: string

A server-side encryption key you can specify to encrypt your backups from services that support full Backup management; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, Backup creates a KMS key for you by default.

To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup

LockDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Locked

Type: boolean

A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. If true, Vault Lock prevents delete and update operations on the recovery points in the selected vault.

MaxRetentionDays

Type: long (int|float)

MinRetentionDays

Type: long (int|float)

NumberOfRecoveryPoints

Type: long (int|float)

The number of recovery points that are stored in a backup vault.

CalculatedLifecycle

Description

Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

Members

DeleteAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that specifies when to delete a recovery point.

MoveToColdStorageAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that specifies when to transition a recovery point to cold storage.

Condition

Description

Contains an array of triplets made up of a condition type (such as StringEquals), a key, and a value. Used to filter resources using their tags and assign them to a backup plan. Case sensitive.

Members

ConditionKey

Required: Yes
Type: string

The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

ConditionType

Required: Yes
Type: string

An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports StringEquals. For more flexible assignment options, including StringLike and the ability to exclude resources from your backup plan, use Conditions (with an "s" on the end) for your BackupSelection .

ConditionValue

Required: Yes
Type: string

The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

ConditionParameter

Description

Includes information about tags you define to assign tagged resources to a backup plan.

Members

ConditionKey

Type: string

The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

ConditionValue

Type: string

The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

Conditions

Description

Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.

Members

StringEquals

Type: Array of ConditionParameter structures

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

StringLike

Type: Array of ConditionParameter structures

Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, "prod*" or "*rod*" matches the tag value "production".

StringNotEquals

Type: Array of ConditionParameter structures

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

StringNotLike

Type: Array of ConditionParameter structures

Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.

ConflictException

Description

Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

ControlInputParameter

Description

A list of parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least daily and the retention period is at least 1 year". The first parameter is daily. The second parameter is 1 year.

Members

ParameterName

Type: string

The name of a parameter, for example, BackupPlanFrequency.

ParameterValue

Type: string

The value of parameter, for example, hourly.

ControlScope

Description

A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

To set a control scope that includes all of a particular resource, leave the ControlScope empty or do not pass it when calling CreateFramework.

Members

ComplianceResourceIds

Type: Array of strings

The ID of the only Amazon Web Services resource that you want your control scope to contain.

ComplianceResourceTypes

Type: Array of strings

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

Tags

Type: Associative array of custom strings keys (string) to strings

The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].

CopyAction

Description

The details of the copy operation.

Members

DestinationBackupVaultArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Lifecycle

Type: Lifecycle structure

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

CopyJob

Description

Contains detailed information about a copy job.

Members

AccountId

Type: string

The account ID that owns the copy job.

BackupSizeInBytes

Type: long (int|float)

The size, in bytes, of a copy job.

ChildJobsInState

Type: Associative array of custom strings keys (CopyJobState) to long (int|float)s

This returns the statistics of the included child (nested) copy jobs.

CompletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CompositeMemberIdentifier

Type: string

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

CopyJobId

Type: string

Uniquely identifies a copy job.

CreatedBy

Type: RecoveryPointCreator structure

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

DestinationBackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

DestinationRecoveryPointArn

Type: string

An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

IamRoleArn

Type: string

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

IsParent

Type: boolean

This is a boolean value indicating this is a parent (composite) copy job.

MessageCategory

Type: string

This parameter is the job count for the specified message category.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum

NumberOfChildJobs

Type: long (int|float)

This is the number of child (nested) copy jobs.

ParentJobId

Type: string

This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.

ResourceArn

Type: string

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

ResourceName

Type: string

This is the non-unique name of the resource that belongs to the specified backup.

ResourceType

Type: string

The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

SourceBackupVaultArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

SourceRecoveryPointArn

Type: string

An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

State

Type: string

The current state of a copy job.

StatusMessage

Type: string

A detailed message explaining the status of the job to copy a resource.

CopyJobSummary

Description

This is a summary of copy jobs created or running within the most recent 30 days.

The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Members

AccountId

Type: string

The account ID that owns the jobs within the summary.

Count

Type: int

The value as a number of jobs in a job summary.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The value of time in number format of a job end time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

MessageCategory

Type: string

This parameter is the job count for the specified message category.

Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

Region

Type: string

This is the Amazon Web Services Regions within the job summary.

ResourceType

Type: string

This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The value of time in number format of a job start time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

State

Type: string

This value is job count for jobs with the specified state.

DateRange

Description

This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Members

FromDate

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

This value is the beginning date, inclusive.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

ToDate

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

This value is the end date, inclusive.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

DependencyFailureException

Description

A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

Framework

Description

Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

DeploymentStatus

Type: string

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

FrameworkArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

FrameworkDescription

Type: string

An optional description of the framework with a maximum 1,024 characters.

FrameworkName

Type: string

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

NumberOfControls

Type: int

The number of controls contained by the framework.

FrameworkControl

Description

Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

Members

ControlInputParameters

Type: Array of ControlInputParameter structures

A list of ParameterName and ParameterValue pairs.

ControlName

Required: Yes
Type: string

The name of a control. This name is between 1 and 256 characters.

ControlScope

Type: ControlScope structure

The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.

For more information, see ControlScope.

InvalidParameterValueException

Description

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

InvalidRequestException

Description

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

InvalidResourceStateException

Description

Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

KeyValue

Description

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

Members

Key

Required: Yes
Type: 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

Required: Yes
Type: string

The value of the key.

Length Constraints: Maximum length of 256.

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

LegalHold

Description

A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

Members

CancellationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

This is the time in number format when legal hold was cancelled.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

This is the time in number format when legal hold was created.

Description

Type: string

This is the description of a legal hold.

LegalHoldArn

Type: string

This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

LegalHoldId

Type: string

ID of specific legal hold on one or more recovery points.

Status

Type: string

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

Title

Type: string

This is the title of a legal hold.

Lifecycle

Description

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Members

DeleteAfterDays

Type: long (int|float)

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

MoveToColdStorageAfterDays

Type: long (int|float)

Specifies the number of days after creation that a recovery point is moved to cold storage.

OptInToArchiveForSupportedResources

Type: boolean

Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

LimitExceededException

Description

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

MissingParameterValueException

Description

Indicates that a required parameter is missing.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

ProtectedResource

Description

A structure that contains information about a backed-up resource.

Members

LastBackupTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

LastBackupVaultArn

Type: string

This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.

LastRecoveryPointArn

Type: string

This is the ARN (Amazon Resource Name) of the most recent recovery point.

ResourceArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

ResourceName

Type: string

This is the non-unique name of the resource that belongs to the specified backup.

ResourceType

Type: string

The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

ProtectedResourceConditions

Description

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.

Members

StringEquals

Type: Array of KeyValue structures

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

StringNotEquals

Type: Array of KeyValue structures

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

RecoveryPointByBackupVault

Description

Contains detailed information about the recovery points stored in a backup vault.

Members

BackupSizeInBytes

Type: long (int|float)

The size, in bytes, of a backup.

BackupVaultArn

Type: string

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

BackupVaultName

Type: string

CalculatedLifecycle

Type: CalculatedLifecycle structure

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

CompletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CompositeMemberIdentifier

Type: string

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

CreatedBy

Type: RecoveryPointCreator structure

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

EncryptionKeyArn

Type: string

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

IamRoleArn

Type: string

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

IsEncrypted

Type: boolean

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

IsParent

Type: boolean

This is a boolean value indicating this is a parent (composite) recovery point.

LastRestoreTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Lifecycle

Type: Lifecycle structure

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

ParentRecoveryPointArn

Type: string

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

RecoveryPointArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceArn

Type: string

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

ResourceName

Type: string

This is the non-unique name of the resource that belongs to the specified backup.

ResourceType

Type: string

The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

SourceBackupVaultArn

Type: string

The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

Status

Type: string

A status code specifying the state of the recovery point.

StatusMessage

Type: string

A message explaining the reason of the recovery point deletion failure.

VaultType

Type: string

This is the type of vault in which the described recovery point is stored.

RecoveryPointByResource

Description

Contains detailed information about a saved recovery point.

Members

BackupSizeBytes

Type: long (int|float)

The size, in bytes, of a backup.

BackupVaultName

Type: string

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

EncryptionKeyArn

Type: string

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

IsParent

Type: boolean

This is a boolean value indicating this is a parent (composite) recovery point.

ParentRecoveryPointArn

Type: string

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

RecoveryPointArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceName

Type: string

This is the non-unique name of the resource that belongs to the specified backup.

Status

Type: string

A status code specifying the state of the recovery point.

StatusMessage

Type: string

A message explaining the reason of the recovery point deletion failure.

VaultType

Type: string

This is the type of vault in which the described recovery point is stored.

RecoveryPointCreator

Description

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

Members

BackupPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanId

Type: string

Uniquely identifies a backup plan.

BackupPlanVersion

Type: string

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

BackupRuleId

Type: string

Uniquely identifies a rule used to schedule the backup of a selection of resources.

RecoveryPointMember

Description

This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.

Members

BackupVaultName

Type: string

This is the name of the backup vault (the logical container in which backups are stored).

RecoveryPointArn

Type: string

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

ResourceArn

Type: string

This is the Amazon Resource Name (ARN) that uniquely identifies a saved resource.

ResourceType

Type: string

This is the Amazon Web Services resource type that is saved as a recovery point.

RecoveryPointSelection

Description

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

Members

DateRange

Type: DateRange structure

This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

ResourceIdentifiers

Type: Array of strings

These are the resources included in the resource selection (including type of resources and vaults).

VaultNames

Type: Array of strings

These are the names of the vaults in which the selected recovery points are contained.

ReportDeliveryChannel

Description

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

Members

Formats

Type: Array of strings

A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

S3BucketName

Required: Yes
Type: string

The unique name of the S3 bucket that receives your reports.

S3KeyPrefix

Type: string

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

ReportDestination

Description

Contains information from your report job about your report destination.

Members

S3BucketName

Type: string

The unique name of the Amazon S3 bucket that receives your reports.

S3Keys

Type: Array of strings

The object key that uniquely identifies your reports in your S3 bucket.

ReportJob

Description

Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

Members

CompletionTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a report job is 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.

ReportDestination

Type: ReportDestination structure

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

ReportJobId

Type: string

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

ReportPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

ReportTemplate

Type: string

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

Status

Type: string

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

StatusMessage

Type: string

A message explaining the status of the report job.

ReportPlan

Description

Contains detailed information about a report plan.

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

DeploymentStatus

Type: string

The deployment status of a report plan. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

LastAttemptedExecutionTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

LastSuccessfulExecutionTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

ReportDeliveryChannel

Type: ReportDeliveryChannel structure

Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

ReportPlanArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

ReportPlanDescription

Type: string

An optional description of the report plan with a maximum 1,024 characters.

ReportPlanName

Type: string

The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

ReportSetting

Type: ReportSetting structure

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

ReportSetting

Description

Contains detailed information about a report setting.

Members

Accounts

Type: Array of strings

These are the accounts to be included in the report.

FrameworkArns

Type: Array of strings

The Amazon Resource Names (ARNs) of the frameworks a report covers.

NumberOfFrameworks

Type: int

The number of frameworks a report covers.

OrganizationUnits

Type: Array of strings

These are the Organizational Units to be included in the report.

Regions

Type: Array of strings

These are the Regions to be included in the report.

ReportTemplate

Required: Yes
Type: string

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

ResourceNotFoundException

Description

A resource that is required for the action doesn't exist.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

RestoreJobCreator

Description

Contains information about the restore testing plan that Backup used to initiate the restore job.

Members

RestoreTestingPlanArn

Type: string

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

RestoreJobSummary

Description

This is a summary of restore jobs created or running within the most recent 30 days.

The returned summary may contain the following: Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Members

AccountId

Type: string

The account ID that owns the jobs within the summary.

Count

Type: int

The value as a number of jobs in a job summary.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The value of time in number format of a job end time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Region

Type: string

The Amazon Web Services Regions within the job summary.

ResourceType

Type: string

This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The value of time in number format of a job start time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

State

Type: string

This value is job count for jobs with the specified state.

RestoreJobsListMember

Description

Contains metadata about a restore job.

Members

AccountId

Type: string

The account ID that owns the restore job.

BackupSizeInBytes

Type: long (int|float)

The size, in bytes, of the restored resource.

CompletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

CreatedBy

Type: RestoreJobCreator structure

Contains identifying information about the creation of a restore job.

CreatedResourceArn

Type: string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

DeletionStatus

Type: string

This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.

DeletionStatusMessage

Type: string

This describes the restore job deletion status.

ExpectedCompletionTimeMinutes

Type: long (int|float)

The amount of time in minutes that a job restoring a recovery point is expected to take.

IamRoleArn

Type: string

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

PercentDone

Type: string

Contains an estimated percentage complete of a job at the time the job status was queried.

RecoveryPointArn

Type: string

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

RecoveryPointCreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date on which a recovery point was created.

ResourceType

Type: string

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

RestoreJobId

Type: string

Uniquely identifies the job that restores a recovery point.

Status

Type: string

A status code specifying the state of the job initiated by Backup to restore a recovery point.

StatusMessage

Type: string

A detailed message explaining the status of the job to restore a recovery point.

ValidationStatus

Type: string

This is the status of validation run on the indicated restore job.

ValidationStatusMessage

Type: string

This describes the status of validation run on the indicated restore job.

RestoreTestingPlanForCreate

Description

This contains metadata about a restore testing plan.

Members

RecoveryPointSelection

Required: Yes
Type: RestoreTestingRecoveryPointSelection structure

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.

RestoreTestingPlanName

Required: Yes
Type: 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.

ScheduleExpression

Required: Yes
Type: string

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

ScheduleExpressionTimezone

Type: 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

Type: int

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

RestoreTestingPlanForGet

Description

This contains metadata about a restore testing plan.

Members

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

CreatorRequestId

Type: 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.

LastExecutionTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

RecoveryPointSelection

Required: Yes
Type: RestoreTestingRecoveryPointSelection structure

The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

RestoreTestingPlanArn

Required: Yes
Type: string

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

RestoreTestingPlanName

Required: Yes
Type: string

This is the restore testing plan name.

ScheduleExpression

Required: Yes
Type: string

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

ScheduleExpressionTimezone

Type: 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

Type: int

Defaults to 24 hours.

RestoreTestingPlanForList

Description

This contains metadata about a restore testing plan.

Members

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

LastExecutionTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

LastUpdateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

RestoreTestingPlanArn

Required: Yes
Type: string

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

RestoreTestingPlanName

Required: Yes
Type: string

This is the restore testing plan name.

ScheduleExpression

Required: Yes
Type: string

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

ScheduleExpressionTimezone

Type: 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

Type: int

Defaults to 24 hours.

RestoreTestingPlanForUpdate

Description

This contains metadata about a restore testing plan.

Members

RecoveryPointSelection

Type: RestoreTestingRecoveryPointSelection structure

Required: Algorithm; RecoveryPointTypes; IncludeVaults (one or more).

Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (defaults to empty list if not listed).

ScheduleExpression

Type: string

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

ScheduleExpressionTimezone

Type: 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

Type: int

Defaults to 24 hours.

RestoreTestingRecoveryPointSelection

Description

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.

Members

Algorithm

Type: string

Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"

ExcludeVaults

Type: Array of strings

Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.

IncludeVaults

Type: Array of strings

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-*", ...]

RecoveryPointTypes

Type: Array of strings

These are the types of recovery points.

SelectionWindowDays

Type: int

Accepted values are integers from 1 to 365.

RestoreTestingSelectionForCreate

Description

This contains metadata about a specific restore testing selection.

ProtectedResourceType is required, such as Amazon EBS or Amazon EC2.

This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:

ProtectedResourceArns
ProtectedResourceConditions

Each protected resource type can have one single value.

ProtectedResourceConditions examples include as StringEquals and StringNotEquals.

Members

IamRoleArn

Required: Yes
Type: 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

Type: Array of strings

Each protected resource can be filtered by its specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or by a wildcard: ProtectedResourceArns: ["*"], but not both.

ProtectedResourceConditions

Type: ProtectedResourceConditions structure

If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }].

ProtectedResourceType

Required: Yes
Type: 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.

Supported resource types accepted include:

Aurora for Amazon Aurora
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
S3 for Amazon S3

RestoreMetadataOverrides

Type: Associative array of custom strings keys (String) to strings

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.

RestoreTestingSelectionName

Required: Yes
Type: string

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

ValidationWindowHours

Type: int

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.

RestoreTestingSelectionForGet

Description

This contains metadata about a restore testing selection.

Members

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Type: string

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

IamRoleArn

Required: Yes
Type: 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

Type: Array of strings

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

ProtectedResourceConditions

Type: ProtectedResourceConditions structure

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

ProtectedResourceType

Required: Yes
Type: 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

Type: Associative array of custom strings keys (String) to strings

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.

RestoreTestingPlanName

Required: Yes
Type: string

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

RestoreTestingSelectionName

Required: Yes
Type: string

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

ValidationWindowHours

Type: int

RestoreTestingSelectionForList

Description

This contains metadata about a restore testing selection.

Members

CreationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

This is 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

Required: Yes
Type: 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

Required: Yes
Type: 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

Required: Yes
Type: 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

Required: Yes
Type: string

Unique name of a restore testing selection.

ValidationWindowHours

Type: int

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

RestoreTestingSelectionForUpdate

Description

This contains metadata about a restore testing selection.

Members

IamRoleArn

Type: 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

Type: Array of strings

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.

ProtectedResourceConditions

Type: ProtectedResourceConditions structure

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.

RestoreMetadataOverrides

Type: Associative array of custom strings keys (String) to strings

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.

ValidationWindowHours

Type: int

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

ServiceUnavailableException

Description

The request failed due to a temporary failure of the server.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

AWS Backup 2018-11-15

Operation Summary

Paginators

Operations

CancelLegalHold

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateBackupPlan

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateBackupSelection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateBackupVault

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFramework

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLegalHold

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLogicallyAirGappedBackupVault

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateReportPlan

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateRestoreTestingPlan

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateRestoreTestingSelection

Parameter Syntax

Parameter Details

Members

Result Syntax