BackupJob
Contains detailed information about a backup job.
Contents
- AccountId
-
The account ID that owns the backup job.
Type: String
Pattern:
^[0-9]{12}$Required: No
- BackupJobId
-
Uniquely identifies a request to AWS Backup to back up a resource.
Type: String
Required: No
- 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. If you specify an invalid option, you get anInvalidParameterValueExceptionexception.Type: String to string map
Key Pattern:
^[a-zA-Z0-9\-\_\.]{1,50}$Value Pattern:
^[a-zA-Z0-9\-\_\.]{1,50}$Required: No
- BackupSizeInBytes
-
The size, in bytes, of a backup.
Type: Long
Required: No
- BackupType
-
Represents the type of backup for a backup job.
Type: String
Required: No
- BackupVaultArn
-
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.Type: String
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: No
- BytesTransferred
-
The size in bytes transferred to a backup vault at the time that the job status was queried.
Type: Long
Required: No
- CompletionDate
-
The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of
CompletionDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
Required: No
- CreatedBy
-
Contains identifying information about the creation of a backup job, including the
BackupPlanArn,BackupPlanId,BackupPlanVersion, andBackupRuleIdof the backup plan used to create it.Type: RecoveryPointCreator object
Required: No
- CreationDate
-
The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
Required: No
- ExpectedCompletionDate
-
The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of
ExpectedCompletionDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
Required: No
- IamRoleArn
-
Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either
AWSBackuporAwsBackupin the role name. For example,arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.Type: String
Required: No
- PercentDone
-
Contains an estimated percentage complete of a job at the time the job status was queried.
Type: String
Required: No
- 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
Required: No
- ResourceArn
-
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: No
- ResourceType
-
The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.
Type: String
Pattern:
^[a-zA-Z0-9\-\_\.]{1,50}$Required: No
- StartBy
-
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the
StartBytime would be 8:00 PM on the date specified. The value ofStartByis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
Required: No
- State
-
The current state of a resource recovery point.
Type: String
Valid Values:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIREDRequired: No
- StatusMessage
-
A detailed message explaining the status of the job to back up a resource.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
