backup_list_copy_jobs: Returns metadata about your copy jobs

Description

Returns metadata about your copy jobs.

Usage

backup_list_copy_jobs(NextToken, MaxResults, ByResourceArn, ByState,
  ByCreatedBefore, ByCreatedAfter, ByResourceType, ByDestinationVaultArn,
  ByAccountId)

Value

A list with the following syntax:

list(
  CopyJobs = list(
    list(
      AccountId = "string",
      CopyJobId = "string",
      SourceBackupVaultArn = "string",
      SourceRecoveryPointArn = "string",
      DestinationBackupVaultArn = "string",
      DestinationRecoveryPointArn = "string",
      ResourceArn = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      CompletionDate = as.POSIXct(
        "2015-01-01"
      ),
      State = "CREATED"|"RUNNING"|"COMPLETED"|"FAILED",
      StatusMessage = "string",
      BackupSizeInBytes = 123,
      IamRoleArn = "string",
      CreatedBy = list(
        BackupPlanId = "string",
        BackupPlanArn = "string",
        BackupPlanVersion = "string",
        BackupRuleId = "string"
      ),
      ResourceType = "string"
    )
  ),
  NextToken = "string"
)

Arguments

NextToken

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

The maximum number of items to be returned.

ByResourceArn

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

ByState

Returns only copy jobs that are in the specified state.

ByCreatedBefore

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

ByCreatedAfter

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

ByResourceType

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

ByDestinationVaultArn

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

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

Request syntax

svc$list_copy_jobs(
  NextToken = "string",
  MaxResults = 123,
  ByResourceArn = "string",
  ByState = "CREATED"|"RUNNING"|"COMPLETED"|"FAILED",
  ByCreatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  ByCreatedAfter = as.POSIXct(
    "2015-01-01"
  ),
  ByResourceType = "string",
  ByDestinationVaultArn = "string",
  ByAccountId = "string"
)