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, ByCompleteBefore, ByCompleteAfter, ByParentJobId,
  ByMessageCategory, BySourceRecoveryPointArn)

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:

  • 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
  • EKS for Amazon Elastic Kubernetes Service
  • FSx for Amazon FSx
  • Neptune for Amazon Neptune
  • RDS for Amazon Relational Database Service
  • Redshift for Amazon Redshift
  • S3 for Amazon Simple Storage Service (Amazon S3)
  • SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
  • Storage Gateway for Storage Gateway
  • Timestream for Amazon Timestream
  • VirtualMachine for VMware virtual machines

• 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:backup-vault:aBackupVault.

• ByAccountId

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

• ByCompleteBefore

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

• ByCompleteAfter

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

• ByParentJobId

  This is a filter to list child (nested) jobs based on parent job ID.

• ByMessageCategory

  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.

• BySourceRecoveryPointArn

  Filters copy jobs by the specified source recovery point ARN.

Value¶

A list with the following syntax:

list(
  CopyJobs = list(
    list(
      AccountId = "string",
      CopyJobId = "string",
      SourceBackupVaultArn = "string",
      SourceRecoveryPointArn = "string",
      DestinationBackupVaultArn = "string",
      DestinationVaultType = "string",
      DestinationVaultLockState = "string",
      DestinationRecoveryPointArn = "string",
      DestinationEncryptionKeyArn = "string",
      DestinationRecoveryPointLifecycle = list(
        MoveToColdStorageAfterDays = 123,
        DeleteAfterDays = 123,
        OptInToArchiveForSupportedResources = TRUE|FALSE,
        DeleteAfterEvent = "DELETE_AFTER_COPY"
      ),
      ResourceArn = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      CompletionDate = as.POSIXct(
        "2015-01-01"
      ),
      State = "CREATED"|"RUNNING"|"COMPLETED"|"FAILED"|"PARTIAL",
      StatusMessage = "string",
      BackupSizeInBytes = 123,
      IamRoleArn = "string",
      CreatedBy = list(
        BackupPlanId = "string",
        BackupPlanArn = "string",
        BackupPlanName = "string",
        BackupPlanVersion = "string",
        BackupRuleId = "string",
        BackupRuleName = "string",
        BackupRuleCron = "string",
        BackupRuleTimezone = "string"
      ),
      CreatedByBackupJobId = "string",
      ResourceType = "string",
      ParentJobId = "string",
      IsParent = TRUE|FALSE,
      CompositeMemberIdentifier = "string",
      NumberOfChildJobs = 123,
      ChildJobsInState = list(
        123
      ),
      ResourceName = "string",
      MessageCategory = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

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