aws_sdk_iotsecuretunneling/client/
list_tunnels.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 [`ListTunnels`](crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`thing_name(impl Into<String>)`](crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder::thing_name) / [`set_thing_name(Option<String>)`](crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder::set_thing_name):<br>required: **false**<br><p>The name of the IoT thing associated with the destination device.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return at once.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder::set_next_token):<br>required: **false**<br><p>To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.</p><br>
10    /// - On success, responds with [`ListTunnelsOutput`](crate::operation::list_tunnels::ListTunnelsOutput) with field(s):
11    ///   - [`tunnel_summaries(Option<Vec::<TunnelSummary>>)`](crate::operation::list_tunnels::ListTunnelsOutput::tunnel_summaries): <p>A short description of the tunnels in an Amazon Web Services account.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_tunnels::ListTunnelsOutput::next_token): <p>The token to use to get the next set of results, or null if there are no additional results.</p>
13    /// - On failure, responds with [`SdkError<ListTunnelsError>`](crate::operation::list_tunnels::ListTunnelsError)
14    pub fn list_tunnels(&self) -> crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder {
15        crate::operation::list_tunnels::builders::ListTunnelsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_iotsecuretunneling/client/list_tunnels.rs

aws_sdk_iotsecuretunneling/client/
list_tunnels.rs
