Struct Client 

pub struct Client { /* private fields */ }

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 Builder 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

impl Client

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: true
    

    The ID of the tunnel to close.

    
    
  • delete(bool) / set_delete(Option<bool>):
    required: false
    

    When set to true, IoT Secure Tunneling deletes the tunnel data immediately.

    
    
• On success, responds with CloseTunnelOutput
• On failure, responds with SdkError<CloseTunnelError>

impl Client

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: true
    

    The tunnel to describe.

    
    
• On success, responds with DescribeTunnelOutput with field(s):
  • tunnel(Option<Tunnel>):

    The tunnel being described.

• On failure, responds with SdkError<DescribeTunnelError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The 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>

impl Client

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: false
    

    The name of the IoT thing associated with the destination device.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at once.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To 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>

impl Client

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: false
    

    A short text description of the tunnel.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A collection of tag metadata.

    
    
  • destination_config(DestinationConfig) / set_destination_config(Option<DestinationConfig>):
    required: false
    

    The destination configuration for the OpenTunnel request.

    
    
  • timeout_config(TimeoutConfig) / set_timeout_config(Option<TimeoutConfig>):
    required: false
    

    Timeout 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>

impl Client

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: true
    

    The tunnel for which you want to rotate the access tokens.

    
    
  • client_mode(ClientMode) / set_client_mode(Option<ClientMode>):
    required: true
    

    The 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: false
    

    The 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>

impl Client

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: true
    

    The ARN of the resource.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags for the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

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: true
    

    The resource ARN.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags to remove.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.