aws_sdk_cloudformation/client/
list_resource_scans.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListResourceScans`](crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder::set_next_token):<br>required: **false**<br><p>A string that identifies the next page of resource scan results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder::set_max_results):<br>required: **false**<br><p>If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can use for the <code>NextToken</code> parameter to get the next set of results. The default value is 10. The maximum value is 100.</p><br>
9    ///   - [`scan_type_filter(ScanType)`](crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder::scan_type_filter) / [`set_scan_type_filter(Option<ScanType>)`](crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder::set_scan_type_filter):<br>required: **false**<br><p>The scan type that you want to get summary information about. The default is <code>FULL</code>.</p><br>
10    /// - On success, responds with [`ListResourceScansOutput`](crate::operation::list_resource_scans::ListResourceScansOutput) with field(s):
11    ///   - [`resource_scan_summaries(Option<Vec::<ResourceScanSummary>>)`](crate::operation::list_resource_scans::ListResourceScansOutput::resource_scan_summaries): <p>The list of scans returned.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_resource_scans::ListResourceScansOutput::next_token): <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListResourceScans</code> again and use that value for the <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to an empty string.</p>
13    /// - On failure, responds with [`SdkError<ListResourceScansError>`](crate::operation::list_resource_scans::ListResourceScansError)
14    pub fn list_resource_scans(&self) -> crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder {
15        crate::operation::list_resource_scans::builders::ListResourceScansFluentBuilder::new(self.handle.clone())
16    }
17}