Struct aws_sdk_connect::operation::start_web_rtc_contact::StartWebRtcContactInput

#[non_exhaustive]
pub struct StartWebRtcContactInput {
    pub attributes: Option<HashMap<String, String>>,
    pub client_token: Option<String>,
    pub contact_flow_id: Option<String>,
    pub instance_id: Option<String>,
    pub allowed_capabilities: Option<AllowedCapabilities>,
    pub participant_details: Option<ParticipantDetails>,
    pub related_contact_id: Option<String>,
    pub references: Option<HashMap<String, Reference>>,
    pub description: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

attributes: 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.

client_token: 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.

contact_flow_id: 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

instance_id: Option<String>

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

allowed_capabilities: Option<AllowedCapabilities>

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

participant_details: Option<ParticipantDetails>

The customer's details.

related_contact_id: Option<String>

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

references: 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.

description: Option<String>

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

Implementations

impl StartWebRtcContactInput

pub fn 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) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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) -> Option<&AllowedCapabilities>

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

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

The customer's details.

pub fn related_contact_id(&self) -> Option<&str>

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

pub fn 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) -> Option<&str>

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

impl StartWebRtcContactInput

pub fn builder() -> StartWebRtcContactInputBuilder

Creates a new builder-style object to manufacture StartWebRtcContactInput.

Trait Implementations

impl Clone for StartWebRtcContactInput

fn clone(&self) -> StartWebRtcContactInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartWebRtcContactInput

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

Formats the value using the given formatter.

impl PartialEq for StartWebRtcContactInput

fn eq(&self, other: &StartWebRtcContactInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartWebRtcContactInput