aws_sdk_ec2/client/describe_network_insights_analyses.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 [`DescribeNetworkInsightsAnalyses`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`network_insights_analysis_ids(impl Into<String>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::network_insights_analysis_ids) / [`set_network_insights_analysis_ids(Option<Vec::<String>>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::set_network_insights_analysis_ids):<br>required: **false**<br><p>The ID of the network insights analyses. You must specify either analysis IDs or a path ID.</p><br>
8 /// - [`network_insights_path_id(impl Into<String>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::network_insights_path_id) / [`set_network_insights_path_id(Option<String>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::set_network_insights_path_id):<br>required: **false**<br><p>The ID of the path. You must specify either a path ID or analysis IDs.</p><br>
9 /// - [`analysis_start_time(DateTime)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::analysis_start_time) / [`set_analysis_start_time(Option<DateTime>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::set_analysis_start_time):<br>required: **false**<br><p>The time when the network insights analyses started.</p><br>
10 /// - [`analysis_end_time(DateTime)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::analysis_end_time) / [`set_analysis_end_time(Option<DateTime>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::set_analysis_end_time):<br>required: **false**<br><p>The time when the network insights analyses ended.</p><br>
11 /// - [`filters(Filter)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::set_filters):<br>required: **false**<br><p>The filters. The following are the possible values:</p> <ul> <li> <p>path-found - A Boolean value that indicates whether a feasible path is found.</p></li> <li> <p>status - The status of the analysis (running | succeeded | failed).</p></li> </ul><br>
12 /// - [`max_results(i32)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p><br>
13 /// - [`dry_run(bool)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
14 /// - [`next_token(impl Into<String>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
15 /// - On success, responds with [`DescribeNetworkInsightsAnalysesOutput`](crate::operation::describe_network_insights_analyses::DescribeNetworkInsightsAnalysesOutput) with field(s):
16 /// - [`network_insights_analyses(Option<Vec::<NetworkInsightsAnalysis>>)`](crate::operation::describe_network_insights_analyses::DescribeNetworkInsightsAnalysesOutput::network_insights_analyses): <p>Information about the network insights analyses.</p>
17 /// - [`next_token(Option<String>)`](crate::operation::describe_network_insights_analyses::DescribeNetworkInsightsAnalysesOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
18 /// - On failure, responds with [`SdkError<DescribeNetworkInsightsAnalysesError>`](crate::operation::describe_network_insights_analyses::DescribeNetworkInsightsAnalysesError)
19 pub fn describe_network_insights_analyses(
20 &self,
21 ) -> crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder {
22 crate::operation::describe_network_insights_analyses::builders::DescribeNetworkInsightsAnalysesFluentBuilder::new(self.handle.clone())
23 }
24}