Class: Aws::Connect::Types::StartTaskContactRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Connect::Types::StartTaskContactRequest
- Defined in:
- gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:name, :description]
Instance Attribute Summary collapse
-
#attributes ⇒ Hash<String,String>
A custom key-value pair using an attribute map.
-
#client_token ⇒ String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
#contact_flow_id ⇒ String
The identifier of the flow for initiating the tasks.
-
#description ⇒ String
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
-
#instance_id ⇒ String
The identifier of the Amazon Connect instance.
-
#name ⇒ String
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
-
#previous_contact_id ⇒ String
The identifier of the previous chat, voice, or task contact.
-
#quick_connect_id ⇒ String
The identifier for the quick connect.
-
#references ⇒ Hash<String,Types::Reference>
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
-
#related_contact_id ⇒ String
The contactId that is [related][1] to this contact.
-
#scheduled_time ⇒ Time
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow.
-
#task_template_id ⇒ String
A unique identifier for the task template.
Instance Attribute Details
#attributes ⇒ Hash<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.
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#client_token ⇒ 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.
A suitable default value is auto-generated. You should normally not need to pass this option.
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#contact_flow_id ⇒ 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
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#description ⇒ String
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#instance_id ⇒ String
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#name ⇒ String
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#previous_contact_id ⇒ 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.
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#quick_connect_id ⇒ 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.
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#references ⇒ Hash<String,Types::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.
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#related_contact_id ⇒ 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
.
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#scheduled_time ⇒ Time
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.
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |
#task_template_id ⇒ String
A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17587 class StartTaskContactRequest < Struct.new( :instance_id, :previous_contact_id, :contact_flow_id, :attributes, :name, :references, :description, :client_token, :scheduled_time, :task_template_id, :quick_connect_id, :related_contact_id) SENSITIVE = [:name, :description] include Aws::Structure end |