Class: Aws::Backup::Types::ListCopyJobsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#by_account_idString

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

Returns:

  • (String)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_complete_afterTime

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

Returns:

  • (Time)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_complete_beforeTime

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

Returns:

  • (Time)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_created_afterTime

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

Returns:

  • (Time)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_created_beforeTime

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

Returns:

  • (Time)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_destination_vault_arnString

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.

Returns:

  • (String)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_message_categoryString

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.

Returns:

  • (String)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_parent_job_idString

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

Returns:

  • (String)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_resource_arnString

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

Returns:

  • (String)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_resource_typeString

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

  • 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

Returns:

  • (String)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#by_stateString

Returns only copy jobs that are in the specified state.

Returns:

  • (String)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of items to be returned.

Returns:

  • (Integer)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5187

class ListCopyJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_created_before,
  :by_created_after,
  :by_resource_type,
  :by_destination_vault_arn,
  :by_account_id,
  :by_complete_before,
  :by_complete_after,
  :by_parent_job_id,
  :by_message_category)
  SENSITIVE = []
  include Aws::Structure
end