CopyJob
¶
Source code in docs_src/capo_backup/types/copy_job.py
account_id
instance-attribute
¶
account_id: NotRequired[AccountId]
The account ID that owns the copy job.
backup_size_in_bytes
instance-attribute
¶
backup_size_in_bytes: NotRequired[Long]
The size, in bytes, of a copy job.
child_jobs_in_state
instance-attribute
¶
child_jobs_in_state: NotRequired[CopyJobChildJobsInState]
This returns the statistics of the included child (nested) copy jobs.
completion_date
instance-attribute
¶
completion_date: NotRequired[timestamp]
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.
composite_member_identifier
instance-attribute
¶
composite_member_identifier: NotRequired[string]
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.
created_by_backup_job_id
instance-attribute
¶
created_by_backup_job_id: NotRequired[string]
The backup job ID that initiated this copy job. Only applicable to scheduled copy jobs and automatic copy jobs to logically air-gapped vault.
creation_date
instance-attribute
¶
creation_date: NotRequired[timestamp]
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.
destination_backup_vault_arn
instance-attribute
¶
destination_backup_vault_arn: NotRequired[ARN]
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
destination_encryption_key_arn
instance-attribute
¶
destination_encryption_key_arn: NotRequired[ARN]
The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied backup in the destination vault. This can be a customer-managed key or an Amazon Web Services managed key.
destination_recovery_point_arn
instance-attribute
¶
destination_recovery_point_arn: NotRequired[ARN]
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.
destination_recovery_point_lifecycle
instance-attribute
¶
destination_recovery_point_lifecycle: NotRequired[Lifecycle]
destination_vault_lock_state
instance-attribute
¶
destination_vault_lock_state: NotRequired[string]
The lock state of the destination backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include LOCKED and UNLOCKED.
destination_vault_type
instance-attribute
¶
destination_vault_type: NotRequired[string]
The type of destination backup vault where the copied recovery point is stored. Valid values are BACKUP_VAULT for standard backup vaults and LOGICALLY_AIR_GAPPED_BACKUP_VAULT for logically air-gapped vaults.
iam_role_arn
instance-attribute
¶
iam_role_arn: NotRequired[IAMRoleArn]
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
is_parent
instance-attribute
¶
is_parent: Boolean2
This is a boolean value indicating this is a parent (composite) copy job.
message_category
instance-attribute
¶
message_category: NotRequired[string]
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
number_of_child_jobs
instance-attribute
¶
number_of_child_jobs: NotRequired[Long]
The number of child (nested) copy jobs.
parent_job_id
instance-attribute
¶
parent_job_id: NotRequired[string]
This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
resource_arn
instance-attribute
¶
resource_arn: NotRequired[ARN]
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
resource_name
instance-attribute
¶
resource_name: NotRequired[string]
The non-unique name of the resource that belongs to the specified backup.
resource_type
instance-attribute
¶
resource_type: NotRequired[ResourceType]
The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
source_backup_vault_arn
instance-attribute
¶
source_backup_vault_arn: NotRequired[ARN]
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.