Struct aws_sdk_connect::operation::start_task_contact::builders::StartTaskContactFluentBuilder

pub struct StartTaskContactFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartTaskContact.

Initiates a flow to start a new task.

Implementations

impl StartTaskContactFluentBuilder

pub fn as_input(&self) -> &StartTaskContactInputBuilder

Access the StartTaskContact as a reference.

pub async fn send( self ) -> Result<StartTaskContactOutput, SdkError<StartTaskContactError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub async fn customize( self ) -> Result<CustomizableOperation<StartTaskContactOutput, StartTaskContactError>, SdkError<StartTaskContactError>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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.

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.

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

The identifier of the previous chat, voice, or task contact.

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

The identifier of the previous chat, voice, or task contact.

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 console user interface, 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 console user interface, 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 console user interface, 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).

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

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

pub fn get_references(&self) -> &Option<HashMap<String, Reference>>

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

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.

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

A unique identifier for the task template.

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

A unique identifier for the task template.

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

The identifier for the quick connect.

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

The identifier for the quick connect.

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

The identifier for the quick connect.

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

The contactId that is related to this contact.

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

The contactId that is related to this contact.

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

The contactId that is related to this contact.

Trait Implementations

impl Clone for StartTaskContactFluentBuilder

fn clone(&self) -> StartTaskContactFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartTaskContactFluentBuilder

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

Formats the value using the given formatter.