Class: Aws::Connect::Types::GetTaskTemplateResponse

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::GetTaskTemplateResponse

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN).

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

• #created_time ⇒ Time

  The timestamp when the task template was created.

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

• #id ⇒ String

  A unique identifier for the task template.

• #instance_id ⇒ String

  The identifier of the Connect Customer instance.

• #last_modified_time ⇒ Time

  The timestamp when the task template was last modified.

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

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN).

Returns:

• (String)

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

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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 19876

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  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.

Returns:

• (String)

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

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The timestamp when the task template was created.

Returns:

• (Time)

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

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  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 19876

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  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 19876

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#fields ⇒ Array<Types::TaskTemplateField>

Fields that are part of the template.

Returns:

• (Array<Types::TaskTemplateField>)

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

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

A unique identifier for the task template.

Returns:

• (String)

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

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  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 19876

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The timestamp when the task template was last modified.

Returns:

• (Time)

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

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  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 19876

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  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 19876

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  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.

Returns:

• (String)

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

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

• (Hash<String,String>)

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

class GetTaskTemplateResponse < Struct.new(
  :instance_id,
  :id,
  :arn,
  :name,
  :description,
  :contact_flow_id,
  :self_assign_flow_id,
  :constraints,
  :defaults,
  :fields,
  :status,
  :last_modified_time,
  :created_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end