aws_sdk_networkfirewall/client/

get_analysis_report_results.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetAnalysisReportResults`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`firewall_name(impl Into<String>)`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::firewall_name) / [`set_firewall_name(Option<String>)`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::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>
    ///   - [`analysis_report_id(impl Into<String>)`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::analysis_report_id) / [`set_analysis_report_id(Option<String>)`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::set_analysis_report_id):<br>required: **true**<br><p>The unique ID of the query that ran when you requested an analysis report.</p><br>
    ///   - [`firewall_arn(impl Into<String>)`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::firewall_arn) / [`set_firewall_arn(Option<String>)`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::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::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::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::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::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 [`GetAnalysisReportResultsOutput`](crate::operation::get_analysis_report_results::GetAnalysisReportResultsOutput) with field(s):
    ///   - [`status(Option<String>)`](crate::operation::get_analysis_report_results::GetAnalysisReportResultsOutput::status): <p>The status of the analysis report you specify. Statuses include <code>RUNNING</code>, <code>COMPLETED</code>, or <code>FAILED</code>.</p>
    ///   - [`start_time(Option<DateTime>)`](crate::operation::get_analysis_report_results::GetAnalysisReportResultsOutput::start_time): <p>The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>
    ///   - [`end_time(Option<DateTime>)`](crate::operation::get_analysis_report_results::GetAnalysisReportResultsOutput::end_time): <p>The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, <code>YYYY-MM-DDTHH:MM:SSZ</code>).</p>
    ///   - [`report_time(Option<DateTime>)`](crate::operation::get_analysis_report_results::GetAnalysisReportResultsOutput::report_time): <p>The date and time the analysis report was ran.</p>
    ///   - [`analysis_type(Option<EnabledAnalysisType>)`](crate::operation::get_analysis_report_results::GetAnalysisReportResultsOutput::analysis_type): <p>The type of traffic that will be used to generate a report.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_analysis_report_results::GetAnalysisReportResultsOutput::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>
    ///   - [`analysis_report_results(Option<Vec::<AnalysisTypeReportResult>>)`](crate::operation::get_analysis_report_results::GetAnalysisReportResultsOutput::analysis_report_results): <p>Retrieves the results of a traffic analysis report.</p>
    /// - On failure, responds with [`SdkError<GetAnalysisReportResultsError>`](crate::operation::get_analysis_report_results::GetAnalysisReportResultsError)
    pub fn get_analysis_report_results(&self) -> crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder {
        crate::operation::get_analysis_report_results::builders::GetAnalysisReportResultsFluentBuilder::new(self.handle.clone())
    }
}