[ aws . connect ]

create-task-template

Description

Creates a new task template in the specified Amazon Connect instance.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-task-template
--instance-id <value>
--name <value>
[--description <value>]
[--contact-flow-id <value>]
[--constraints <value>]
[--defaults <value>]
[--status <value>]
--fields <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--name (string)

The name of the task template.

--description (string)

The description of the task template.

--contact-flow-id (string)

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

--constraints (structure)

Constraints that are applicable to the fields listed.

RequiredFields -> (list)

Lists the fields that are required to be filled by agents.

(structure)

Information about a required field.

Id -> (structure)

The unique identifier for the field.

Name -> (string)

The name of the task template field.

ReadOnlyFields -> (list)

Lists the fields that are read-only to agents, and cannot be edited.

(structure)

Indicates a field that is read-only to an agent.

Id -> (structure)

Identifier of the read-only field.

Name -> (string)

The name of the task template field.

InvisibleFields -> (list)

Lists the fields that are invisible to agents.

(structure)

A field that is invisible to an agent.

Id -> (structure)

Identifier of the invisible field.

Name -> (string)

The name of the task template field.

JSON Syntax:

{
  "RequiredFields": [
    {
      "Id": {
        "Name": "string"
      }
    }
    ...
  ],
  "ReadOnlyFields": [
    {
      "Id": {
        "Name": "string"
      }
    }
    ...
  ],
  "InvisibleFields": [
    {
      "Id": {
        "Name": "string"
      }
    }
    ...
  ]
}

--defaults (structure)

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

DefaultFieldValues -> (list)

Default value for the field.

(structure)

Describes a default field and its corresponding value.

Id -> (structure)

Identifier of a field.

Name -> (string)

The name of the task template field.

DefaultValue -> (string)

Default value for the field.

JSON Syntax:

{
  "DefaultFieldValues": [
    {
      "Id": {
        "Name": "string"
      },
      "DefaultValue": "string"
    }
    ...
  ]
}

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

Possible values:

• ACTIVE

• INACTIVE

--fields (list)

Fields that are part of the template.

(structure)

Describes a single task template field.

Id -> (structure)

The unique identifier for the field.

Name -> (string)

The name of the task template field.

Description -> (string)

The description of the field.

Type -> (string)

Indicates the type of field.

SingleSelectOptions -> (list)

A list of options for a single select field.

(string)

Shorthand Syntax:

Id={Name=string},Description=string,Type=string,SingleSelectOptions=string,string ...

JSON Syntax:

[
  {
    "Id": {
      "Name": "string"
    },
    "Description": "string",
    "Type": "NAME"|"DESCRIPTION"|"SCHEDULED_TIME"|"QUICK_CONNECT"|"URL"|"NUMBER"|"TEXT"|"TEXT_AREA"|"DATE_TIME"|"BOOLEAN"|"SINGLE_SELECT"|"EMAIL",
    "SingleSelectOptions": ["string", ...]
  }
  ...
]

--client-token (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

Id -> (string)

The identifier of the task template resource.

Arn -> (string)

The Amazon Resource Name (ARN) for the task template resource.