Struct aws_sdk_connect::operation::start_task_contact::builders::StartTaskContactFluentBuilder
source · pub struct StartTaskContactFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartTaskContact
.
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId
and RelatedContactId
input parameters, note the following:
-
PreviousContactId
-
Any updates to user-defined task contact attributes on any contact linked through the same
PreviousContactId
will affect every contact in the chain. -
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same
PreviousContactId
.
-
-
RelatedContactId
-
Copies contact attributes from the related task contact to the new contact.
-
Any update on attributes in a new task contact does not update attributes on previous contact.
-
There’s no limit on the number of task contacts that can be created that use the same
RelatedContactId
.
-
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID
, QuickConnectID
, or TaskTemplateID
. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID
is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException
occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId
. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.
Implementations§
source§impl StartTaskContactFluentBuilder
impl StartTaskContactFluentBuilder
sourcepub fn as_input(&self) -> &StartTaskContactInputBuilder
pub fn as_input(&self) -> &StartTaskContactInputBuilder
Access the StartTaskContact as a reference.
sourcepub async fn send(
self
) -> Result<StartTaskContactOutput, SdkError<StartTaskContactError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<StartTaskContactOutput, StartTaskContactError, Self>
pub fn customize( self ) -> CustomizableOperation<StartTaskContactOutput, StartTaskContactError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn instance_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_instance_id(self, input: Option<String>) -> Self
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.
sourcepub fn get_instance_id(&self) -> &Option<String>
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.
sourcepub fn previous_contact_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_previous_contact_id(self, input: Option<String>) -> Self
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.
sourcepub fn get_previous_contact_id(&self) -> &Option<String>
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.
sourcepub fn contact_flow_id(self, input: impl Into<String>) -> Self
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
sourcepub fn set_contact_flow_id(self, input: Option<String>) -> Self
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
sourcepub fn get_contact_flow_id(&self) -> &Option<String>
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
sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
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.
sourcepub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
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.
sourcepub fn get_attributes(&self) -> &Option<HashMap<String, String>>
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.
sourcepub fn name(self, input: impl Into<String>) -> Self
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).
sourcepub fn set_name(self, input: Option<String>) -> Self
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).
sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
sourcepub fn references(self, k: impl Into<String>, v: Reference) -> Self
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.
sourcepub fn set_references(self, input: Option<HashMap<String, Reference>>) -> Self
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.
sourcepub fn get_references(&self) -> &Option<HashMap<String, Reference>>
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.
sourcepub fn description(self, input: impl Into<String>) -> Self
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).
sourcepub fn set_description(self, input: Option<String>) -> Self
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).
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
sourcepub fn client_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_client_token(&self) -> &Option<String>
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.
sourcepub fn scheduled_time(self, input: DateTime) -> Self
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.
sourcepub fn set_scheduled_time(self, input: Option<DateTime>) -> Self
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.
sourcepub fn get_scheduled_time(&self) -> &Option<DateTime>
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.
sourcepub fn task_template_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_task_template_id(self, input: Option<String>) -> Self
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.
sourcepub fn get_task_template_id(&self) -> &Option<String>
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.
sourcepub fn quick_connect_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_quick_connect_id(self, input: Option<String>) -> Self
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.
sourcepub fn get_quick_connect_id(&self) -> &Option<String>
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.
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
.
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
.
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
.
Trait Implementations§
source§impl Clone for StartTaskContactFluentBuilder
impl Clone for StartTaskContactFluentBuilder
source§fn clone(&self) -> StartTaskContactFluentBuilder
fn clone(&self) -> StartTaskContactFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more