Struct aws_sdk_connectparticipant::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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_connectparticipant::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_connectparticipant::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_connectparticipant::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn complete_attachment_upload(&self) -> CompleteAttachmentUpload
pub fn complete_attachment_upload(&self) -> CompleteAttachmentUpload
Constructs a fluent builder for the CompleteAttachmentUpload
operation.
- The fluent builder is configurable:
attachment_ids(Vec<String>)
/set_attachment_ids(Option<Vec<String>>)
:A list of unique identifiers for the attachments.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:The authentication token associated with the participant’s connection.
- On success, responds with
CompleteAttachmentUploadOutput
- On failure, responds with
SdkError<CompleteAttachmentUploadError>
sourcepub fn create_participant_connection(&self) -> CreateParticipantConnection
pub fn create_participant_connection(&self) -> CreateParticipantConnection
Constructs a fluent builder for the CreateParticipantConnection
operation.
- The fluent builder is configurable:
r#type(Vec<ConnectionType>)
/set_type(Option<Vec<ConnectionType>>)
:Type of connection information required.
participant_token(impl Into<String>)
/set_participant_token(Option<String>)
:This is a header parameter.
The ParticipantToken as obtained from StartChatContact API response.
connect_participant(bool)
/set_connect_participant(Option<bool>)
:Amazon Connect Participant is used to mark the participant as connected for message streaming.
- 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>
sourcepub fn disconnect_participant(&self) -> DisconnectParticipant
pub fn disconnect_participant(&self) -> DisconnectParticipant
Constructs a fluent builder for the DisconnectParticipant
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:The authentication token associated with the participant’s connection.
- On success, responds with
DisconnectParticipantOutput
- On failure, responds with
SdkError<DisconnectParticipantError>
sourcepub fn get_attachment(&self) -> GetAttachment
pub fn get_attachment(&self) -> GetAttachment
Constructs a fluent builder for the GetAttachment
operation.
- The fluent builder is configurable:
attachment_id(impl Into<String>)
/set_attachment_id(Option<String>)
:A unique identifier for the attachment.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:The 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>
sourcepub fn get_transcript(&self) -> GetTranscript
pub fn get_transcript(&self) -> GetTranscript
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>)
:The contactId from the current contact chain for which transcript is needed.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in the page. Default: 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The 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>)
:The 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>)
:The sort order for the records. Default: DESCENDING.
start_position(StartPosition)
/set_start_position(Option<StartPosition>)
:A filtering option for where to start.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:The 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>
sourcepub fn send_event(&self) -> SendEvent
pub fn send_event(&self) -> SendEvent
Constructs a fluent builder for the SendEvent
operation.
- The fluent builder is configurable:
content_type(impl Into<String>)
/set_content_type(Option<String>)
:The content type of the request. Supported types are:
-
application/vnd.amazonaws.connect.event.typing
-
application/vnd.amazonaws.connect.event.connection.acknowledged
-
content(impl Into<String>)
/set_content(Option<String>)
:The content of the event to be sent (for example, message text). This is not yet supported.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:The 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>
sourcepub fn send_message(&self) -> SendMessage
pub fn send_message(&self) -> SendMessage
Constructs a fluent builder for the SendMessage
operation.
- The fluent builder is configurable:
content_type(impl Into<String>)
/set_content_type(Option<String>)
:The type of the content. Supported types are text/plain.
content(impl Into<String>)
/set_content(Option<String>)
:The content of the message.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:The 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>
sourcepub fn start_attachment_upload(&self) -> StartAttachmentUpload
pub fn start_attachment_upload(&self) -> StartAttachmentUpload
Constructs a fluent builder for the StartAttachmentUpload
operation.
- The fluent builder is configurable:
content_type(impl Into<String>)
/set_content_type(Option<String>)
:Describes 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(i64)
:The size of the attachment in bytes.
attachment_name(impl Into<String>)
/set_attachment_name(Option<String>)
:A case-sensitive name of the attachment being uploaded.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique case sensitive identifier to support idempotency of request.
connection_token(impl Into<String>)
/set_connection_token(Option<String>)
:The 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>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more