Class: Aws::Connect::Types::UpdateTaskTemplateRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::UpdateTaskTemplateRequest

Defined in:

gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #constraints ⇒ Types::TaskTemplateConstraints

  Constraints that are applicable to the fields listed.

• #contact_flow_id ⇒ String

  The identifier of the flow that runs by default when a task is created by referencing this template.

• #defaults ⇒ Types::TaskTemplateDefaults

  The default values for fields when a task is created by referencing this template.

• #description ⇒ String

  The description of the task template.

• #fields ⇒ Array<Types::TaskTemplateField>

  Fields that are part of the template.

• #instance_id ⇒ String

  The identifier of the Connect Customer instance.

• #name ⇒ String

  The name of the task template.

• #self_assign_flow_id ⇒ String

  The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.

• #status ⇒ String

  Marks a template as ACTIVE or INACTIVE for a task to refer to it.

• #task_template_id ⇒ String

  A unique identifier for the task template.

Instance Attribute Details

#constraints ⇒ Types::TaskTemplateConstraints

Constraints that are applicable to the fields listed. Although this parameter is marked as optional in the API model, the service requires it when calling CreateTaskTemplate or UpdateTaskTemplate. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields.

Returns:

• (Types::TaskTemplateConstraints)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#contact_flow_id ⇒ String

The identifier of the flow that runs by default when a task is created by referencing this template.

Although this parameter is marked as optional, the request must contain either a ContactFlowId or a field of type QUICK_CONNECT.

Returns:

• (String)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#defaults ⇒ Types::TaskTemplateDefaults

The default values for fields when a task is created by referencing this template.

Returns:

• (Types::TaskTemplateDefaults)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the task template.

Returns:

• (String)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#fields ⇒ Array<Types::TaskTemplateField>

Fields that are part of the template.

The request must contain exactly one field of type NAME. This field must also be listed in the RequiredFields array within the Constraints parameter.

Returns:

• (Array<Types::TaskTemplateField>)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

• (String)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the task template.

Returns:

• (String)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#self_assign_flow_id ⇒ String

The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.

Returns:

• (String)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

Although this parameter is marked as optional, the service requires it when calling UpdateTaskTemplate.

Returns:

• (String)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#task_template_id ⇒ String

A unique identifier for the task template.

Returns:

• (String)

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

class UpdateTaskTemplateRequest < Struct.new(
  :task_template_id,
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end