aws_sdk_guardduty/client/
list_coverage.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 [`ListCoverage`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`detector_id(impl Into<String>)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::detector_id) / [`set_detector_id(Option<String>)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::set_detector_id):<br>required: **true**<br><p>The unique ID of the detector whose coverage details you want to retrieve.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the response.</p><br>
10    ///   - [`filter_criteria(CoverageFilterCriteria)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::filter_criteria) / [`set_filter_criteria(Option<CoverageFilterCriteria>)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::set_filter_criteria):<br>required: **false**<br><p>Represents the criteria used to filter the coverage details.</p><br>
11    ///   - [`sort_criteria(CoverageSortCriteria)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::sort_criteria) / [`set_sort_criteria(Option<CoverageSortCriteria>)`](crate::operation::list_coverage::builders::ListCoverageFluentBuilder::set_sort_criteria):<br>required: **false**<br><p>Represents the criteria used to sort the coverage details.</p><br>
12    /// - On success, responds with [`ListCoverageOutput`](crate::operation::list_coverage::ListCoverageOutput) with field(s):
13    ///   - [`resources(Option<Vec::<CoverageResource>>)`](crate::operation::list_coverage::ListCoverageOutput::resources): <p>A list of resources and their attributes providing cluster details.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_coverage::ListCoverageOutput::next_token): <p>The pagination parameter to be used on the next list operation to retrieve more items.</p>
15    /// - On failure, responds with [`SdkError<ListCoverageError>`](crate::operation::list_coverage::ListCoverageError)
16    pub fn list_coverage(&self) -> crate::operation::list_coverage::builders::ListCoverageFluentBuilder {
17        crate::operation::list_coverage::builders::ListCoverageFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_guardduty/client/list_coverage.rs

aws_sdk_guardduty/client/
list_coverage.rs
