Struct Client

source

pub struct Client { /* private fields */ }

Expand description

Client for AmplifyBackend

Client for invoking operations on AmplifyBackend. Each operation on AmplifyBackend 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_amplifybackend::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_amplifybackend::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 CloneBackend operation has a Client::clone_backend, 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.clone_backend()
    .app_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 ClientCopy item path

§Constructing a Client

§Using the Client

Implementations§

impl Client

pub fn clone_backend(&self) -> CloneBackendFluentBuilder

impl Client

pub fn create_backend(&self) -> CreateBackendFluentBuilder

impl Client

pub fn create_backend_api(&self) -> CreateBackendAPIFluentBuilder

impl Client

pub fn create_backend_auth(&self) -> CreateBackendAuthFluentBuilder

impl Client

pub fn create_backend_config(&self) -> CreateBackendConfigFluentBuilder

impl Client

pub fn create_backend_storage(&self) -> CreateBackendStorageFluentBuilder

impl Client

pub fn create_token(&self) -> CreateTokenFluentBuilder

impl Client

pub fn delete_backend(&self) -> DeleteBackendFluentBuilder

impl Client

pub fn delete_backend_api(&self) -> DeleteBackendAPIFluentBuilder

impl Client

pub fn delete_backend_auth(&self) -> DeleteBackendAuthFluentBuilder

impl Client

pub fn delete_backend_storage(&self) -> DeleteBackendStorageFluentBuilder

impl Client

pub fn delete_token(&self) -> DeleteTokenFluentBuilder

impl Client

pub fn generate_backend_api_models( &self, ) -> GenerateBackendAPIModelsFluentBuilder

impl Client

pub fn get_backend(&self) -> GetBackendFluentBuilder

impl Client

pub fn get_backend_api(&self) -> GetBackendAPIFluentBuilder

impl Client

pub fn get_backend_api_models(&self) -> GetBackendAPIModelsFluentBuilder

impl Client

pub fn get_backend_auth(&self) -> GetBackendAuthFluentBuilder

impl Client

pub fn get_backend_job(&self) -> GetBackendJobFluentBuilder

impl Client

pub fn get_backend_storage(&self) -> GetBackendStorageFluentBuilder

impl Client

pub fn get_token(&self) -> GetTokenFluentBuilder

impl Client

pub fn import_backend_auth(&self) -> ImportBackendAuthFluentBuilder

impl Client

pub fn import_backend_storage(&self) -> ImportBackendStorageFluentBuilder

impl Client

pub fn list_backend_jobs(&self) -> ListBackendJobsFluentBuilder

impl Client

pub fn list_s3_buckets(&self) -> ListS3BucketsFluentBuilder

impl Client

pub fn remove_all_backends(&self) -> RemoveAllBackendsFluentBuilder

impl Client

pub fn remove_backend_config(&self) -> RemoveBackendConfigFluentBuilder

impl Client

pub fn update_backend_api(&self) -> UpdateBackendAPIFluentBuilder

impl Client

pub fn update_backend_auth(&self) -> UpdateBackendAuthFluentBuilder

impl Client

pub fn update_backend_config(&self) -> UpdateBackendConfigFluentBuilder

impl Client

pub fn update_backend_job(&self) -> UpdateBackendJobFluentBuilder

impl Client

pub fn update_backend_storage(&self) -> UpdateBackendStorageFluentBuilder

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§

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,