Skip to content

CopyJob

Source code in docs_src/capo_backup/types/copy_job.py
class CopyJob(TypedDict, closed=True):
    account_id: NotRequired["capo_backup.types.account_id.AccountId"]
    """<p>The account ID that owns the copy job.</p>"""
    copy_job_id: NotRequired["capo_backup.types.string.string"]
    """<p>Uniquely identifies a copy job.</p>"""
    source_backup_vault_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>. </p>"""
    source_recovery_point_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An ARN that uniquely identifies a source recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"""
    destination_backup_vault_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>"""
    destination_vault_type: NotRequired["capo_backup.types.string.string"]
    """<p>The type of destination backup vault where the copied recovery point is stored. Valid values are <code>BACKUP_VAULT</code> for standard backup vaults and <code>LOGICALLY_AIR_GAPPED_BACKUP_VAULT</code> for logically air-gapped vaults.</p>"""
    destination_vault_lock_state: NotRequired["capo_backup.types.string.string"]
    """<p>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 <code>LOCKED</code> and <code>UNLOCKED</code>.</p>"""
    destination_recovery_point_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An ARN that uniquely identifies a destination recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"""
    destination_encryption_key_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>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.</p>"""
    destination_recovery_point_lifecycle: NotRequired[
        "capo_backup.types.lifecycle.Lifecycle"
    ]
    resource_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>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.</p>"""
    creation_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    completion_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    state: NotRequired["capo_backup.types.copy_job_state.CopyJobState"]
    """<p>The current state of a copy job.</p>"""
    status_message: NotRequired["capo_backup.types.string.string"]
    """<p>A detailed message explaining the status of the job to copy a resource.</p>"""
    backup_size_in_bytes: NotRequired["capo_backup.types.long.Long"]
    """<p>The size, in bytes, of a copy job.</p>"""
    iam_role_arn: NotRequired["capo_backup.types.iam_role_arn.IAMRoleArn"]
    """<p>Specifies the IAM role ARN used to copy the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"""
    created_by: NotRequired[
        "capo_backup.types.recovery_point_creator.RecoveryPointCreator"
    ]
    created_by_backup_job_id: NotRequired["capo_backup.types.string.string"]
    """<p>The backup job ID that initiated this copy job. Only applicable to scheduled copy jobs and automatic copy jobs to logically air-gapped vault.</p>"""
    resource_type: NotRequired["capo_backup.types.resource_type.ResourceType"]
    """<p>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.</p>"""
    parent_job_id: NotRequired["capo_backup.types.string.string"]
    """<p>This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.</p>"""
    is_parent: "capo_backup.types.boolean2.Boolean2"
    """<p>This is a boolean value indicating this is a parent (composite) copy job.</p>"""
    composite_member_identifier: NotRequired["capo_backup.types.string.string"]
    """<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax"> logical ID</a> within a stack.</p>"""
    number_of_child_jobs: NotRequired["capo_backup.types.long.Long"]
    """<p>The number of child (nested) copy jobs.</p>"""
    child_jobs_in_state: NotRequired[
        "capo_backup.types.copy_job_child_jobs_in_state.CopyJobChildJobsInState"
    ]
    """<p>This returns the statistics of the included child (nested) copy jobs.</p>"""
    resource_name: NotRequired["capo_backup.types.string.string"]
    """<p>The non-unique name of the resource that belongs to the specified backup.</p>"""
    message_category: NotRequired["capo_backup.types.string.string"]
    """<p>This parameter is the job count for the specified message category.</p> <p>Example strings may include <code>AccessDenied</code>, <code>SUCCESS</code>, <code>AGGREGATE_ALL</code>, and <code>InvalidParameters</code>. See <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a> for a list of MessageCategory strings.</p> <p>The the value ANY returns count of all message categories.</p> <p> <code>AGGREGATE_ALL</code> aggregates job counts for all message categories and returns the sum</p>"""

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.

copy_job_id instance-attribute

copy_job_id: NotRequired[string]

Uniquely identifies a copy job.

created_by instance-attribute

created_by: NotRequired[RecoveryPointCreator]

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.

source_recovery_point_arn instance-attribute

source_recovery_point_arn: NotRequired[ARN]

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.

state instance-attribute

state: NotRequired[CopyJobState]

The current state of a copy job.

status_message instance-attribute

status_message: NotRequired[string]

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