Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Cognito Sync

Client for invoking operations on Amazon Cognito Sync. Each operation on Amazon Cognito Sync 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_cognitosync::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_cognitosync::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 BulkPublish operation has a Client::bulk_publish, 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.bulk_publish()
    .identity_pool_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.

Struct Client Copy item path

§Constructing a Client

§Using the Client

Implementations§

impl Client

pub fn bulk_publish(&self) -> BulkPublishFluentBuilder

impl Client

pub fn delete_dataset(&self) -> DeleteDatasetFluentBuilder

impl Client

pub fn describe_dataset(&self) -> DescribeDatasetFluentBuilder

impl Client

pub fn describe_identity_pool_usage( &self, ) -> DescribeIdentityPoolUsageFluentBuilder

impl Client

pub fn describe_identity_usage(&self) -> DescribeIdentityUsageFluentBuilder

impl Client

pub fn get_bulk_publish_details(&self) -> GetBulkPublishDetailsFluentBuilder

impl Client

pub fn get_cognito_events(&self) -> GetCognitoEventsFluentBuilder

impl Client

pub fn get_identity_pool_configuration( &self, ) -> GetIdentityPoolConfigurationFluentBuilder

impl Client

pub fn list_datasets(&self) -> ListDatasetsFluentBuilder

impl Client

pub fn list_identity_pool_usage(&self) -> ListIdentityPoolUsageFluentBuilder

impl Client

pub fn list_records(&self) -> ListRecordsFluentBuilder

impl Client

pub fn register_device(&self) -> RegisterDeviceFluentBuilder

impl Client

pub fn set_cognito_events(&self) -> SetCognitoEventsFluentBuilder

impl Client

pub fn set_identity_pool_configuration( &self, ) -> SetIdentityPoolConfigurationFluentBuilder

impl Client

pub fn subscribe_to_dataset(&self) -> SubscribeToDatasetFluentBuilder

impl Client

pub fn unsubscribe_from_dataset(&self) -> UnsubscribeFromDatasetFluentBuilder

impl Client

pub fn update_records(&self) -> UpdateRecordsFluentBuilder

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

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§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

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

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

fn into_shared(self) -> Shared

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

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,