aws-sdk-networkfirewall 1.109.0

AWS SDK for AWS Network Firewall
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListAnalysisReports`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`firewall_name(impl Into<String>)`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::firewall_name) / [`set_firewall_name(Option<String>)`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::set_firewall_name):<br>required: **false**<br><p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`firewall_arn(impl Into<String>)`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::firewall_arn) / [`set_firewall_arn(Option<String>)`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::set_firewall_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::set_next_token):<br>required: **false**<br><p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p><br>
    /// - On success, responds with [`ListAnalysisReportsOutput`](crate::operation::list_analysis_reports::ListAnalysisReportsOutput) with field(s):
    ///   - [`analysis_reports(Option<Vec::<AnalysisReport>>)`](crate::operation::list_analysis_reports::ListAnalysisReportsOutput::analysis_reports): <p>The <code>id</code> and <code>ReportTime</code> associated with a requested analysis report. Does not provide the status of the analysis report.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_analysis_reports::ListAnalysisReportsOutput::next_token): <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
    /// - On failure, responds with [`SdkError<ListAnalysisReportsError>`](crate::operation::list_analysis_reports::ListAnalysisReportsError)
    pub fn list_analysis_reports(&self) -> crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder {
        crate::operation::list_analysis_reports::builders::ListAnalysisReportsFluentBuilder::new(self.handle.clone())
    }
}