aws_sdk_guardduty/client/
describe_malware_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 [`DescribeMalwareScans`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`detector_id(impl Into<String>)`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::detector_id) / [`set_detector_id(Option<String>)`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::set_detector_id):<br>required: **true**<br><p>The unique ID of the detector that the request is associated with.</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::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::set_next_token):<br>required: **false**<br><p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::set_max_results):<br>required: **false**<br><p>You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.</p><br>
10    ///   - [`filter_criteria(FilterCriteria)`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::filter_criteria) / [`set_filter_criteria(Option<FilterCriteria>)`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::set_filter_criteria):<br>required: **false**<br><p>Represents the criteria to be used in the filter for describing scan entries.</p><br>
11    ///   - [`sort_criteria(SortCriteria)`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::sort_criteria) / [`set_sort_criteria(Option<SortCriteria>)`](crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::set_sort_criteria):<br>required: **false**<br><p>Represents the criteria used for sorting scan entries. The <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_SortCriteria.html#guardduty-Type-SortCriteria-attributeName"> <code>attributeName</code> </a> is required and it must be <code>scanStartTime</code>.</p><br>
12    /// - On success, responds with [`DescribeMalwareScansOutput`](crate::operation::describe_malware_scans::DescribeMalwareScansOutput) with field(s):
13    ///   - [`scans(Option<Vec::<Scan>>)`](crate::operation::describe_malware_scans::DescribeMalwareScansOutput::scans): <p>Contains information about malware scans associated with GuardDuty Malware Protection for EC2.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_malware_scans::DescribeMalwareScansOutput::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<DescribeMalwareScansError>`](crate::operation::describe_malware_scans::DescribeMalwareScansError)
16    pub fn describe_malware_scans(&self) -> crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder {
17        crate::operation::describe_malware_scans::builders::DescribeMalwareScansFluentBuilder::new(self.handle.clone())
18    }
19}