Struct aws_sdk_connect::operation::start_task_contact::StartTaskContactInput

#[non_exhaustive]
pub struct StartTaskContactInput {
    pub instance_id: Option<String>,
    pub previous_contact_id: Option<String>,
    pub contact_flow_id: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub name: Option<String>,
    pub references: Option<HashMap<String, Reference>>,
    pub description: Option<String>,
    pub client_token: Option<String>,
    pub scheduled_time: Option<DateTime>,
    pub task_template_id: Option<String>,
    pub quick_connect_id: Option<String>,
    pub related_contact_id: 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.

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.

previous_contact_id: Option<String>

The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.

contact_flow_id: Option<String>

The identifier of the flow for initiating the tasks. 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

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, dash, and underscore characters.

name: Option<String>

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

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

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.

scheduled_time: Option<DateTime>

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.

task_template_id: Option<String>

A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.

quick_connect_id: Option<String>

The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.

related_contact_id: Option<String>

The contactId that is related to this contact. Linking tasks together by using RelatedContactID 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 PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

Implementations

impl StartTaskContactInput

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

The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.

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

The identifier of the flow for initiating the tasks. 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 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, dash, and underscore characters.

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

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

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

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.

pub fn scheduled_time(&self) -> Option<&DateTime>

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.

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

A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.

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

The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.

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

The contactId that is related to this contact. Linking tasks together by using RelatedContactID 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 PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

impl StartTaskContactInput

pub fn builder() -> StartTaskContactInputBuilder

Creates a new builder-style object to manufacture StartTaskContactInput.

Trait Implementations

impl Clone for StartTaskContactInput

fn clone(&self) -> StartTaskContactInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartTaskContactInput

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

Formats the value using the given formatter.

impl PartialEq for StartTaskContactInput

fn eq(&self, other: &StartTaskContactInput) -> 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 StartTaskContactInput