[ 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.

list-copy-jobs is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: CopyJobs

Synopsis

  list-copy-jobs
[--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>]
[--by-complete-before <value>]
[--by-complete-after <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--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:

• Aurora for Amazon Aurora

• 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

• RDS for Amazon Relational Database Service

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• VirtualMachine for virtual machines

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

--by-complete-before (timestamp)

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

--by-complete-after (timestamp)

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 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 -> (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 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.

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.