1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartWebRTCContact`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::set_attributes):<br>required: **false**<br><p>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.</p> <p>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.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::set_client_token):<br>required: **false**<br><p>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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p> <p>The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.</p><br>
    ///   - [`contact_flow_id(impl Into<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::contact_flow_id) / [`set_contact_flow_id(Option<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::set_contact_flow_id):<br>required: **true**<br><p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold:</p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b></p><br>
    ///   - [`instance_id(impl Into<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
    ///   - [`allowed_capabilities(AllowedCapabilities)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::allowed_capabilities) / [`set_allowed_capabilities(Option<AllowedCapabilities>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::set_allowed_capabilities):<br>required: **false**<br><p>Information about the video sharing capabilities of the participants (customer, agent).</p><br>
    ///   - [`participant_details(ParticipantDetails)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::participant_details) / [`set_participant_details(Option<ParticipantDetails>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::set_participant_details):<br>required: **true**<br><p>The customer's details.</p><br>
    ///   - [`related_contact_id(impl Into<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::related_contact_id) / [`set_related_contact_id(Option<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::set_related_contact_id):<br>required: **false**<br><p>The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.</p><br>
    ///   - [`references(impl Into<String>, Reference)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::references) / [`set_references(Option<HashMap::<String, Reference>>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::set_references):<br>required: **false**<br><p>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: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during task creation.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::set_description):<br>required: **false**<br><p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p><br>
    /// - On success, responds with [`StartWebRtcContactOutput`](crate::operation::start_web_rtc_contact::StartWebRtcContactOutput) with field(s):
    ///   - [`connection_data(Option<ConnectionData>)`](crate::operation::start_web_rtc_contact::StartWebRtcContactOutput::connection_data): <p>Information required for the client application (mobile application or website) to connect to the call.</p>
    ///   - [`contact_id(Option<String>)`](crate::operation::start_web_rtc_contact::StartWebRtcContactOutput::contact_id): <p>The identifier of the contact in this instance of Amazon Connect.</p>
    ///   - [`participant_id(Option<String>)`](crate::operation::start_web_rtc_contact::StartWebRtcContactOutput::participant_id): <p>The identifier for a contact participant. The <code>ParticipantId</code> for a contact participant is the same throughout the contact lifecycle.</p>
    ///   - [`participant_token(Option<String>)`](crate::operation::start_web_rtc_contact::StartWebRtcContactOutput::participant_token): <p>The token used by the contact participant to call the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API. The participant token is valid for the lifetime of a contact participant.</p>
    /// - On failure, responds with [`SdkError<StartWebRTCContactError>`](crate::operation::start_web_rtc_contact::StartWebRTCContactError)
    pub fn start_web_rtc_contact(&self) -> crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder {
        crate::operation::start_web_rtc_contact::builders::StartWebRTCContactFluentBuilder::new(self.handle.clone())
    }
}