aws_sdk_iotsecuretunneling/client/
open_tunnel.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 [`OpenTunnel`](crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`description(impl Into<String>)`](crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder::set_description):<br>required: **false**<br><p>A short text description of the tunnel.</p><br>
7    ///   - [`tags(Tag)`](crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder::set_tags):<br>required: **false**<br><p>A collection of tag metadata.</p><br>
8    ///   - [`destination_config(DestinationConfig)`](crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder::destination_config) / [`set_destination_config(Option<DestinationConfig>)`](crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder::set_destination_config):<br>required: **false**<br><p>The destination configuration for the OpenTunnel request.</p><br>
9    ///   - [`timeout_config(TimeoutConfig)`](crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder::timeout_config) / [`set_timeout_config(Option<TimeoutConfig>)`](crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder::set_timeout_config):<br>required: **false**<br><p>Timeout configuration for a tunnel.</p><br>
10    /// - On success, responds with [`OpenTunnelOutput`](crate::operation::open_tunnel::OpenTunnelOutput) with field(s):
11    ///   - [`tunnel_id(Option<String>)`](crate::operation::open_tunnel::OpenTunnelOutput::tunnel_id): <p>A unique alpha-numeric tunnel ID.</p>
12    ///   - [`tunnel_arn(Option<String>)`](crate::operation::open_tunnel::OpenTunnelOutput::tunnel_arn): <p>The Amazon Resource Name for the tunnel.</p>
13    ///   - [`source_access_token(Option<String>)`](crate::operation::open_tunnel::OpenTunnelOutput::source_access_token): <p>The access token the source local proxy uses to connect to IoT Secure Tunneling.</p>
14    ///   - [`destination_access_token(Option<String>)`](crate::operation::open_tunnel::OpenTunnelOutput::destination_access_token): <p>The access token the destination local proxy uses to connect to IoT Secure Tunneling.</p>
15    /// - On failure, responds with [`SdkError<OpenTunnelError>`](crate::operation::open_tunnel::OpenTunnelError)
16    pub fn open_tunnel(&self) -> crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder {
17        crate::operation::open_tunnel::builders::OpenTunnelFluentBuilder::new(self.handle.clone())
18    }
19}