Backup / Client / list_copy_jobs

list_copy_jobs#

Backup.Client.list_copy_jobs(**kwargs)#

Returns metadata about your copy jobs.

Request Syntax

response = client.list_copy_jobs(
    NextToken='string',
    MaxResults=123,
    ByResourceArn='string',
    ByState='CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
    ByCreatedBefore=datetime(2015, 1, 1),
    ByCreatedAfter=datetime(2015, 1, 1),
    ByResourceType='string',
    ByDestinationVaultArn='string',
    ByAccountId='string',
    ByCompleteBefore=datetime(2015, 1, 1),
    ByCompleteAfter=datetime(2015, 1, 1),
    ByParentJobId='string',
    ByMessageCategory='string'
)

Parameters:

NextToken (string) – The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
MaxResults (integer) – The maximum number of items to be returned.
ByResourceArn (string) – Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
ByState (string) – Returns only copy jobs that are in the specified state.
ByCreatedBefore (datetime) – Returns only copy jobs that were created before the specified date.
ByCreatedAfter (datetime) – Returns only copy jobs that were created after the specified date.
ByResourceType (string) –
Returns only backup jobs for the specified resources:
- Aurora for Amazon Aurora
- CloudFormation for CloudFormation
- DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
- DynamoDB for Amazon DynamoDB
- EBS for Amazon Elastic Block Store
- EC2 for Amazon Elastic Compute Cloud
- EFS for Amazon Elastic File System
- FSx for Amazon FSx
- Neptune for Amazon Neptune
- Redshift for Amazon Redshift
- RDS for Amazon Relational Database Service
- SAP HANA on Amazon EC2 for SAP HANA databases
- Storage Gateway for Storage Gateway
- S3 for Amazon S3
- Timestream for Amazon Timestream
- VirtualMachine for virtual machines
ByDestinationVaultArn (string) – An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
ByAccountId (string) – The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
ByCompleteBefore (datetime) – Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
ByCompleteAfter (datetime) – Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
ByParentJobId (string) – This is a filter to list child (nested) jobs based on parent job ID.
ByMessageCategory (string) –
This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS.

View Monitoring for a list of accepted strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

Return type:

dict

Returns:

Response Syntax

{
    'CopyJobs': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- CopyJobs (list) –
  
  An array of structures containing metadata about your copy jobs returned in JSON format.
  - (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: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: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) –
      
      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.
    - NumberOfChildJobs (integer) –
      
      This is the number of child (nested) copy jobs.
    - ChildJobsInState (dict) –
      
      This returns the statistics of the included child (nested) copy jobs.
      - (string) –
        
        (integer) –
    - ResourceName (string) –
      
      This is 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
- NextToken (string) –
  
  The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Exceptions

Backup.Client.exceptions.InvalidParameterValueException
Backup.Client.exceptions.ServiceUnavailableException