Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

Client for Amazon GameLift Streams

Client for invoking operations on Amazon GameLift Streams. Each operation on Amazon GameLift Streams 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_gameliftstreams::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_gameliftstreams::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 AddStreamGroupLocations operation has a Client::add_stream_group_locations, 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.add_stream_group_locations()
    .identifier("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.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Struct ClientCopy item path

§Constructing a Client

§Using the Client

§Waiters

Implementations§

impl Client

pub fn add_stream_group_locations(&self) -> AddStreamGroupLocationsFluentBuilder

impl Client

pub fn associate_applications(&self) -> AssociateApplicationsFluentBuilder

impl Client

pub fn create_application(&self) -> CreateApplicationFluentBuilder

impl Client

pub fn create_stream_group(&self) -> CreateStreamGroupFluentBuilder

impl Client

pub fn create_stream_session_connection( &self, ) -> CreateStreamSessionConnectionFluentBuilder

impl Client

pub fn delete_application(&self) -> DeleteApplicationFluentBuilder

impl Client

pub fn delete_stream_group(&self) -> DeleteStreamGroupFluentBuilder

impl Client

pub fn disassociate_applications(&self) -> DisassociateApplicationsFluentBuilder

impl Client

pub fn export_stream_session_files( &self, ) -> ExportStreamSessionFilesFluentBuilder

impl Client

pub fn get_application(&self) -> GetApplicationFluentBuilder

impl Client

pub fn get_stream_group(&self) -> GetStreamGroupFluentBuilder

impl Client

pub fn get_stream_session(&self) -> GetStreamSessionFluentBuilder

impl Client

pub fn list_applications(&self) -> ListApplicationsFluentBuilder

impl Client

pub fn list_stream_groups(&self) -> ListStreamGroupsFluentBuilder

impl Client

pub fn list_stream_sessions(&self) -> ListStreamSessionsFluentBuilder

impl Client

pub fn list_stream_sessions_by_account( &self, ) -> ListStreamSessionsByAccountFluentBuilder

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

impl Client

pub fn remove_stream_group_locations( &self, ) -> RemoveStreamGroupLocationsFluentBuilder

impl Client

pub fn start_stream_session(&self) -> StartStreamSessionFluentBuilder

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

impl Client

pub fn terminate_stream_session(&self) -> TerminateStreamSessionFluentBuilder

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

impl Client

pub fn update_application(&self) -> UpdateApplicationFluentBuilder

impl Client

pub fn update_stream_group(&self) -> UpdateStreamGroupFluentBuilder

impl Client

pub fn from_conf(conf: Config) -> Self

§Panics

pub fn config(&self) -> &Config

impl Client

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

§Panics

Trait Implementations§

impl Clone for Client

fn clone(&self) -> Client

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

impl Debug for Client

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

impl Waiters for Client

fn wait_until_application_ready(&self) -> ApplicationReadyFluentBuilder

fn wait_until_application_deleted(&self) -> ApplicationDeletedFluentBuilder

fn wait_until_stream_group_active(&self) -> StreamGroupActiveFluentBuilder

fn wait_until_stream_group_deleted(&self) -> StreamGroupDeletedFluentBuilder

fn wait_until_stream_session_active(&self) -> StreamSessionActiveFluentBuilder

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§

Struct Client

§Constructing a `Client`

§Using the `Client`

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,