aws_sdk_iot/client/
get_thing_connectivity_data.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 [`GetThingConnectivityData`](crate::operation::get_thing_connectivity_data::builders::GetThingConnectivityDataFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`thing_name(impl Into<String>)`](crate::operation::get_thing_connectivity_data::builders::GetThingConnectivityDataFluentBuilder::thing_name) / [`set_thing_name(Option<String>)`](crate::operation::get_thing_connectivity_data::builders::GetThingConnectivityDataFluentBuilder::set_thing_name):<br>required: **true**<br><p>The name of your IoT thing.</p><br>
7    ///   - [`include_socket_information(bool)`](crate::operation::get_thing_connectivity_data::builders::GetThingConnectivityDataFluentBuilder::include_socket_information) / [`set_include_socket_information(Option<bool>)`](crate::operation::get_thing_connectivity_data::builders::GetThingConnectivityDataFluentBuilder::set_include_socket_information):<br>required: **false**<br><p>Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp, vpcEndpointId) should be included in the GetThingConnectivityData response. Set to <code>true</code> to include socket information. Set to <code>false</code> to omit socket information. By default, this is set to <code>false</code>.</p><br>
8    /// - On success, responds with [`GetThingConnectivityDataOutput`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput) with field(s):
9    ///   - [`thing_name(Option<String>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::thing_name): <p>The name of your IoT thing.</p>
10    ///   - [`connected(Option<bool>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::connected): <p>A Boolean that indicates the connectivity status.</p>
11    ///   - [`timestamp(Option<DateTime>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::timestamp): <p>The timestamp of when the device connected or disconnected.</p>
12    ///   - [`disconnect_reason(Option<DisconnectReasonValue>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::disconnect_reason): <p>The reason that the client is disconnected.</p>
13    ///   - [`source_ip(Option<String>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::source_ip): <p>The IP address of the client that initiated the connection.</p>
14    ///   - [`source_port(Option<i32>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::source_port): <p>The client's source port.</p>
15    ///   - [`target_ip(Option<String>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::target_ip): <p>The IP address of the Amazon Web Services IoT Core endpoint that the client connected to.</p>
16    ///   - [`target_port(Option<i32>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::target_port): <p>The port number of the Amazon Web Services IoT Core endpoint that the client connected to.</p>
17    ///   - [`vpc_endpoint_id(Option<String>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::vpc_endpoint_id): <p>The ID of the VPC endpoint. Present for clients connected to Amazon Web Services IoT Core via a VPC endpoint.</p>
18    ///   - [`keep_alive_duration(Option<i32>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::keep_alive_duration): <p>The keep-alive interval in seconds that the client specified when establishing the connection.</p>
19    ///   - [`clean_session(Option<bool>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::clean_session): <p>Indicates whether the client is using a clean session. Returns <code>true</code> for clean sessions.</p>
20    ///   - [`session_expiry(Option<i64>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::session_expiry): <p>The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects.</p>
21    ///   - [`client_id(Option<String>)`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataOutput::client_id): <p>The unique identifier of the MQTT client.</p>
22    /// - On failure, responds with [`SdkError<GetThingConnectivityDataError>`](crate::operation::get_thing_connectivity_data::GetThingConnectivityDataError)
23    pub fn get_thing_connectivity_data(&self) -> crate::operation::get_thing_connectivity_data::builders::GetThingConnectivityDataFluentBuilder {
24        crate::operation::get_thing_connectivity_data::builders::GetThingConnectivityDataFluentBuilder::new(self.handle.clone())
25    }
26}
aws_sdk_iot/client/get_thing_connectivity_data.rs

aws_sdk_iot/client/
get_thing_connectivity_data.rs
