CancelLegalHold

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

InvalidResourceStateException:

Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

CreateBackupPlan

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

LimitExceededException:

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

AlreadyExistsException:

The required resource already exists.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

CreateBackupSelection

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

LimitExceededException:

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

AlreadyExistsException:

The required resource already exists.

CreateFramework

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AlreadyExistsException:

The required resource already exists.

LimitExceededException:

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

CreateLegalHold

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

LimitExceededException:

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

CreateLogicallyAirGappedBackupVault

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

Creates a logical container to where backups may be copied.

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AlreadyExistsException:

The required resource already exists.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

LimitExceededException:

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

CreateReportPlan

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AlreadyExistsException:

The required resource already exists.

LimitExceededException:

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

ServiceUnavailableException:

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

MissingParameterValueException:

Indicates that a required parameter is missing.

CreateRestoreTestingPlan

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

Creates a restore testing plan.

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AlreadyExistsException:

The required resource already exists.

ConflictException:

Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

LimitExceededException:

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

CreateRestoreTestingSelection

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

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

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

• ProtectedResourceArns

• ProtectedResourceConditions

Each protected resource type can have one single value.

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AlreadyExistsException:

The required resource already exists.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

LimitExceededException:

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

MissingParameterValueException:

Indicates that a required parameter is missing.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

ServiceUnavailableException:

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

DeleteBackupPlan

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

DeleteBackupVaultLockConfiguration

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

ServiceUnavailableException:

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

DeleteBackupVaultNotifications

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

Deletes event notifications for the specified backup vault.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

DeleteFramework

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

Deletes the framework specified by a framework name.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

MissingParameterValueException:

Indicates that a required parameter is missing.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

ServiceUnavailableException:

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

ConflictException:

Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

DeleteRecoveryPoint

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

Deletes the recovery point specified by a recovery point ID.

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

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

InvalidResourceStateException:

Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

ServiceUnavailableException:

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

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

DeleteReportPlan

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

Deletes the report plan specified by a report plan name.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

MissingParameterValueException:

Indicates that a required parameter is missing.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

ConflictException:

Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

ServiceUnavailableException:

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

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

DeleteRestoreTestingPlan

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

This request deletes the specified restore testing plan.

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

ServiceUnavailableException:

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

DeleteRestoreTestingSelection

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

ServiceUnavailableException:

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

DescribeBackupJob

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

Returns backup job details for the specified BackupJobId.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

DependencyFailureException:

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

DescribeBackupVault

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

Returns metadata about a backup vault specified by its name.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

DescribeFramework

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

Returns the framework details for the specified FrameworkName.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

DescribeGlobalSettings

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

ServiceUnavailableException:

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

DescribeProtectedResource

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

MissingParameterValueException:

Indicates that a required parameter is missing.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

ServiceUnavailableException:

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

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

DescribeRecoveryPoint

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

DescribeRegionSettings

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ServiceUnavailableException:

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

DescribeReportJob

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ServiceUnavailableException:

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

MissingParameterValueException:

Indicates that a required parameter is missing.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

DescribeReportPlan

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

ServiceUnavailableException:

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

DescribeRestoreJob

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

DependencyFailureException:

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

DisassociateRecoveryPoint

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

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

Does not support snapshot backup recovery points.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

InvalidResourceStateException:

Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

ServiceUnavailableException:

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

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

DisassociateRecoveryPointFromParent

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

ExportBackupPlanTemplate

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

GetLegalHold

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

GetRecoveryPointRestoreMetadata

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

GetRestoreJobMetadata

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

This request returns the metadata for the specified restore job.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

GetRestoreTestingInferredMetadata

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

ServiceUnavailableException:

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

GetRestoreTestingPlan

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

ServiceUnavailableException:

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

GetRestoreTestingSelection

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

ServiceUnavailableException:

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

GetSupportedResourceTypes

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

Returns the Amazon Web Services resource types supported by Backup.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ServiceUnavailableException:

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

ListBackupJobSummaries

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

ServiceUnavailableException:

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

ListBackupJobs

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Lists the backup plan templates.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

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

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([/* ... */]);

Lists the active backup plans for the account.

Parameter Syntax

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

Parameter Details

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

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

ListBackupVaults

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'BackupVaultList' => [
        [
            'BackupVaultArn' => '<string>',
            'BackupVaultName' => '<string>',
            'CreationDate' => <DateTime>,
            'CreatorRequestId' => '<string>',
            'EncryptionKeyArn' => '<string>',
            'LockDate' => <DateTime>,
            'Locked' => true || false,
            'MaxRetentionDays' => <integer>,
            'MinRetentionDays' => <integer>,
            'NumberOfRecoveryPoints' => <integer>,
            'VaultState' => 'CREATING|AVAILABLE|FAILED',
            'VaultType' => 'BACKUP_VAULT|LOGICALLY_AIR_GAPPED_BACKUP_VAULT',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

A resource that is required for the action doesn't exist.

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException:

Indicates that a required parameter is missing.

ServiceUnavailableException:

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

ListCopyJobSummaries

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

ServiceUnavailableException:

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

ListCopyJobs

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

Returns metadata about your copy jobs.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

ServiceUnavailableException:

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

ListFrameworks

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

ServiceUnavailableException:

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

ListLegalHolds

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

This action returns metadata about active and previous legal holds.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterValueException:

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

ServiceUnavailableException:

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

ListProtectedResources

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details