Struct aws_sdk_connectparticipant::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon Connect Participant Service
Client for invoking operations on Amazon Connect Participant Service. Each operation on Amazon Connect Participant Service 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_connectparticipant::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 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_connectparticipant::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 CompleteAttachmentUpload
operation has
a Client::complete_attachment_upload
, 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.complete_attachment_upload()
.client_token("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 complete_attachment_upload(
&self
) -> CompleteAttachmentUploadFluentBuilder
pub fn complete_attachment_upload( &self ) -> CompleteAttachmentUploadFluentBuilder
Constructs a fluent builder for the CompleteAttachmentUpload
operation.
- The fluent builder is configurable:
attachment_ids(impl Into<String>)
/set_attachment_ids(Option<Vec::<String>>)
:
required: trueA list of unique identifiers for the attachments.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:
required: trueThe authentication token associated with the participant’s connection.
- On success, responds with
CompleteAttachmentUploadOutput
- On failure, responds with
SdkError<CompleteAttachmentUploadError>
source§impl Client
impl Client
sourcepub fn create_participant_connection(
&self
) -> CreateParticipantConnectionFluentBuilder
pub fn create_participant_connection( &self ) -> CreateParticipantConnectionFluentBuilder
Constructs a fluent builder for the CreateParticipantConnection
operation.
- The fluent builder is configurable:
r#type(ConnectionType)
/set_type(Option<Vec::<ConnectionType>>)
:
required: falseType of connection information required. If you need
CONNECTION_CREDENTIALS
along with marking participant as connected, passCONNECTION_CREDENTIALS
inType
.participant_token(impl Into<String>)
/set_participant_token(Option<String>)
:
required: trueThis is a header parameter.
The ParticipantToken as obtained from StartChatContact API response.
connect_participant(bool)
/set_connect_participant(Option<bool>)
:
required: falseAmazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.
- On success, responds with
CreateParticipantConnectionOutput
with field(s):websocket(Option<Websocket>)
:Creates the participant’s websocket connection.
connection_credentials(Option<ConnectionCredentials>)
:Creates the participant’s connection credentials. The authentication token associated with the participant’s connection.
- On failure, responds with
SdkError<CreateParticipantConnectionError>
source§impl Client
impl Client
sourcepub fn describe_view(&self) -> DescribeViewFluentBuilder
pub fn describe_view(&self) -> DescribeViewFluentBuilder
Constructs a fluent builder for the DescribeView
operation.
- The fluent builder is configurable:
view_token(impl Into<String>)
/set_view_token(Option<String>)
:
required: trueAn encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:
required: trueThe connection token.
- On success, responds with
DescribeViewOutput
with field(s):view(Option<View>)
:A view resource object. Contains metadata and content necessary to render the view.
- On failure, responds with
SdkError<DescribeViewError>
source§impl Client
impl Client
sourcepub fn disconnect_participant(&self) -> DisconnectParticipantFluentBuilder
pub fn disconnect_participant(&self) -> DisconnectParticipantFluentBuilder
Constructs a fluent builder for the DisconnectParticipant
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:
required: trueThe authentication token associated with the participant’s connection.
- On success, responds with
DisconnectParticipantOutput
- On failure, responds with
SdkError<DisconnectParticipantError>
source§impl Client
impl Client
sourcepub fn get_attachment(&self) -> GetAttachmentFluentBuilder
pub fn get_attachment(&self) -> GetAttachmentFluentBuilder
Constructs a fluent builder for the GetAttachment
operation.
- The fluent builder is configurable:
attachment_id(impl Into<String>)
/set_attachment_id(Option<String>)
:
required: trueA unique identifier for the attachment.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:
required: trueThe authentication token associated with the participant’s connection.
- On success, responds with
GetAttachmentOutput
with field(s):url(Option<String>)
:This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.
url_expiry(Option<String>)
:The expiration time of the URL in ISO timestamp. It’s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
- On failure, responds with
SdkError<GetAttachmentError>
source§impl Client
impl Client
sourcepub fn get_transcript(&self) -> GetTranscriptFluentBuilder
pub fn get_transcript(&self) -> GetTranscriptFluentBuilder
Constructs a fluent builder for the GetTranscript
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
:
required: falseThe contactId from the current contact chain for which transcript is needed.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the page. Default: 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
scan_direction(ScanDirection)
/set_scan_direction(Option<ScanDirection>)
:
required: falseThe direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
sort_order(SortKey)
/set_sort_order(Option<SortKey>)
:
required: falseThe sort order for the records. Default: DESCENDING.
start_position(StartPosition)
/set_start_position(Option<StartPosition>)
:
required: falseA filtering option for where to start.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:
required: trueThe authentication token associated with the participant’s connection.
- On success, responds with
GetTranscriptOutput
with field(s):initial_contact_id(Option<String>)
:The initial contact ID for the contact.
transcript(Option<Vec::<Item>>)
:The list of messages in the session.
next_token(Option<String>)
:The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
- On failure, responds with
SdkError<GetTranscriptError>
source§impl Client
impl Client
sourcepub fn send_event(&self) -> SendEventFluentBuilder
pub fn send_event(&self) -> SendEventFluentBuilder
Constructs a fluent builder for the SendEvent
operation.
- The fluent builder is configurable:
content_type(impl Into<String>)
/set_content_type(Option<String>)
:
required: trueThe content type of the request. Supported types are:
-
application/vnd.amazonaws.connect.event.typing
-
application/vnd.amazonaws.connect.event.connection.acknowledged (will be deprecated on December 31, 2024)
-
application/vnd.amazonaws.connect.event.message.delivered
-
application/vnd.amazonaws.connect.event.message.read
-
content(impl Into<String>)
/set_content(Option<String>)
:
required: falseThe content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.
Sample Content: “{"messageId":"11111111-aaaa-bbbb-cccc-EXAMPLE01234"}”
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:
required: trueThe authentication token associated with the participant’s connection.
- On success, responds with
SendEventOutput
with field(s):id(Option<String>)
:The ID of the response.
absolute_time(Option<String>)
:The time when the event was sent.
It’s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
- On failure, responds with
SdkError<SendEventError>
source§impl Client
impl Client
sourcepub fn send_message(&self) -> SendMessageFluentBuilder
pub fn send_message(&self) -> SendMessageFluentBuilder
Constructs a fluent builder for the SendMessage
operation.
- The fluent builder is configurable:
content_type(impl Into<String>)
/set_content_type(Option<String>)
:
required: trueThe type of the content. Supported types are
text/plain
,text/markdown
,application/json
, andapplication/vnd.amazonaws.connect.message.interactive.response
.content(impl Into<String>)
/set_content(Option<String>)
:
required: trueThe content of the message.
-
For
text/plain
andtext/markdown
, the Length Constraints are Minimum of 1, Maximum of 1024. -
For
application/json
, the Length Constraints are Minimum of 1, Maximum of 12000. -
For
application/vnd.amazonaws.connect.message.interactive.response
, the Length Constraints are Minimum of 1, Maximum of 12288.
-
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:
required: trueThe authentication token associated with the connection.
- On success, responds with
SendMessageOutput
with field(s):id(Option<String>)
:The ID of the message.
absolute_time(Option<String>)
:The time when the message was sent.
It’s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
- On failure, responds with
SdkError<SendMessageError>
source§impl Client
impl Client
sourcepub fn start_attachment_upload(&self) -> StartAttachmentUploadFluentBuilder
pub fn start_attachment_upload(&self) -> StartAttachmentUploadFluentBuilder
Constructs a fluent builder for the StartAttachmentUpload
operation.
- The fluent builder is configurable:
content_type(impl Into<String>)
/set_content_type(Option<String>)
:
required: trueDescribes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
attachment_size_in_bytes(i64)
/set_attachment_size_in_bytes(Option<i64>)
:
required: trueThe size of the attachment in bytes.
attachment_name(impl Into<String>)
/set_attachment_name(Option<String>)
:
required: trueA case-sensitive name of the attachment being uploaded.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:
required: trueThe authentication token associated with the participant’s connection.
- On success, responds with
StartAttachmentUploadOutput
with field(s):attachment_id(Option<String>)
:A unique identifier for the attachment.
upload_metadata(Option<UploadMetadata>)
:Fields to be used while uploading the attachment.
- On failure, responds with
SdkError<StartAttachmentUploadError>
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.
Trait Implementations§
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more