You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Backup::Types::ListBackupJobsInput

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

Overview

Note:

When making an API call, you may pass ListBackupJobsInput data as a hash:

{
  next_token: "string",
  max_results: 1,
  by_resource_arn: "ARN",
  by_state: "CREATED", # accepts CREATED, PENDING, RUNNING, ABORTING, ABORTED, COMPLETED, FAILED, EXPIRED
  by_backup_vault_name: "BackupVaultName",
  by_created_before: Time.now,
  by_created_after: Time.now,
  by_resource_type: "ResourceType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#by_backup_vault_nameString

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

  • (String)


2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2208

class ListBackupJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_backup_vault_name,
  :by_created_before,
  :by_created_after,
  :by_resource_type)
  include Aws::Structure
end

#by_created_afterTime

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

Returns:

  • (Time)


2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2208

class ListBackupJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_backup_vault_name,
  :by_created_before,
  :by_created_after,
  :by_resource_type)
  include Aws::Structure
end

#by_created_beforeTime

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

Returns:

  • (Time)


2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2208

class ListBackupJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_backup_vault_name,
  :by_created_before,
  :by_created_after,
  :by_resource_type)
  include Aws::Structure
end

#by_resource_arnString

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

Returns:

  • (String)


2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2208

class ListBackupJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_backup_vault_name,
  :by_created_before,
  :by_created_after,
  :by_resource_type)
  include Aws::Structure
end

#by_resource_typeString

Returns only backup jobs for the specified resources:

  • EBS for Amazon Elastic Block Store

  • SGW for AWS Storage Gateway

  • RDS for Amazon Relational Database Service

  • DDB for Amazon DynamoDB

  • EFS for Amazon Elastic File System

Returns:

  • (String)


2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2208

class ListBackupJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_backup_vault_name,
  :by_created_before,
  :by_created_after,
  :by_resource_type)
  include Aws::Structure
end

#by_stateString

Returns only backup jobs that are in the specified state.

Returns:

  • (String)


2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2208

class ListBackupJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_backup_vault_name,
  :by_created_before,
  :by_created_after,
  :by_resource_type)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of items to be returned.

Returns:

  • (Integer)


2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2208

class ListBackupJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_backup_vault_name,
  :by_created_before,
  :by_created_after,
  :by_resource_type)
  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)


2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2208

class ListBackupJobsInput < Struct.new(
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_state,
  :by_backup_vault_name,
  :by_created_before,
  :by_created_after,
  :by_resource_type)
  include Aws::Structure
end