StartBackupJob - AWS Backup
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

StartBackupJob

Starts an on-demand backup job for the specified resource.

Request Syntax

PUT /backup-jobs HTTP/1.1 Content-type: application/json { "BackupOptions": { "string" : "string" }, "BackupVaultName": "string", "CompleteWindowMinutes": number, "IamRoleArn": "string", "IdempotencyToken": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "ResourceArn": "string", "StartWindowMinutes": number }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

BackupOptions

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.

Type: String to string map

Key Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

Value Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

Required: No

BackupVaultName

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 lowercase letters, numbers, and hyphens.

Type: String

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

Required: Yes

CompleteWindowMinutes

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.

Type: Long

Required: No

IamRoleArn

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

Type: String

Required: Yes

IdempotencyToken

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

Type: String

Required: No

Lifecycle

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.

Type: Lifecycle object

Required: No

RecoveryPointTags

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

Type: String to string map

Required: No

ResourceArn

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

Type: String

Required: Yes

StartWindowMinutes

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.

Type: Long

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "BackupJobId": "string", "CreationDate": number, "RecoveryPointArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BackupJobId

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

Type: String

CreationDate

The date and time that a backup job is started, 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.

Type: Timestamp

RecoveryPointArn

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

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

HTTP Status Code: 400

InvalidRequestException

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

HTTP Status Code: 400

LimitExceededException

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

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

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

HTTP Status Code: 400

ServiceUnavailableException

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

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: