Class: Aws::Connect::Types::CreateTaskTemplateRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::CreateTaskTemplateRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #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 Amazon Connect instance.

• #name ⇒ String

  The name of the task template.

• #status ⇒ String

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

Instance Attribute Details

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

Returns:

• (String)

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

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

#constraints ⇒ Types::TaskTemplateConstraints

Constraints that are applicable to the fields listed.

Returns:

• (Types::TaskTemplateConstraints)

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

class CreateTaskTemplateRequest < Struct.new(
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields,
  :client_token)
  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 3633

class CreateTaskTemplateRequest < Struct.new(
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields,
  :client_token)
  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 3633

class CreateTaskTemplateRequest < Struct.new(
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields,
  :client_token)
  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 3633

class CreateTaskTemplateRequest < Struct.new(
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields,
  :client_token)
  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 3633

class CreateTaskTemplateRequest < Struct.new(
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields,
  :client_token)
  SENSITIVE = []
  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.

Returns:

• (String)

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

class CreateTaskTemplateRequest < Struct.new(
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields,
  :client_token)
  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 3633

class CreateTaskTemplateRequest < Struct.new(
  :instance_id,
  :name,
  :description,
  :contact_flow_id,
  :constraints,
  :defaults,
  :status,
  :fields,
  :client_token)
  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 3633

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