Struct aws_sdk_apigatewaymanagement::Client

pub struct Client { /* private fields */ }

Client for AmazonApiGatewayManagementApi

Client for invoking operations on AmazonApiGatewayManagementApi. Each operation on AmazonApiGatewayManagementApi 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_apigatewaymanagement::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_apigatewaymanagement::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 DeleteConnection operation has a Client::delete_connection, 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.delete_connection()
    .connection_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 delete_connection(&self) -> DeleteConnectionFluentBuilder

Constructs a fluent builder for the DeleteConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    (undocumented)
    
• On success, responds with DeleteConnectionOutput
• On failure, responds with SdkError<DeleteConnectionError>

impl Client

pub fn get_connection(&self) -> GetConnectionFluentBuilder

Constructs a fluent builder for the GetConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    (undocumented)
    
• On success, responds with GetConnectionOutput with field(s):
  • connected_at(Option<DateTime>):

    The time in ISO 8601 format for when the connection was established.

  • identity(Option<Identity>): (undocumented)
  • last_active_at(Option<DateTime>):

    The time in ISO 8601 format for when the connection was last active.

• On failure, responds with SdkError<GetConnectionError>

impl Client

pub fn post_to_connection(&self) -> PostToConnectionFluentBuilder

Constructs a fluent builder for the PostToConnection operation.

• The fluent builder is configurable:
  • data(Blob) / set_data(Option<Blob>):
    required: true
    

    The data to be sent to the client specified by its connection id.

    
    
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The identifier of the connection that a specific client is using.

    
    
• On success, responds with PostToConnectionOutput
• On failure, responds with SdkError<PostToConnectionError>

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 copy 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.