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 [`StartTaskContact`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::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>
    ///   - [`previous_contact_id(impl Into<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::previous_contact_id) / [`set_previous_contact_id(Option<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::set_previous_contact_id):<br>required: **false**<br><p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same <code>PreviousContactID</code> will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</p><br>
    ///   - [`contact_flow_id(impl Into<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::contact_flow_id) / [`set_contact_flow_id(Option<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::set_contact_flow_id):<br>required: **false**<br><p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, 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>
    ///   - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::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, dash, and underscore characters.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::set_name):<br>required: **true**<br><p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p><br>
    ///   - [`references(impl Into<String>, Reference)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::references) / [`set_references(Option<HashMap::<String, Reference>>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::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_task_contact::builders::StartTaskContactFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::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>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::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><br>
    ///   - [`scheduled_time(DateTime)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::scheduled_time) / [`set_scheduled_time(Option<DateTime>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::set_scheduled_time):<br>required: **false**<br><p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p><br>
    ///   - [`task_template_id(impl Into<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::task_template_id) / [`set_task_template_id(Option<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::set_task_template_id):<br>required: **false**<br><p>A unique identifier for the task template. For more information about task templates, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html">Create task templates</a> in the <i>Amazon Connect Administrator Guide</i>. </p><br>
    ///   - [`quick_connect_id(impl Into<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::quick_connect_id) / [`set_quick_connect_id(Option<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::set_quick_connect_id):<br>required: **false**<br><p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick connects</a>.</p><br>
    ///   - [`related_contact_id(impl Into<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::related_contact_id) / [`set_related_contact_id(Option<String>)`](crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::set_related_contact_id):<br>required: **false**<br><p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact. Linking tasks together by using <code>RelatedContactID</code> copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using <code>PreviousContactID</code>. There are no limits to the number of contacts that can be linked by using <code>RelatedContactId</code>. </p><br>
    /// - On success, responds with [`StartTaskContactOutput`](crate::operation::start_task_contact::StartTaskContactOutput) with field(s):
    ///   - [`contact_id(Option<String>)`](crate::operation::start_task_contact::StartTaskContactOutput::contact_id): <p>The identifier of this contact within the Amazon Connect instance.</p>
    /// - On failure, responds with [`SdkError<StartTaskContactError>`](crate::operation::start_task_contact::StartTaskContactError)
    pub fn start_task_contact(&self) -> crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder {
        crate::operation::start_task_contact::builders::StartTaskContactFluentBuilder::new(self.handle.clone())
    }
}