CopyJob - Amazon Backup
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

CopyJob

Contains detailed information about a copy job.

Contents

AccountId

The account ID that owns the copy job.

Type: String

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

Required: No

BackupSizeInBytes

The size, in bytes, of a copy job.

Type: Long

Required: No

ChildJobsInState

This returns the statistics of the included child (nested) copy jobs.

Type: String to long map

Valid Keys: CREATED | RUNNING | COMPLETED | FAILED | PARTIAL

Required: No

CompletionDate

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

Type: Timestamp

Required: No

CompositeMemberIdentifier

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

Type: String

Required: No

CopyJobId

Uniquely identifies a copy job.

Type: String

Required: No

CreatedBy

Contains information about the backup plan and rule that Amazon Backup used to initiate the recovery point backup.

Type: RecoveryPointCreator object

Required: No

CreationDate

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

Type: Timestamp

Required: No

DestinationBackupVaultArn

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

Type: String

Required: No

DestinationRecoveryPointArn

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

Type: String

Required: No

IamRoleArn

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

Type: String

Required: No

IsParent

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

Type: Boolean

Required: No

MessageCategory

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

NumberOfChildJobs

This is the number of child (nested) copy jobs.

Type: Long

Required: No

ParentJobId

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

Type: String

Required: No

ResourceArn

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

Type: String

Required: No

ResourceName

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

Type: String

Required: No

ResourceType

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

Type: String

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

Required: No

SourceBackupVaultArn

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

Type: String

Required: No

SourceRecoveryPointArn

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

Type: String

Required: No

State

The current state of a copy job.

Type: String

Valid Values: CREATED | RUNNING | COMPLETED | FAILED | PARTIAL

Required: No

StatusMessage

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

Type: String

Required: No

See Also

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