Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . backup ]

list-copy-jobs

Description

Returns metadata about your copy jobs.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-copy-jobs
[--next-token <value>]
[--max-results <value>]
[--by-resource-arn <value>]
[--by-state <value>]
[--by-created-before <value>]
[--by-created-after <value>]
[--by-resource-type <value>]
[--by-destination-vault-arn <value>]
[--by-account-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--next-token (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.

--max-results (integer)

The maximum number of items to be returned.

--by-resource-arn (string)

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

--by-state (string)

Returns only copy jobs that are in the specified state.

Possible values:

  • CREATED
  • RUNNING
  • COMPLETED
  • FAILED

--by-created-before (timestamp)

Returns only copy jobs that were created before the specified date.

--by-created-after (timestamp)

Returns only copy jobs that were created after the specified date.

--by-resource-type (string)

Returns only backup jobs for the specified resources:

  • DynamoDB for Amazon DynamoDB
  • EBS for Amazon Elastic Block Store
  • EC2 for Amazon Elastic Compute Cloud
  • EFS for Amazon Elastic File System
  • RDS for Amazon Relational Database Service
  • Storage Gateway for AWS Storage Gateway

--by-destination-vault-arn (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 .

--by-account-id (string)

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

CopyJobs -> (list)

An array of structures containing metadata about your copy jobs returned in JSON format.

(structure)

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 AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

CreationDate -> (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.

CompletionDate -> (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.

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 -> (long)

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 -> (structure)

Contains information about the backup plan and rule that AWS 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 AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

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.