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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_apigatewaymanagement::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_apigatewaymanagement::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_apigatewaymanagement::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn delete_connection(&self) -> DeleteConnection

Constructs a fluent builder for the DeleteConnection operation.

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

pub fn get_connection(&self) -> GetConnection

Constructs a fluent builder for the GetConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>): (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>

pub fn post_to_connection(&self) -> PostToConnection

Constructs a fluent builder for the PostToConnection operation.

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

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

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

    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_conn<C, E>(conf: Config, conn: C) -> Self where
    C: SmithyConnector<Error = E> + Send + 'static,
    E: Into<ConnectorError>, 

Creates a client with the given service config and connector override.

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Performs the conversion.