AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListCopyJobs operation. Returns metadata about your copy jobs.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Backup.AmazonBackupRequest
      Amazon.Backup.Model.ListCopyJobsRequest

Namespace: Amazon.Backup.Model
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z

Syntax

C#
public class ListCopyJobsRequest : AmazonBackupRequest
         IAmazonWebServiceRequest

The ListCopyJobsRequest type exposes the following members

Constructors

NameDescription
Public Method ListCopyJobsRequest()

Properties

NameTypeDescription
Public Property ByAccountId System.String

Gets and sets the property ByAccountId.

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

Public Property ByCompleteAfter System.DateTime

Gets and sets the property ByCompleteAfter.

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

Public Property ByCompleteBefore System.DateTime

Gets and sets the property ByCompleteBefore.

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

Public Property ByCreatedAfter System.DateTime

Gets and sets the property ByCreatedAfter.

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

Public Property ByCreatedBefore System.DateTime

Gets and sets the property ByCreatedBefore.

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

Public Property ByDestinationVaultArn System.String

Gets and sets the property 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.

Public Property ByMessageCategory System.String

Gets and sets the property 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.

Public Property ByParentJobId System.String

Gets and sets the property ByParentJobId.

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

Public Property ByResourceArn System.String

Gets and sets the property ByResourceArn.

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

Public Property ByResourceType System.String

Gets and sets the property 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

  • 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

Public Property ByState Amazon.Backup.CopyJobState

Gets and sets the property ByState.

Returns only copy jobs that are in the specified state.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of items to be returned.

Public Property NextToken System.String

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5