Struct aws_sdk_connect::client::fluent_builders::StartTaskContact

pub struct StartTaskContact<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to StartTaskContact.

Initiates a contact flow to start a new task immediately or at a future date and time.

Implementations

impl<C, M, R> StartTaskContact<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StartTaskContactOutput, SdkError<StartTaskContactError>> where
    R::Policy: SmithyRetryPolicy<StartTaskContactInputOperationOutputAlias, StartTaskContactOutput, StartTaskContactError, StartTaskContactInputOperationRetryAlias>, 

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 fn instance_id(self, inp: impl Into<String>) -> Self

The identifier of the Amazon Connect instance. You can find the instanceId in the 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 instanceId in the ARN of the instance.

pub fn previous_contact_id(self, inp: 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 contact_flow_id(self, inp: impl Into<String>) -> Self

The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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 contact 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 contact flow. On the contact flow page, under the name of the contact 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 contact 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 contact 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, inp: 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 references(self, k: impl Into<String>, v: impl Into<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 description(self, inp: 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 client_token(self, inp: impl Into<String>) -> Self

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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.

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

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact 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 contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for StartTaskContact<C, M, R>

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

Formats the value using the given formatter.