Struct aws_sdk_connectcontactlens::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon Connect Contact Lens
Client for invoking operations on Amazon Connect Contact Lens. Each operation on Amazon Connect Contact Lens 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_connectcontactlens::Client::new(&config);
Occasionally, SDKs may have additional service-specific that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
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_connectcontactlens::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 ListRealtimeContactAnalysisSegments
operation has
a Client::list_realtime_contact_analysis_segments
, 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.list_realtime_contact_analysis_segments()
.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.
Implementations§
source§impl Client
impl Client
sourcepub fn list_realtime_contact_analysis_segments(
&self
) -> ListRealtimeContactAnalysisSegmentsFluentBuilder
pub fn list_realtime_contact_analysis_segments( &self ) -> ListRealtimeContactAnalysisSegmentsFluentBuilder
Constructs a fluent builder for the ListRealtimeContactAnalysisSegments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:
required: trueThe identifier of the Amazon Connect instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
:
required: trueThe identifier of the contact.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximimum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- On success, responds with
ListRealtimeContactAnalysisSegmentsOutput
with field(s):segments(Option<Vec::<RealtimeContactAnalysisSegment>>)
:An analyzed transcript or category.
next_token(Option<String>)
:If there are additional results, this is the token for the next set of results. If response includes
nextToken
there are two possible scenarios:-
There are more segments so another call is required to get them.
-
There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.
If response does not include
nextToken
, the analysis is completed (successfully or failed) and there are no more segments to retrieve.-
- On failure, responds with
SdkError<ListRealtimeContactAnalysisSegmentsError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.