aws_sdk_backup/client/

list_scan_job_summaries.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListScanJobSummaries`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`account_id(impl Into<String>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::set_account_id):<br>required: **false**<br><p>Returns the job count for the specified account.</p> <p>If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.</p> <p>Root, admin, and delegated administrator accounts can use the value <code>ANY</code> to return job counts from every account in the organization.</p> <p><code>AGGREGATE_ALL</code> aggregates job counts from all accounts within the authenticated organization, then returns the sum.</p><br>
    ///   - [`resource_type(impl Into<String>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::resource_type) / [`set_resource_type(Option<String>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::set_resource_type):<br>required: **false**<br><p>Returns the job count for the specified resource type. Use request <code>GetSupportedResourceTypes</code> to obtain strings for supported resource types.</p> <p>The the value <code>ANY</code> returns count of all resource types.</p> <p><code>AGGREGATE_ALL</code> aggregates job counts for all resource types and returns the sum.</p><br>
    ///   - [`malware_scanner(MalwareScanner)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::malware_scanner) / [`set_malware_scanner(Option<MalwareScanner>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::set_malware_scanner):<br>required: **false**<br><p>Returns only the scan jobs for the specified malware scanner. Currently the only MalwareScanner is <code>GUARDDUTY</code>. But the field also supports <code>ANY</code>, and <code>AGGREGATE_ALL</code>.</p><br>
    ///   - [`scan_result_status(ScanResultStatus)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::scan_result_status) / [`set_scan_result_status(Option<ScanResultStatus>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::set_scan_result_status):<br>required: **false**<br><p>Returns only the scan jobs for the specified scan results.</p><br>
    ///   - [`state(ScanJobStatus)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::state) / [`set_state(Option<ScanJobStatus>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::set_state):<br>required: **false**<br><p>Returns only the scan jobs for the specified scanning job state.</p><br>
    ///   - [`aggregation_period(AggregationPeriod)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::aggregation_period) / [`set_aggregation_period(Option<AggregationPeriod>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::set_aggregation_period):<br>required: **false**<br><p>The period for the returned results.</p> <ul>  <li>   <p><code>ONE_DAY</code>The daily job count for the prior 1 day.</p></li>  <li>   <p><code>SEVEN_DAYS</code>The daily job count for the prior 7 days.</p></li>  <li>   <p><code>FOURTEEN_DAYS</code>The daily job count for the prior 14 days.</p></li> </ul><br>
    ///   - [`max_results(i32)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to be returned.</p> <p>The value is an integer. Range of accepted values is from 1 to 500.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::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 [`ListScanJobSummariesOutput`](crate::operation::list_scan_job_summaries::ListScanJobSummariesOutput) with field(s):
    ///   - [`scan_job_summaries(Option<Vec::<ScanJobSummary>>)`](crate::operation::list_scan_job_summaries::ListScanJobSummariesOutput::scan_job_summaries): <p>The summary information.</p>
    ///   - [`aggregation_period(Option<String>)`](crate::operation::list_scan_job_summaries::ListScanJobSummariesOutput::aggregation_period): <p>The period for the returned results.</p> <ul>  <li>   <p><code>ONE_DAY</code>The daily job count for the prior 1 day.</p></li>  <li>   <p><code>SEVEN_DAYS</code>The daily job count for the prior 7 days.</p></li>  <li>   <p><code>FOURTEEN_DAYS</code>The daily job count for the prior 14 days.</p></li> </ul> <p>Valid Values: <code>'ONE_DAY'</code> | <code>'SEVEN_DAYS'</code> | <code>'FOURTEEN_DAYS'</code></p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_scan_job_summaries::ListScanJobSummariesOutput::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<ListScanJobSummariesError>`](crate::operation::list_scan_job_summaries::ListScanJobSummariesError)
    pub fn list_scan_job_summaries(&self) -> crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder {
        crate::operation::list_scan_job_summaries::builders::ListScanJobSummariesFluentBuilder::new(self.handle.clone())
    }
}