Struct aws_sdk_iotsecuretunneling::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS IoT Secure Tunneling
Client for invoking operations on AWS IoT Secure Tunneling. Each operation on AWS IoT Secure Tunneling is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_iotsecuretunneling::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_iotsecuretunneling::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CloseTunnel
operation has
a Client::close_tunnel
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.close_tunnel()
.tunnel_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn close_tunnel(&self) -> CloseTunnelFluentBuilder
pub fn close_tunnel(&self) -> CloseTunnelFluentBuilder
Constructs a fluent builder for the CloseTunnel
operation.
- The fluent builder is configurable:
tunnel_id(impl Into<String>)
/set_tunnel_id(Option<String>)
:
required: trueThe ID of the tunnel to close.
delete(bool)
/set_delete(Option<bool>)
:
required: falseWhen set to true, IoT Secure Tunneling deletes the tunnel data immediately.
- On success, responds with
CloseTunnelOutput
- On failure, responds with
SdkError<CloseTunnelError>
source§impl Client
impl Client
sourcepub fn describe_tunnel(&self) -> DescribeTunnelFluentBuilder
pub fn describe_tunnel(&self) -> DescribeTunnelFluentBuilder
Constructs a fluent builder for the DescribeTunnel
operation.
- The fluent builder is configurable:
tunnel_id(impl Into<String>)
/set_tunnel_id(Option<String>)
:
required: trueThe tunnel to describe.
- On success, responds with
DescribeTunnelOutput
with field(s):tunnel(Option<Tunnel>)
:The tunnel being described.
- On failure, responds with
SdkError<DescribeTunnelError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe resource ARN.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:The tags for the specified resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn list_tunnels(&self) -> ListTunnelsFluentBuilder
pub fn list_tunnels(&self) -> ListTunnelsFluentBuilder
Constructs a fluent builder for the ListTunnels
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: falseThe name of the IoT thing associated with the destination device.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return at once.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseTo retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
- On success, responds with
ListTunnelsOutput
with field(s):tunnel_summaries(Option<Vec::<TunnelSummary>>)
:A short description of the tunnels in an Amazon Web Services account.
next_token(Option<String>)
:The token to use to get the next set of results, or null if there are no additional results.
- On failure, responds with
SdkError<ListTunnelsError>
source§impl Client
impl Client
sourcepub fn open_tunnel(&self) -> OpenTunnelFluentBuilder
pub fn open_tunnel(&self) -> OpenTunnelFluentBuilder
Constructs a fluent builder for the OpenTunnel
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA short text description of the tunnel.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA collection of tag metadata.
destination_config(DestinationConfig)
/set_destination_config(Option<DestinationConfig>)
:
required: falseThe destination configuration for the OpenTunnel request.
timeout_config(TimeoutConfig)
/set_timeout_config(Option<TimeoutConfig>)
:
required: falseTimeout configuration for a tunnel.
- On success, responds with
OpenTunnelOutput
with field(s):tunnel_id(Option<String>)
:A unique alpha-numeric tunnel ID.
tunnel_arn(Option<String>)
:The Amazon Resource Name for the tunnel.
source_access_token(Option<String>)
:The access token the source local proxy uses to connect to IoT Secure Tunneling.
destination_access_token(Option<String>)
:The access token the destination local proxy uses to connect to IoT Secure Tunneling.
- On failure, responds with
SdkError<OpenTunnelError>
source§impl Client
impl Client
sourcepub fn rotate_tunnel_access_token(&self) -> RotateTunnelAccessTokenFluentBuilder
pub fn rotate_tunnel_access_token(&self) -> RotateTunnelAccessTokenFluentBuilder
Constructs a fluent builder for the RotateTunnelAccessToken
operation.
- The fluent builder is configurable:
tunnel_id(impl Into<String>)
/set_tunnel_id(Option<String>)
:
required: trueThe tunnel for which you want to rotate the access tokens.
client_mode(ClientMode)
/set_client_mode(Option<ClientMode>)
:
required: trueThe mode of the client that will use the client token, which can be either the source or destination, or both source and destination.
destination_config(DestinationConfig)
/set_destination_config(Option<DestinationConfig>)
:
required: falseThe destination configuration.
- On success, responds with
RotateTunnelAccessTokenOutput
with field(s):tunnel_arn(Option<String>)
:The Amazon Resource Name for the tunnel.
source_access_token(Option<String>)
:The client access token that the source local proxy uses to connect to IoT Secure Tunneling.
destination_access_token(Option<String>)
:The client access token that the destination local proxy uses to connect to IoT Secure Tunneling.
- On failure, responds with
SdkError<RotateTunnelAccessTokenError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueThe tags for the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe resource ARN.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe keys of the tags to remove.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more