aws_sdk_backup/client/

list_scan_jobs.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListScanJobs`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`by_account_id(impl Into<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_account_id) / [`set_by_account_id(Option<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::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 Amazon Web Services Organizations management account, passing <code>*</code> returns all jobs across the organization.</p> <p>Pattern: <code>^\[0-9\]{12}$</code></p><br>
    ///   - [`by_backup_vault_name(impl Into<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_backup_vault_name) / [`set_by_backup_vault_name(Option<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::set_by_backup_vault_name):<br>required: **false**<br><p>Returns only scan 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.</p> <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{2,50}$</code></p><br>
    ///   - [`by_complete_after(DateTime)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_complete_after) / [`set_by_complete_after(Option<DateTime>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::set_by_complete_after):<br>required: **false**<br><p>Returns only scan jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).</p><br>
    ///   - [`by_complete_before(DateTime)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_complete_before) / [`set_by_complete_before(Option<DateTime>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::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_malware_scanner(MalwareScanner)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_malware_scanner) / [`set_by_malware_scanner(Option<MalwareScanner>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::set_by_malware_scanner):<br>required: **false**<br><p>Returns only the scan jobs for the specified malware scanner. Currently only supports <code>GUARDDUTY</code>.</p><br>
    ///   - [`by_recovery_point_arn(impl Into<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_recovery_point_arn) / [`set_by_recovery_point_arn(Option<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::set_by_recovery_point_arn):<br>required: **false**<br><p>Returns only the scan jobs that are ran against the specified recovery point.</p><br>
    ///   - [`by_resource_arn(impl Into<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_resource_arn) / [`set_by_resource_arn(Option<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::set_by_resource_arn):<br>required: **false**<br><p>Returns only scan jobs that match the specified resource Amazon Resource Name (ARN).</p><br>
    ///   - [`by_resource_type(ScanResourceType)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_resource_type) / [`set_by_resource_type(Option<ScanResourceType>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::set_by_resource_type):<br>required: **false**<br><p>Returns restore testing selections by the specified restore testing plan name.</p> <ul>  <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>S3</code>for Amazon Simple Storage Service (Amazon S3)</p></li> </ul> <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{1,50}$</code></p><br>
    ///   - [`by_scan_result_status(ScanResultStatus)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_scan_result_status) / [`set_by_scan_result_status(Option<ScanResultStatus>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::set_by_scan_result_status):<br>required: **false**<br><p>Returns only the scan jobs for the specified scan results:</p> <ul>  <li>   <p><code>THREATS_FOUND</code></p></li>  <li>   <p><code>NO_THREATS_FOUND</code></p></li> </ul><br>
    ///   - [`by_state(ScanState)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::by_state) / [`set_by_state(Option<ScanState>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::set_by_state):<br>required: **false**<br><p>Returns only the scan jobs for the specified scanning job state.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to be returned.</p> <p>Valid Range: Minimum value of 1. Maximum value of 1000.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::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>
    /// - On success, responds with [`ListScanJobsOutput`](crate::operation::list_scan_jobs::ListScanJobsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_scan_jobs::ListScanJobsOutput::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>
    ///   - [`scan_jobs(Vec::<ScanJob>)`](crate::operation::list_scan_jobs::ListScanJobsOutput::scan_jobs): <p>An array of structures containing metadata about your scan jobs returned in JSON format.</p>
    /// - On failure, responds with [`SdkError<ListScanJobsError>`](crate::operation::list_scan_jobs::ListScanJobsError)
    pub fn list_scan_jobs(&self) -> crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder {
        crate::operation::list_scan_jobs::builders::ListScanJobsFluentBuilder::new(self.handle.clone())
    }
}