Struct aws_sdk_connect::operation::start_task_contact::builders::StartTaskContactInputBuilder

#[non_exhaustive]
pub struct StartTaskContactInputBuilder { /* private fields */ }

A builder for StartTaskContactInput.

Implementations

impl StartTaskContactInputBuilder

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.

This field is required.

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 previous_contact_id(self, input: impl Into<String>) -> Self

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 set_previous_contact_id(self, input: Option<String>) -> Self

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 get_previous_contact_id(&self) -> &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.

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

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 set_contact_flow_id(self, input: Option<String>) -> Self

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 get_contact_flow_id(&self) -> &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

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

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

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

This field is required.

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

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

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

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

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

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.

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.

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.

pub fn scheduled_time(self, input: DateTime) -> Self

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 set_scheduled_time(self, input: Option<DateTime>) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_task_template_id(self, input: Option<String>) -> Self

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 get_task_template_id(&self) -> &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.

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

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 set_quick_connect_id(self, input: Option<String>) -> Self

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 get_quick_connect_id(&self) -> &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.

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

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.

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

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.

pub fn get_related_contact_id(&self) -> &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.

pub fn build(self) -> Result<StartTaskContactInput, BuildError>

Consumes the builder and constructs a StartTaskContactInput.

impl StartTaskContactInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<StartTaskContactOutput, SdkError<StartTaskContactError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartTaskContactInputBuilder

fn clone(&self) -> StartTaskContactInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartTaskContactInputBuilder

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

Formats the value using the given formatter.

impl Default for StartTaskContactInputBuilder

fn default() -> StartTaskContactInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartTaskContactInputBuilder

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