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

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.
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.
DeleteBackupVaultNotifications ( array $params = [] )
Deletes event notifications for the specified backup vault.
DeleteRecoveryPoint ( array $params = [] )
Deletes the recovery point specified by a recovery point ID.
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.
DescribeGlobalSettings ( array $params = [] )
Describes the global settings of the AWS account, including whether it 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 AWS 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.
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 AWS Backup and releases control of that continuous backup to the source service, such as Amazon RDS.
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.
GetRecoveryPointRestoreMetadata ( array $params = [] )
Returns a set of metadata key-value pairs that were used to create the backup.
GetSupportedResourceTypes ( array $params = [] )
Returns the AWS resource types supported by AWS Backup.
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 existing 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.
ListCopyJobs ( array $params = [] )
Returns metadata about your copy jobs.
ListProtectedResources ( array $params = [] )
Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
ListRecoveryPointsByBackupVault ( array $params = [] )
Returns detailed information about the recovery points stored in a backup vault.
ListRecoveryPointsByResource ( array $params = [] )
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
ListRestoreJobs ( array $params = [] )
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
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.
PutBackupVaultNotifications ( array $params = [] )
Turns on notifications on a backup vault for the specified topic and events.
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.
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.
UpdateGlobalSettings ( array $params = [] )
Updates the current global settings for the AWS account.
UpdateRecoveryPointLifecycle ( array $params = [] )
Sets the transition lifecycle of a recovery point.
UpdateRegionSettings ( array $params = [] )
Updates the current service opt-in settings for the Region.

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:

ListBackupJobs
ListBackupPlanTemplates
ListBackupPlanVersions
ListBackupPlans
ListBackupSelections
ListBackupVaults
ListCopyJobs
ListProtectedResources
ListRecoveryPointsByBackupVault
ListRecoveryPointsByResource
ListRestoreJobs
ListTags

Operations

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 AWS Backup uses to schedule tasks that create recovery points for resources.

If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.

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>,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleName' => '<string>', // REQUIRED
                'ScheduleExpression' => '<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.

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 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. Resources can be included by specifying patterns for a ListOfTags and selected Resources.

For example, consider the following patterns:

Resources: "arn:aws:ec2:region:account-id:volume/volume-id"
ConditionKey:"department"

ConditionValue:"finance"

ConditionType:"StringEquals"
ConditionKey:"importance"

ConditionValue:"critical"

ConditionType:"StringEquals"

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume ID.

Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically put together using the OR operator. In other words, all patterns that match are selected for backup.

Parameter Syntax

$result = $client->createBackupSelection([
    'BackupPlanId' => '<string>', // REQUIRED
    'BackupSelection' => [ // REQUIRED
        'IamRoleArn' => '<string>', // REQUIRED
        'ListOfTags' => [
            [
                'ConditionKey' => '<string>', // REQUIRED
                'ConditionType' => 'STRINGEQUALS', // REQUIRED
                'ConditionValue' => '<string>', // REQUIRED
            ],
            // ...
        ],
        '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.

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.

Sensitive data, such as passport numbers, should not be included 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 AWS 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.

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.

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.

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.

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.

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:
AWS 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.

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 AWS Backup to back up a resource.

Result Syntax

[
    '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>',
    'PercentDone' => '<string>',
    'RecoveryPointArn' => '<string>',
    'ResourceArn' => '<string>',
    'ResourceType' => '<string>',
    'StartBy' => <DateTime>,
    'State' => 'CREATED|PENDING|RUNNING|ABORTING|ABORTED|COMPLETED|FAILED|EXPIRED',
    '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 AWS 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 WindowsVSS backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type that was is 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.

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.

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.

ResourceType

Type: string

The type of AWS 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 resource recovery point.

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 AWS service or resource returned an error to the AWS 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([
    'BackupVaultName' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

Result Syntax

[
    'BackupVaultArn' => '<string>',
    'BackupVaultName' => '<string>',
    'CreationDate' => <DateTime>,
    'CreatorRequestId' => '<string>',
    'EncryptionKeyArn' => '<string>',
    'NumberOfRecoveryPoints' => <integer>,
]

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.

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.

NumberOfRecoveryPoints

Type: long (int|float)

The number of recovery points that are stored 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.

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>,
        'CompletionDate' => <DateTime>,
        'CopyJobId' => '<string>',
        'CreatedBy' => [
            'BackupPlanArn' => '<string>',
            'BackupPlanId' => '<string>',
            'BackupPlanVersion' => '<string>',
            'BackupRuleId' => '<string>',
        ],
        'CreationDate' => <DateTime>,
        'DestinationBackupVaultArn' => '<string>',
        'DestinationRecoveryPointArn' => '<string>',
        'IamRoleArn' => '<string>',
        'ResourceArn' => '<string>',
        'ResourceType' => '<string>',
        'SourceBackupVaultArn' => '<string>',
        'SourceRecoveryPointArn' => '<string>',
        'State' => 'CREATED|RUNNING|COMPLETED|FAILED',
        '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.

DescribeGlobalSettings

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

Describes the global settings of the AWS account, including whether it is opted in to cross-account backup.

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

A list of resources along with the opt-in preferences for the account.

LastUpdateTime

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

The date and time that the global settings were 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 AWS 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>,
    'ResourceArn' => '<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.

ResourceArn

Type: string

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

ResourceType

Type: string

The type of AWS resource saved as a recovery point; for example, an 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([
    '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

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

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.

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.

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. AWS 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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

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.

ResourceType

Type: string

The type of AWS 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 AWS account or Region, this value will be null.

Status

Type: string

A status code specifying the state of the recovery point.

A partial status indicates that the recovery point was not successfully re-created and must be retried.

StorageClass

Type: string

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

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, AWS 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, AWS Backup does not try to protect that service's resources in this Region, AWS Backup does not try to protect that service's resources in this Region.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

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

Result Details

Members

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.

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>,
    'CreatedResourceArn' => '<string>',
    'CreationDate' => <DateTime>,
    'ExpectedCompletionTimeMinutes' => <integer>,
    'IamRoleArn' => '<string>',
    'PercentDone' => '<string>',
    'RecoveryPointArn' => '<string>',
    'ResourceType' => '<string>',
    'RestoreJobId' => '<string>',
    'Status' => 'PENDING|RUNNING|COMPLETED|ABORTED|FAILED',
    'StatusMessage' => '<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.

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.

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.

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 AWS Backup to restore a recovery point.

StatusMessage

Type: string

A message showing the status of a job to restore 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.
DependencyFailureException:
A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be completed.

DisassociateRecoveryPoint

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

Deletes the specified continuous backup recovery point from AWS 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 AWS Backup vault. Required.

RecoveryPointArn

Required: Yes
Type: string

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

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:
AWS 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.

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>,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleId' => '<string>',
                'RuleName' => '<string>',
                'ScheduleExpression' => '<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>,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleId' => '<string>',
                'RuleName' => '<string>',
                'ScheduleExpression' => '<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>,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleId' => '<string>',
                'RuleName' => '<string>',
                'ScheduleExpression' => '<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' => [
        'IamRoleArn' => '<string>',
        'ListOfTags' => [
            [
                'ConditionKey' => '<string>',
                'ConditionType' => 'STRINGEQUALS',
                'ConditionValue' => '<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.

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([
    '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

[
    'BackupVaultArn' => '<string>',
    'RecoveryPointArn' => '<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.

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.

GetSupportedResourceTypes

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

Returns the AWS resource types supported by AWS 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 AWS resource types:

DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Aurora for Amazon Aurora
Storage Gateway for AWS Storage Gateway

Errors

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>',
    'ByCreatedAfter' => <integer || string || DateTime>,
    'ByCreatedBefore' => <integer || string || DateTime>,
    'ByResourceArn' => '<string>',
    'ByResourceType' => '<string>',
    'ByState' => 'CREATED|PENDING|RUNNING|ABORTING|ABORTED|COMPLETED|FAILED|EXPIRED',
    '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 AWS 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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

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.

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:

DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Aurora for Amazon Aurora
Storage Gateway for AWS Storage Gateway

ByState

Type: string

Returns only backup 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

[
    '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>',
            'PercentDone' => '<string>',
            'RecoveryPointArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceType' => '<string>',
            'StartBy' => <DateTime>,
            'State' => 'CREATED|PENDING|RUNNING|ABORTING|ABORTED|COMPLETED|FAILED|EXPIRED',
            '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 existing backup plans for an authenticated account. The list is populated only if the advanced option is set for the backup plan. 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([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

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>',
            '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.

ListCopyJobs

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

Returns metadata about your copy jobs.

Parameter Syntax

$result = $client->listCopyJobs([
    'ByAccountId' => '<string>',
    'ByCreatedAfter' => <integer || string || DateTime>,
    'ByCreatedBefore' => <integer || string || DateTime>,
    'ByDestinationVaultArn' => '<string>',
    'ByResourceArn' => '<string>',
    'ByResourceType' => '<string>',
    'ByState' => 'CREATED|RUNNING|COMPLETED|FAILED',
    '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.

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.

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:

DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Aurora for Amazon Aurora
Storage Gateway for AWS Storage Gateway

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>,
            'CompletionDate' => <DateTime>,
            'CopyJobId' => '<string>',
            'CreatedBy' => [
                'BackupPlanArn' => '<string>',
                'BackupPlanId' => '<string>',
                'BackupPlanVersion' => '<string>',
                'BackupRuleId' => '<string>',
            ],
            'CreationDate' => <DateTime>,
            'DestinationBackupVaultArn' => '<string>',
            'DestinationRecoveryPointArn' => '<string>',
            'IamRoleArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceType' => '<string>',
            'SourceBackupVaultArn' => '<string>',
            'SourceRecoveryPointArn' => '<string>',
            'State' => 'CREATED|RUNNING|COMPLETED|FAILED',
            '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.

ListProtectedResources

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

Returns an array of resources successfully backed up by AWS 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>,
            'ResourceArn' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Results

Type: Array of ProtectedResource structures

An array of resources successfully backed up by AWS 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.

ListRecoveryPointsByBackupVault

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

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

Parameter Syntax

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

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

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.

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.

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>,
            'CreatedBy' => [
                'BackupPlanArn' => '<string>',
                'BackupPlanId' => '<string>',
                'BackupPlanVersion' => '<string>',
                'BackupRuleId' => '<string>',
            ],
            'CreationDate' => <DateTime>,
            'EncryptionKeyArn' => '<string>',
            'IamRoleArn' => '<string>',
            'IsEncrypted' => true || false,
            'LastRestoreTime' => <DateTime>,
            'Lifecycle' => [
                'DeleteAfterDays' => <integer>,
                'MoveToColdStorageAfterDays' => <integer>,
            ],
            'RecoveryPointArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceType' => '<string>',
            'SourceBackupVaultArn' => '<string>',
            'Status' => 'COMPLETED|PARTIAL|DELETING|EXPIRED',
        ],
        // ...
    ],
]

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.

ListRecoveryPointsByResource

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

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

Parameter Syntax

$result = $client->listRecoveryPointsByResource([
    '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 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>',
            'RecoveryPointArn' => '<string>',
            'Status' => 'COMPLETED|PARTIAL|DELETING|EXPIRED',
        ],
        // ...
    ],
]

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.

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.

ListRestoreJobs

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

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

Parameter Syntax

$result = $client->listRestoreJobs([
    'ByAccountId' => '<string>',
    'ByCreatedAfter' => <integer || string || DateTime>,
    'ByCreatedBefore' => <integer || string || DateTime>,
    '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.

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.

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>,
            'CreatedResourceArn' => '<string>',
            'CreationDate' => <DateTime>,
            'ExpectedCompletionTimeMinutes' => <integer>,
            'IamRoleArn' => '<string>',
            'PercentDone' => '<string>',
            'RecoveryPointArn' => '<string>',
            'ResourceType' => '<string>',
            'RestoreJobId' => '<string>',
            'Status' => 'PENDING|RUNNING|COMPLETED|ABORTED|FAILED',
            'StatusMessage' => '<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.

$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 are currently only supported with Amazon EFS backups.

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.

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.

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.

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>,
    ],
    '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 VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows 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 AWS 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.

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 can be used to distinguish between calls to StartBackupJob.

Lifecycle

Type: Lifecycle structure

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

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.

Result Syntax

[
    'BackupJobId' => '<string>',
    'CreationDate' => <DateTime>,
    'RecoveryPointArn' => '<string>',
]

Result Details

Members

BackupJobId

Type: string

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

CreationDate

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

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.

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>,
    ],
    '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 can be used to distinguish between calls to StartCopyJob.

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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Result Syntax

[
    'CopyJobId' => '<string>',
    'CreationDate' => <DateTime>,
]

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.

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.

StartRestoreJob

$result = $client->startRestoreJob([/* ... */]);
$promise = $client->startRestoreJobAsync([/* ... */]);

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->startRestoreJob([
    'IamRoleArn' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>',
    'Metadata' => ['<string>', ...], // REQUIRED
    'RecoveryPointArn' => '<string>', // REQUIRED
    'ResourceType' => '<string>',
]);

Parameter Details

Members

IamRoleArn

Required: Yes
Type: string

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

IdempotencyToken

Type: string

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

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 AWS 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 AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS 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:

DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Aurora for Amazon Aurora
Storage Gateway for AWS Storage Gateway

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.

StopBackupJob

$result = $client->stopBackupJob([/* ... */]);
$promise = $client->stopBackupJobAsync([/* ... */]);

Attempts to cancel a job to create a one-time backup of a resource.

Parameter Syntax

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

Parameter Details

Members

BackupJobId

Required: Yes
Type: string

Uniquely identifies a request to AWS 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.

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>,
                        ],
                    ],
                    // ...
                ],
                'EnableContinuousBackup' => true || false,
                'Lifecycle' => [
                    'DeleteAfterDays' => <integer>,
                    'MoveToColdStorageAfterDays' => <integer>,
                ],
                'RecoveryPointTags' => ['<string>', ...],
                'RuleName' => '<string>', // REQUIRED
                'ScheduleExpression' => '<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 updated, 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.

UpdateGlobalSettings

$result = $client->updateGlobalSettings([/* ... */]);
$promise = $client->updateGlobalSettingsAsync([/* ... */]);

Updates the current global settings for the AWS 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 list of resources along with the opt-in preferences for the account.

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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Does not support continuous backups.

Parameter Syntax

$result = $client->updateRecoveryPointLifecycle([
    'BackupVaultName' => '<string>', // REQUIRED
    'Lifecycle' => [
        'DeleteAfterDays' => <integer>,
        'MoveToColdStorageAfterDays' => <integer>,
    ],
    'RecoveryPointArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

BackupVaultName

Required: Yes
Type: string

Lifecycle

Type: Lifecycle structure

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>,
    ],
    '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

Only Amazon EFS file system backups can be transitioned to cold storage.

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.
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. If service-opt-in is enabled for a service, AWS 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, AWS Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.

Parameter Syntax

$result = $client->updateRegionSettings([
    'ResourceTypeOptInPreference' => [true || false, ...],
]);

Parameter Details

Members

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.

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.

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 VSS Windows 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 VSS. For an CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the AWS 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 AWS 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 VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows 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.

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.

ResourceType

Type: string

The type of AWS 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 VSS Windows 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 resource recovery point.

StatusMessage

Type: string

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

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

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

Members

AdvancedBackupSettings

Type: Array of AdvancedBackupSetting structures

Specifies a list of BackupOptions for each resource type. These settings are only available for Windows VSS backup jobs.

BackupPlanName

Required: Yes
Type: string

The optional display name of a backup plan.

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.

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 AWS 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 AWS Backup creates continuous backups. True causes AWS Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes AWS Backup to create snapshot backups.

Lifecycle

Type: Lifecycle structure

Only Amazon EFS file system backups can be transitioned to cold storage.

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

An optional display name for a backup rule.

ScheduleExpression

Type: string

A CRON expression specifying when AWS Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

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.

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 AWS 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

Only Amazon EFS file system backups can be transitioned to cold storage.

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

An optional display name for a backup rule.

ScheduleExpression

Type: string

A CRON expression specifying when AWS Backup initiates a backup job.

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.

TargetBackupVaultName

Required: Yes
Type: string

BackupSelection

Description

Used to specify a set of resources to a backup plan.

Members

IamRoleArn

Required: Yes
Type: string

The ARN of the IAM role that AWS Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

ListOfTags

Type: Array of Condition structures

An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting". Assigns the backup plan to every resource with at least one matching tag.

Resources

Type: Array of strings

An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.

SelectionName

Required: Yes
Type: string

The display name of a resource selection document.

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)

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.

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.

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.

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.

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.

Only Amazon EFS file system backups can be transitioned to cold storage.

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. Conditions are used to filter resources in a selection that is assigned to a backup plan.

Members

ConditionKey

Required: Yes
Type: string

The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "ec2:ResourceTag/Department" is the key.

ConditionType

Required: Yes
Type: string

An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection.

ConditionValue

Required: Yes
Type: string

The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "accounting" is the value.

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.

Only Amazon EFS file system backups can be transitioned to cold storage.

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.

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.

CopyJobId

Type: string

Uniquely identifies a copy job.

CreatedBy

Type: RecoveryPointCreator structure

Contains information about the backup plan and rule that AWS 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.

ResourceArn

Type: string

The AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

ResourceType

Type: string

The type of AWS 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.

DependencyFailureException

Description

A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be completed.

Members

Code

Type: string

Context

Type: string

Message

Type: string

Type

Type: string

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

AWS 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

Lifecycle

Description

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Only Amazon EFS file system backups can be transitioned to cold storage.

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.

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.

ResourceArn

Type: string

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

ResourceType

Type: string

The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

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.

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.

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

Only Amazon EFS file system backups can be transitioned to cold storage.

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.

ResourceType

Type: string

The type of AWS 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 VSS Windows 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.

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.

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.

Status

Type: string

A status code specifying the state of the recovery point.

RecoveryPointCreator

Description

Contains information about the backup plan and rule that AWS 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.

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

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)

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.

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.

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 VSS Windows 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 AWS Backup to restore a recovery point.

StatusMessage

Type: string

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

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

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Backup 2018-11-15

Operation Summary

Paginators

Operations

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

DeleteBackupPlan

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteBackupSelection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteBackupVault

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteBackupVaultAccessPolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteBackupVaultNotifications

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteRecoveryPoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeBackupJob

Parameter Syntax

Parameter Details