Interface ListBackupJobsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BackupRequest.Builder
,Buildable
,CopyableBuilder<ListBackupJobsRequest.Builder,
,ListBackupJobsRequest> SdkBuilder<ListBackupJobsRequest.Builder,
,ListBackupJobsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListBackupJobsRequest
-
Method Summary
Modifier and TypeMethodDescriptionbyAccountId
(String byAccountId) The account ID to list the jobs from.byBackupVaultName
(String byBackupVaultName) Returns only backup jobs that will be stored in the specified backup vault.byCompleteAfter
(Instant byCompleteAfter) Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).byCompleteBefore
(Instant byCompleteBefore) Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).byCreatedAfter
(Instant byCreatedAfter) Returns only backup jobs that were created after the specified date.byCreatedBefore
(Instant byCreatedBefore) Returns only backup jobs that were created before the specified date.byMessageCategory
(String byMessageCategory) This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.byParentJobId
(String byParentJobId) This is a filter to list child (nested) jobs based on parent job ID.byResourceArn
(String byResourceArn) Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).byResourceType
(String byResourceType) Returns only backup jobs for the specified resources:Returns only backup jobs that are in the specified state.byState
(BackupJobState byState) Returns only backup jobs that are in the specified state.maxResults
(Integer maxResults) The maximum number of items to be returned.The next item following a partial list of returned items.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.- Parameters:
nextToken
- The next item following a partial list of returned items. For example, if a request is made to returnMaxResults
number of items,NextToken
allows you to return more items in your list starting at the location pointed to by the next token.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of items to be returned.
- Parameters:
maxResults
- The maximum number of items to be returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
byResourceArn
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
- Parameters:
byResourceArn
- Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
byState
Returns only backup jobs that are in the specified state.
Completed with issues
is a status found only in the Backup console. For API, this status refers to jobs with a state ofCOMPLETED
and aMessageCategory
with a value other thanSUCCESS
; that is, the status is completed but comes with a status message.To obtain the job count for
Completed with issues
, run two GET requests, and subtract the second, smaller number:GET /backup-jobs/?state=COMPLETED
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
- Parameters:
byState
- Returns only backup jobs that are in the specified state.Completed with issues
is a status found only in the Backup console. For API, this status refers to jobs with a state ofCOMPLETED
and aMessageCategory
with a value other thanSUCCESS
; that is, the status is completed but comes with a status message.To obtain the job count for
Completed with issues
, run two GET requests, and subtract the second, smaller number:GET /backup-jobs/?state=COMPLETED
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
byState
Returns only backup jobs that are in the specified state.
Completed with issues
is a status found only in the Backup console. For API, this status refers to jobs with a state ofCOMPLETED
and aMessageCategory
with a value other thanSUCCESS
; that is, the status is completed but comes with a status message.To obtain the job count for
Completed with issues
, run two GET requests, and subtract the second, smaller number:GET /backup-jobs/?state=COMPLETED
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
- Parameters:
byState
- Returns only backup jobs that are in the specified state.Completed with issues
is a status found only in the Backup console. For API, this status refers to jobs with a state ofCOMPLETED
and aMessageCategory
with a value other thanSUCCESS
; that is, the status is completed but comes with a status message.To obtain the job count for
Completed with issues
, run two GET requests, and subtract the second, smaller number:GET /backup-jobs/?state=COMPLETED
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
byBackupVaultName
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.
- Parameters:
byBackupVaultName
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
byCreatedBefore
Returns only backup jobs that were created before the specified date.
- Parameters:
byCreatedBefore
- Returns only backup jobs that were created before the specified date.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
byCreatedAfter
Returns only backup jobs that were created after the specified date.
- Parameters:
byCreatedAfter
- Returns only backup jobs that were created after the specified date.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
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
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
byAccountId
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.- Parameters:
byAccountId
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
byCompleteAfter
Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
- Parameters:
byCompleteAfter
- Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
byCompleteBefore
Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
- Parameters:
byCompleteBefore
- Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
byParentJobId
This is a filter to list child (nested) jobs based on parent job ID.
- Parameters:
byParentJobId
- This is a filter to list child (nested) jobs based on parent job ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
, andInvalidParameters
.View Monitoring
The wildcard () returns count of all message categories.
AGGREGATE_ALL
aggregates job counts for all message categories and returns the sum.- Parameters:
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
, andInvalidParameters
.View Monitoring
The wildcard () returns count of all message categories.
AGGREGATE_ALL
aggregates job counts for all message categories and returns the sum.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListBackupJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListBackupJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-