class Aws::Connect::Types::StartTaskContactRequest

@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
@return [Hash<String,Types::SegmentAttributeValue>]
</note>
“arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”}}}‘.
{ “ValueString”:
supplied, with `SegmentAttributes` like { `“connect:CreatedByUser”
To set the created by user, a valid AgentResourceId must be
“ValueInteger”: 135}}}}`.
“connect:ContactExpiry”: {“ValueMap” : { “ExpiryDuration”: {
expiring, with `SegmentAttributes` like { `
integer number of minutes the contact will be active for before
<note markdown=“1”> To set contact expiry, a ValueMap must be specified containing the
minutes and set a UserId for the User who created a task.
This field can be used to set Contact Expiry as a duration in
Attribute keys can include only alphanumeric, -, and _.
flows.
are standard Amazon Connect attributes. They can be accessed in
segments (unique contact ID) using an attribute map. The attributes
A set of system defined key-value pairs stored on individual contact
@!attribute [rw] segment_attributes
@return [String] : docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks contacts that can be linked by using `RelatedContactId`.
by using `PreviousContactID`. There are no limits to the number of
the individual contact ID, unlike what happens when tasks are linked
to user-defined attributes in the new task contact are limited to
from the related task contact to the new task contact. All updates
together by using `RelatedContactID` copies over contact attributes
The contactId that is [related] to this contact. Linking tasks
@!attribute [rw] related_contact_id
@return [String] : docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html [Create quick connects].
queue quick connect. For more information about quick connects, see
using `QuickConnectId` will use the flow that is defined on agent or
The identifier for the quick connect. Tasks that are created by
@!attribute [rw] quick_connect_id
@return [String] : docs.aws.amazon.com/connect/latest/adminguide/task-templates.html Connect Administrator Guide*.
about task templates, see [Create task templates] in the *Amazon
A unique identifier for the task template. For more information
@!attribute [rw] task_template_id
@return [Time]
It must be within up to 6 days in future.
running the inbound flow. The scheduled time cannot be in the past.
The timestamp, in Unix Epoch seconds format, at which to start
@!attribute [rw] scheduled_time
@return [String] : aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
not need to pass this option.
**A suitable default value is auto-generated.** You should normally
see [Making retries safe with idempotent APIs].
SDK populates this field. For more information about idempotency,
idempotency of the request. If not provided, the Amazon Web Services
A unique, case-sensitive identifier that you provide to ensure the
@!attribute [rw] client_token
@return [String]
Control Panel (CCP).
A description of the task that is shown to an agent in the Contact
@!attribute [rw] description
@return [Hash<String,Types::Reference>]
creation.
`EMAIL`. `ATTACHMENT` is not a supported reference type during task
time of creation: `URL` | `NUMBER` | `STRING` | `DATE` |
Panel (CCP). Tasks can have the following reference types at the
A formatted URL that is shown to an agent in the Contact Control
@!attribute [rw] references
@return [String]
Panel (CCP).
The name of a task that is shown to an agent in the Contact Control
@!attribute [rw] name
@return [Hash<String,String>]
underscore characters.
contact. Attribute keys can include only alphanumeric, dash, and
There can be up to 32,768 UTF-8 bytes across all key-value pairs per
just like any other contact attributes.
standard Amazon Connect attributes, and can be accessed in flows
A custom key-value pair using an attribute map. The attributes are
@!attribute [rw] attributes
@return [String]
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
here in bold:
information**. The ContactFlowId is the last part of the ARN, shown
page, under the name of the flow, choose **Show additional flow
menu go to Routing, Flows. Choose the flow. On the flow
ContactFlowId in the Amazon Connect admin website, on the navigation
The identifier of the flow for initiating the tasks. To see the
@!attribute [rw] contact_flow_id
@return [String]
There can be a maximum of 12 linked task contacts in a chain.
same `PreviousContactID` will affect every contact in the chain.
updates to user-defined attributes to task contacts linked using the
The identifier of the previous chat, voice, or task contact. Any
@!attribute [rw] previous_contact_id
@return [String] : docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html instance ID] in the Amazon Resource Name (ARN) of the instance.
The identifier of the Amazon Connect instance. You can [find the
@!attribute [rw] instance_id

class Aws::Connect::Types::StartTaskContactRequest

Namespace

Included Modules

Defined in