Backup / Client / describe_copy_job

describe_copy_job

Backup.Client.describe_copy_job(**kwargs)

Returns metadata associated with creating a copy of a resource.

See also: AWS API Documentation

Request Syntax

response = client.describe_copy_job(
    CopyJobId='string'
)

Parameters:

CopyJobId (string) –

[REQUIRED]

Uniquely identifies a copy job.

Return type:

dict

Returns:

Response Syntax

{
    'CopyJob': {
        'AccountId': 'string',
        'CopyJobId': 'string',
        'SourceBackupVaultArn': 'string',
        'SourceRecoveryPointArn': 'string',
        'DestinationBackupVaultArn': 'string',
        'DestinationVaultType': 'string',
        'DestinationVaultLockState': 'string',
        'DestinationRecoveryPointArn': 'string',
        'DestinationEncryptionKeyArn': 'string',
        'DestinationRecoveryPointLifecycle': {
            'MoveToColdStorageAfterDays': 123,
            'DeleteAfterDays': 123,
            'OptInToArchiveForSupportedResources': True|False
        },
        'ResourceArn': 'string',
        'CreationDate': datetime(2015, 1, 1),
        'CompletionDate': datetime(2015, 1, 1),
        'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
        'StatusMessage': 'string',
        'BackupSizeInBytes': 123,
        'IamRoleArn': 'string',
        'CreatedBy': {
            'BackupPlanId': 'string',
            'BackupPlanArn': 'string',
            'BackupPlanName': 'string',
            'BackupPlanVersion': 'string',
            'BackupRuleId': 'string',
            'BackupRuleName': 'string',
            'BackupRuleCron': 'string',
            'BackupRuleTimezone': 'string'
        },
        'ResourceType': 'string',
        'ParentJobId': 'string',
        'IsParent': True|False,
        'CompositeMemberIdentifier': 'string',
        'NumberOfChildJobs': 123,
        'ChildJobsInState': {
            'string': 123
        },
        'ResourceName': 'string',
        'MessageCategory': 'string'
    }
}

Response Structure

• (dict) –

  • CopyJob (dict) –

    Contains detailed information about a copy job.

    • AccountId (string) –

      The account ID that owns the copy job.

    • CopyJobId (string) –

      Uniquely identifies a copy job.

    • SourceBackupVaultArn (string) –

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

    • SourceRecoveryPointArn (string) –

      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.

    • DestinationBackupVaultArn (string) –

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

    • DestinationVaultType (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.

    • DestinationVaultLockState (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.

    • DestinationRecoveryPointArn (string) –

      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.

    • DestinationEncryptionKeyArn (string) –

      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.

    • DestinationRecoveryPointLifecycle (dict) –

      Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can’t be changed after a backup has been transitioned to cold.

      Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

      To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.

      • MoveToColdStorageAfterDays (integer) –

        The number of days after creation that a recovery point is moved to cold storage.

      • DeleteAfterDays (integer) –

        The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

      • OptInToArchiveForSupportedResources (boolean) –

        If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

    • ResourceArn (string) –

      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.

    • CreationDate (datetime) –

      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.

    • CompletionDate (datetime) –

      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.

    • State (string) –

      The current state of a copy job.

    • StatusMessage (string) –

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

    • BackupSizeInBytes (integer) –

      The size, in bytes, of a copy job.

    • IamRoleArn (string) –

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

    • CreatedBy (dict) –

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

      • BackupPlanId (string) –

        Uniquely identifies a backup plan.

      • BackupPlanArn (string) –

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • BackupPlanName (string) –

        The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.

      • BackupPlanVersion (string) –

        Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

      • BackupRuleId (string) –

        Uniquely identifies a rule used to schedule the backup of a selection of resources.

      • BackupRuleName (string) –

        The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.

      • BackupRuleCron (string) –

        The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.

      • BackupRuleTimezone (string) –

        The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.

    • ResourceType (string) –

      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.

    • ParentJobId (string) –

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

    • IsParent (boolean) –

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

    • CompositeMemberIdentifier (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.

    • NumberOfChildJobs (integer) –

      The number of child (nested) copy jobs.

    • ChildJobsInState (dict) –

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

      • (string) –

        • (integer) –

    • ResourceName (string) –

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

    • MessageCategory (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

Exceptions

• Backup.Client.exceptions.ResourceNotFoundException

• Backup.Client.exceptions.InvalidParameterValueException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ServiceUnavailableException