aws_sdk_networkmanager/client/
start_route_analysis.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 [`StartRouteAnalysis`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`global_network_id(impl Into<String>)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::global_network_id) / [`set_global_network_id(Option<String>)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::set_global_network_id):<br>required: **true**<br><p>The ID of the global network.</p><br>
7    ///   - [`source(RouteAnalysisEndpointOptionsSpecification)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::source) / [`set_source(Option<RouteAnalysisEndpointOptionsSpecification>)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::set_source):<br>required: **true**<br><p>The source from which traffic originates.</p><br>
8    ///   - [`destination(RouteAnalysisEndpointOptionsSpecification)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::destination) / [`set_destination(Option<RouteAnalysisEndpointOptionsSpecification>)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::set_destination):<br>required: **true**<br><p>The destination.</p><br>
9    ///   - [`include_return_path(bool)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::include_return_path) / [`set_include_return_path(Option<bool>)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::set_include_return_path):<br>required: **false**<br><p>Indicates whether to analyze the return path. The default is <code>false</code>.</p><br>
10    ///   - [`use_middleboxes(bool)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::use_middleboxes) / [`set_use_middleboxes(Option<bool>)`](crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::set_use_middleboxes):<br>required: **false**<br><p>Indicates whether to include the location of middlebox appliances in the route analysis. The default is <code>false</code>.</p><br>
11    /// - On success, responds with [`StartRouteAnalysisOutput`](crate::operation::start_route_analysis::StartRouteAnalysisOutput) with field(s):
12    ///   - [`route_analysis(Option<RouteAnalysis>)`](crate::operation::start_route_analysis::StartRouteAnalysisOutput::route_analysis): <p>The route analysis.</p>
13    /// - On failure, responds with [`SdkError<StartRouteAnalysisError>`](crate::operation::start_route_analysis::StartRouteAnalysisError)
14    pub fn start_route_analysis(&self) -> crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder {
15        crate::operation::start_route_analysis::builders::StartRouteAnalysisFluentBuilder::new(self.handle.clone())
16    }
17}