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",
  by_account_id: "AccountId",
  by_complete_after: Time.now,
  by_complete_before: Time.now,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#by_account_idString

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

If used from an Organizations management account, passing * returns all jobs across the organization.

Returns:

  • (String)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end

#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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

  • (String)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end

#by_complete_afterTime

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

Returns:

  • (Time)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end

#by_complete_beforeTime

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

Returns:

  • (Time)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end

#by_created_afterTime

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

Returns:

  • (Time)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end

#by_created_beforeTime

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

Returns:

  • (Time)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end

#by_resource_arnString

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

Returns:

  • (String)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end

#by_resource_typeString

Returns only backup jobs for the specified resources:

  • Aurora for Amazon Aurora

  • 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

  • Storage Gateway for Storage Gateway

  • S3 for Amazon S3

  • VirtualMachine for virtual machines

Returns:

  • (String)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end

#by_stateString

Returns only backup jobs that are in the specified state.

Returns:

  • (String)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of items to be returned.

Returns:

  • (Integer)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  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)


3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3894

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,
  :by_account_id,
  :by_complete_after,
  :by_complete_before)
  SENSITIVE = []
  include Aws::Structure
end