aws_sdk_outposts/client/
start_connection.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 [`StartConnection`](crate::operation::start_connection::builders::StartConnectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`device_serial_number(impl Into<String>)`](crate::operation::start_connection::builders::StartConnectionFluentBuilder::device_serial_number) / [`set_device_serial_number(Option<String>)`](crate::operation::start_connection::builders::StartConnectionFluentBuilder::set_device_serial_number):<br>required: **false**<br><p>The serial number of the dongle.</p><br>
7    ///   - [`asset_id(impl Into<String>)`](crate::operation::start_connection::builders::StartConnectionFluentBuilder::asset_id) / [`set_asset_id(Option<String>)`](crate::operation::start_connection::builders::StartConnectionFluentBuilder::set_asset_id):<br>required: **true**<br><p>The ID of the Outpost server.</p><br>
8    ///   - [`client_public_key(impl Into<String>)`](crate::operation::start_connection::builders::StartConnectionFluentBuilder::client_public_key) / [`set_client_public_key(Option<String>)`](crate::operation::start_connection::builders::StartConnectionFluentBuilder::set_client_public_key):<br>required: **true**<br><p>The public key of the client.</p><br>
9    ///   - [`network_interface_device_index(i32)`](crate::operation::start_connection::builders::StartConnectionFluentBuilder::network_interface_device_index) / [`set_network_interface_device_index(Option<i32>)`](crate::operation::start_connection::builders::StartConnectionFluentBuilder::set_network_interface_device_index):<br>required: **true**<br><p>The device index of the network interface on the Outpost server.</p><br>
10    /// - On success, responds with [`StartConnectionOutput`](crate::operation::start_connection::StartConnectionOutput) with field(s):
11    ///   - [`connection_id(Option<String>)`](crate::operation::start_connection::StartConnectionOutput::connection_id): <p>The ID of the connection.</p>
12    ///   - [`underlay_ip_address(Option<String>)`](crate::operation::start_connection::StartConnectionOutput::underlay_ip_address): <p>The underlay IP address.</p>
13    /// - On failure, responds with [`SdkError<StartConnectionError>`](crate::operation::start_connection::StartConnectionError)
14    pub fn start_connection(&self) -> crate::operation::start_connection::builders::StartConnectionFluentBuilder {
15        crate::operation::start_connection::builders::StartConnectionFluentBuilder::new(self.handle.clone())
16    }
17}