Struct aws_sdk_connect::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder

pub struct StartWebRTCContactFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartWebRTCContact.

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

Implementations

impl StartWebRTCContactFluentBuilder

pub fn as_input(&self) -> &StartWebRtcContactInputBuilder

Access the StartWebRTCContact as a reference.

pub async fn send( self ) -> Result<StartWebRtcContactOutput, SdkError<StartWebRTCContactError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<StartWebRtcContactOutput, StartWebRTCContactError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Attributes.

To override the contents of this collection use set_attributes.

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.

pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.

pub fn get_attributes(&self) -> &Option<HashMap<String, String>>

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.

pub fn client_token(self, input: impl Into<String>) -> Self

A 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.

The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

pub fn set_client_token(self, input: Option<String>) -> Self

A 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.

The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

pub fn get_client_token(&self) -> &Option<String>

A 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.

The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

pub fn contact_flow_id(self, input: impl Into<String>) -> Self

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

pub fn set_contact_flow_id(self, input: Option<String>) -> Self

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

pub fn get_contact_flow_id(&self) -> &Option<String>

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

pub fn instance_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

pub fn set_instance_id(self, input: Option<String>) -> Self

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

pub fn get_instance_id(&self) -> &Option<String>

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

pub fn allowed_capabilities(self, input: AllowedCapabilities) -> Self

Information about the video sharing capabilities of the participants (customer, agent).

pub fn set_allowed_capabilities( self, input: Option<AllowedCapabilities> ) -> Self

Information about the video sharing capabilities of the participants (customer, agent).

pub fn get_allowed_capabilities(&self) -> &Option<AllowedCapabilities>

Information about the video sharing capabilities of the participants (customer, agent).

pub fn participant_details(self, input: ParticipantDetails) -> Self

The customer's details.

pub fn set_participant_details(self, input: Option<ParticipantDetails>) -> Self

The customer's details.

pub fn get_participant_details(&self) -> &Option<ParticipantDetails>

The customer's details.

pub fn related_contact_id(self, input: impl Into<String>) -> Self

The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

pub fn set_related_contact_id(self, input: Option<String>) -> Self

The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

pub fn get_related_contact_id(&self) -> &Option<String>

The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

pub fn references(self, k: impl Into<String>, v: Reference) -> Self

Adds a key-value pair to References.

To override the contents of this collection use set_references.

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

pub fn set_references(self, input: Option<HashMap<String, Reference>>) -> Self

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

pub fn get_references(&self) -> &Option<HashMap<String, Reference>>

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

pub fn description(self, input: impl Into<String>) -> Self

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

pub fn set_description(self, input: Option<String>) -> Self

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

pub fn get_description(&self) -> &Option<String>

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

Trait Implementations

impl Clone for StartWebRTCContactFluentBuilder

fn clone(&self) -> StartWebRTCContactFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartWebRTCContactFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.