1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListBackupJobs`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>The next item following a partial list of returned items. For example, if a request is made to return <code>MaxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to be returned.</p><br>
    ///   - [`by_resource_arn(impl Into<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_resource_arn) / [`set_by_resource_arn(Option<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_resource_arn):<br>required: **false**<br><p>Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).</p><br>
    ///   - [`by_state(BackupJobState)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_state) / [`set_by_state(Option<BackupJobState>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_state):<br>required: **false**<br><p>Returns only backup jobs that are in the specified state.</p> <p><code>Completed with issues</code> is a status found only in the Backup console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the status is completed but comes with a status message.</p> <p>To obtain the job count for <code>Completed with issues</code>, run two GET requests, and subtract the second, smaller number:</p> <p>GET /backup-jobs/?state=COMPLETED</p> <p>GET /backup-jobs/?messageCategory=SUCCESS&amp;state=COMPLETED</p><br>
    ///   - [`by_backup_vault_name(impl Into<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_backup_vault_name) / [`set_by_backup_vault_name(Option<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_backup_vault_name):<br>required: **false**<br><p>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.</p><br>
    ///   - [`by_created_before(DateTime)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_created_before) / [`set_by_created_before(Option<DateTime>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_created_before):<br>required: **false**<br><p>Returns only backup jobs that were created before the specified date.</p><br>
    ///   - [`by_created_after(DateTime)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_created_after) / [`set_by_created_after(Option<DateTime>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_created_after):<br>required: **false**<br><p>Returns only backup jobs that were created after the specified date.</p><br>
    ///   - [`by_resource_type(impl Into<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_resource_type) / [`set_by_resource_type(Option<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_resource_type):<br>required: **false**<br><p>Returns only backup jobs for the specified resources:</p> <ul>  <li>   <p><code>Aurora</code> for Amazon Aurora</p></li>  <li>   <p><code>CloudFormation</code> for CloudFormation</p></li>  <li>   <p><code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p></li>  <li>   <p><code>DynamoDB</code> for Amazon DynamoDB</p></li>  <li>   <p><code>EBS</code> for Amazon Elastic Block Store</p></li>  <li>   <p><code>EC2</code> for Amazon Elastic Compute Cloud</p></li>  <li>   <p><code>EFS</code> for Amazon Elastic File System</p></li>  <li>   <p><code>FSx</code> for Amazon FSx</p></li>  <li>   <p><code>Neptune</code> for Amazon Neptune</p></li>  <li>   <p><code>Redshift</code> for Amazon Redshift</p></li>  <li>   <p><code>RDS</code> for Amazon Relational Database Service</p></li>  <li>   <p><code>SAP HANA on Amazon EC2</code> for SAP HANA databases</p></li>  <li>   <p><code>Storage Gateway</code> for Storage Gateway</p></li>  <li>   <p><code>S3</code> for Amazon S3</p></li>  <li>   <p><code>Timestream</code> for Amazon Timestream</p></li>  <li>   <p><code>VirtualMachine</code> for virtual machines</p></li> </ul><br>
    ///   - [`by_account_id(impl Into<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_account_id) / [`set_by_account_id(Option<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_account_id):<br>required: **false**<br><p>The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.</p> <p>If used from an Organizations management account, passing <code>*</code> returns all jobs across the organization.</p><br>
    ///   - [`by_complete_after(DateTime)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_complete_after) / [`set_by_complete_after(Option<DateTime>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_complete_after):<br>required: **false**<br><p>Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).</p><br>
    ///   - [`by_complete_before(DateTime)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_complete_before) / [`set_by_complete_before(Option<DateTime>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_complete_before):<br>required: **false**<br><p>Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).</p><br>
    ///   - [`by_parent_job_id(impl Into<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_parent_job_id) / [`set_by_parent_job_id(Option<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_parent_job_id):<br>required: **false**<br><p>This is a filter to list child (nested) jobs based on parent job ID.</p><br>
    ///   - [`by_message_category(impl Into<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::by_message_category) / [`set_by_message_category(Option<String>)`](crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::set_by_message_category):<br>required: **false**<br><p>This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.</p> <p>Example strings may include <code>AccessDenied</code>, <code>SUCCESS</code>, <code>AGGREGATE_ALL</code>, and <code>InvalidParameters</code>.</p> <p>View <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a></p> <p>The wildcard () returns count of all message categories.</p> <p><code>AGGREGATE_ALL</code> aggregates job counts for all message categories and returns the sum.</p><br>
    /// - On success, responds with [`ListBackupJobsOutput`](crate::operation::list_backup_jobs::ListBackupJobsOutput) with field(s):
    ///   - [`backup_jobs(Option<Vec::<BackupJob>>)`](crate::operation::list_backup_jobs::ListBackupJobsOutput::backup_jobs): <p>An array of structures containing metadata about your backup jobs returned in JSON format.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_backup_jobs::ListBackupJobsOutput::next_token): <p>The next item following a partial list of returned items. For example, if a request is made to return <code>MaxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
    /// - On failure, responds with [`SdkError<ListBackupJobsError>`](crate::operation::list_backup_jobs::ListBackupJobsError)
    pub fn list_backup_jobs(&self) -> crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder {
        crate::operation::list_backup_jobs::builders::ListBackupJobsFluentBuilder::new(self.handle.clone())
    }
}