aws_sdk_ec2/client/
describe_network_insights_paths.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 [`DescribeNetworkInsightsPaths`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`network_insights_path_ids(impl Into<String>)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::network_insights_path_ids) / [`set_network_insights_path_ids(Option<Vec::<String>>)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::set_network_insights_path_ids):<br>required: **false**<br><p>The IDs of the paths.</p><br>
8    ///   - [`filters(Filter)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::set_filters):<br>required: **false**<br><p>The filters. The following are the possible values:</p> <ul>  <li>   <p>destination - The ID of the resource.</p></li>  <li>   <p>filter-at-source.source-address - The source IPv4 address at the source.</p></li>  <li>   <p>filter-at-source.source-port-range - The source port range at the source.</p></li>  <li>   <p>filter-at-source.destination-address - The destination IPv4 address at the source.</p></li>  <li>   <p>filter-at-source.destination-port-range - The destination port range at the source.</p></li>  <li>   <p>filter-at-destination.source-address - The source IPv4 address at the destination.</p></li>  <li>   <p>filter-at-destination.source-port-range - The source port range at the destination.</p></li>  <li>   <p>filter-at-destination.destination-address - The destination IPv4 address at the destination.</p></li>  <li>   <p>filter-at-destination.destination-port-range - The destination port range at the destination.</p></li>  <li>   <p>protocol - The protocol.</p></li>  <li>   <p>source - The ID of the resource.</p></li> </ul><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::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>
10    ///   - [`dry_run(bool)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::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>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
12    /// - On success, responds with [`DescribeNetworkInsightsPathsOutput`](crate::operation::describe_network_insights_paths::DescribeNetworkInsightsPathsOutput) with field(s):
13    ///   - [`network_insights_paths(Option<Vec::<NetworkInsightsPath>>)`](crate::operation::describe_network_insights_paths::DescribeNetworkInsightsPathsOutput::network_insights_paths): <p>Information about the paths.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_network_insights_paths::DescribeNetworkInsightsPathsOutput::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>
15    /// - On failure, responds with [`SdkError<DescribeNetworkInsightsPathsError>`](crate::operation::describe_network_insights_paths::DescribeNetworkInsightsPathsError)
16    pub fn describe_network_insights_paths(
17        &self,
18    ) -> crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder {
19        crate::operation::describe_network_insights_paths::builders::DescribeNetworkInsightsPathsFluentBuilder::new(self.handle.clone())
20    }
21}