Backup / Client / describe_copy_job

describe_copy_job#

Backup.Client.describe_copy_job(**kwargs)#

Returns metadata associated with creating a copy of a resource.

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',
        'DestinationRecoveryPointArn': 'string',
        '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',
            'BackupPlanVersion': 'string',
            'BackupRuleId': '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.
  - 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.
  - 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.
    - 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.
  - 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