You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Backup::Types::ListBackupJobsInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::ListBackupJobsInput
- Defined in:
- (unknown)
Overview
When passing ListBackupJobsInput as input to an Aws::Client method, you can use a vanilla 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",
}
Instance Attribute Summary collapse
-
#by_account_id ⇒ String
The account ID to list the jobs from.
-
#by_backup_vault_name ⇒ String
Returns only backup jobs that will be stored in the specified backup vault.
-
#by_created_after ⇒ Time
Returns only backup jobs that were created after the specified date.
-
#by_created_before ⇒ Time
Returns only backup jobs that were created before the specified date.
-
#by_resource_arn ⇒ String
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
-
#by_resource_type ⇒ String
Returns only backup jobs for the specified resources:.
-
#by_state ⇒ String
Returns only backup jobs that are in the specified state.
-
#max_results ⇒ Integer
The maximum number of items to be returned.
-
#next_token ⇒ String
The next item following a partial list of returned items.
Instance Attribute Details
#by_account_id ⇒ String
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
#by_backup_vault_name ⇒ String
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.
#by_created_after ⇒ Time
Returns only backup jobs that were created after the specified date.
#by_created_before ⇒ Time
Returns only backup jobs that were created before the specified date.
#by_resource_arn ⇒ String
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
#by_resource_type ⇒ String
Returns only backup jobs for the specified resources:
DynamoDB
for Amazon DynamoDBEBS
for Amazon Elastic Block StoreEC2
for Amazon Elastic Compute CloudEFS
for Amazon Elastic File SystemRDS
for Amazon Relational Database ServiceStorage Gateway
for AWS Storage Gateway
#by_state ⇒ String
Returns only backup jobs that are in the specified state.
Possible values:
- CREATED
- PENDING
- RUNNING
- ABORTING
- ABORTED
- COMPLETED
- FAILED
- EXPIRED
#max_results ⇒ Integer
The maximum number of items to be returned.
#next_token ⇒ String
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.