BackupJob

The account ID that owns the backup job.

Type: String

Pattern: ^[0-9]{12}$

Required: No

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

Type: String

Required: No

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Type: String to string map

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

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

Required: No

The size, in bytes, of a backup (recovery point).

This value can render differently depending on the resource type as AWS Backup pulls in data information from other AWS services. For example, the value returned may show a value of 0, which may differ from the anticipated value.

The expected behavior for values by resource type are described as follows:

Type: Long

Required: No

Represents the type of backup for a backup job.

Type: String

Required: No

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

Type: String

Required: No

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.

Type: String

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

Required: No

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

Type: Long

Required: No

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

Type: Timestamp

Required: No

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

Type: RecoveryPointCreator object

Required: No

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

Type: Timestamp

Required: No

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

Type: Timestamp

Required: No

Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

Type: String

Required: No

The date on which the backup job was initiated.

Type: Timestamp

Required: No

This is a boolean value indicating this is a parent (composite) backup job.

Type: Boolean

Required: No

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

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

The the value ANY returns count of all message categories.

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

Type: String

Required: No

This uniquely identifies a request to AWS Backup to back up a resource. The return will be the parent (composite) job ID.

Type: String

Required: No

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

Type: String

Required: No

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

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

Type: String

Required: No

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

Type: String

Required: No

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 Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

Type: String

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

Required: No

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

Type: Timestamp

Required: No

The current state of a backup job.

Type: String

Valid Values: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

Required: No

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

Type: String

Required: No