Class: Aws::Connect::Types::StartTaskContactRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::StartTaskContactRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :description]

Instance Attribute Summary

• #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] to this contact.

• #scheduled_time ⇒ Time

  The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow.

• #segment_attributes ⇒ Hash<String,Types::SegmentAttributeValue>

  A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map.

• #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.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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.

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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, 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

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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).

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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.

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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).

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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].

[1]: docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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.

Returns:

• (Hash<String,Types::Reference>)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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`.

[1]: docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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.

Returns:

• (Time)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#segment_attributes ⇒ Hash<String,Types::SegmentAttributeValue>

A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

Attribute keys can include only alphanumeric, -, and _.

This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.

<note markdown=“1”> To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with ‘SegmentAttributes` like { ` “connect:ContactExpiry”: : { “ExpiryDuration”: { “ValueInteger”: 135}}}`.

To set the created by user, a valid AgentResourceId must be

supplied, with ‘SegmentAttributes` like { `“connect:CreatedByUser” { “ValueString”: “arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”}}}`.

</note>

Returns:

• (Hash<String,Types::SegmentAttributeValue>)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  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*.

[1]: docs.aws.amazon.com/connect/latest/adminguide/task-templates.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 22387

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,
  :segment_attributes)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end