Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

Client for QApps

Client for invoking operations on QApps. Each operation on QApps 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_qapps::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_qapps::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 AssociateLibraryItemReview operation has a Client::associate_library_item_review, 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.associate_library_item_review()
    .instance_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 associate_library_item_review( &self, ) -> AssociateLibraryItemReviewFluentBuilder

impl Client

pub fn associate_q_app_with_user(&self) -> AssociateQAppWithUserFluentBuilder

impl Client

pub fn batch_create_category(&self) -> BatchCreateCategoryFluentBuilder

impl Client

pub fn batch_delete_category(&self) -> BatchDeleteCategoryFluentBuilder

impl Client

pub fn batch_update_category(&self) -> BatchUpdateCategoryFluentBuilder

impl Client

pub fn create_library_item(&self) -> CreateLibraryItemFluentBuilder

impl Client

pub fn create_presigned_url(&self) -> CreatePresignedUrlFluentBuilder

impl Client

pub fn create_q_app(&self) -> CreateQAppFluentBuilder

impl Client

pub fn delete_library_item(&self) -> DeleteLibraryItemFluentBuilder

impl Client

pub fn delete_q_app(&self) -> DeleteQAppFluentBuilder

impl Client

pub fn describe_q_app_permissions(&self) -> DescribeQAppPermissionsFluentBuilder

impl Client

pub fn disassociate_library_item_review( &self, ) -> DisassociateLibraryItemReviewFluentBuilder

impl Client

pub fn disassociate_q_app_from_user( &self, ) -> DisassociateQAppFromUserFluentBuilder

impl Client

pub fn export_q_app_session_data(&self) -> ExportQAppSessionDataFluentBuilder

impl Client

pub fn get_library_item(&self) -> GetLibraryItemFluentBuilder

impl Client

pub fn get_q_app(&self) -> GetQAppFluentBuilder

impl Client

pub fn get_q_app_session(&self) -> GetQAppSessionFluentBuilder

impl Client

pub fn get_q_app_session_metadata(&self) -> GetQAppSessionMetadataFluentBuilder

impl Client

pub fn import_document(&self) -> ImportDocumentFluentBuilder

impl Client

pub fn list_categories(&self) -> ListCategoriesFluentBuilder

impl Client

pub fn list_library_items(&self) -> ListLibraryItemsFluentBuilder

impl Client

pub fn list_q_app_session_data(&self) -> ListQAppSessionDataFluentBuilder

impl Client

pub fn list_q_apps(&self) -> ListQAppsFluentBuilder

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

impl Client

pub fn predict_q_app(&self) -> PredictQAppFluentBuilder

impl Client

pub fn start_q_app_session(&self) -> StartQAppSessionFluentBuilder

impl Client

pub fn stop_q_app_session(&self) -> StopQAppSessionFluentBuilder

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

impl Client

pub fn update_library_item(&self) -> UpdateLibraryItemFluentBuilder

impl Client

pub fn update_library_item_metadata( &self, ) -> UpdateLibraryItemMetadataFluentBuilder

impl Client

pub fn update_q_app(&self) -> UpdateQAppFluentBuilder

impl Client

pub fn update_q_app_permissions(&self) -> UpdateQAppPermissionsFluentBuilder

impl Client

pub fn update_q_app_session(&self) -> UpdateQAppSessionFluentBuilder

impl Client

pub fn update_q_app_session_metadata( &self, ) -> UpdateQAppSessionMetadataFluentBuilder

impl Client

pub fn from_conf(conf: Config) -> Self

§Panics

pub fn config(&self) -> &Config

impl Client

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

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,