Skip to content

Creates a new task template in the specified Connect Customer instance

Description

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

Usage

connect_create_task_template(InstanceId, Name, Description,
  ContactFlowId, SelfAssignFlowId, Constraints, Defaults, Status, Fields,
  ClientToken)

Arguments

  • InstanceId

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

  • Name

    [required] The name of the task template.

  • Description

    The description of the task template.

  • ContactFlowId

    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.

  • SelfAssignFlowId

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

  • Constraints

    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 create_task_template or update_task_template. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields.

  • Defaults

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

  • Status

    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.

  • Fields

    [required] 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.

  • ClientToken

    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.

Value

A list with the following syntax:

list(
  Id = "string",
  Arn = "string"
)

Request syntax

svc$create_task_template(
  InstanceId = "string",
  Name = "string",
  Description = "string",
  ContactFlowId = "string",
  SelfAssignFlowId = "string",
  Constraints = list(
    RequiredFields = list(
      list(
        Id = list(
          Name = "string"
        )
      )
    ),
    ReadOnlyFields = list(
      list(
        Id = list(
          Name = "string"
        )
      )
    ),
    InvisibleFields = list(
      list(
        Id = list(
          Name = "string"
        )
      )
    )
  ),
  Defaults = list(
    DefaultFieldValues = list(
      list(
        Id = list(
          Name = "string"
        ),
        DefaultValue = "string"
      )
    )
  ),
  Status = "ACTIVE"|"INACTIVE",
  Fields = list(
    list(
      Id = list(
        Name = "string"
      ),
      Description = "string",
      Type = "NAME"|"DESCRIPTION"|"SCHEDULED_TIME"|"QUICK_CONNECT"|"URL"|"NUMBER"|"TEXT"|"TEXT_AREA"|"DATE_TIME"|"BOOLEAN"|"SINGLE_SELECT"|"EMAIL"|"SELF_ASSIGN"|"EXPIRY_DURATION",
      SingleSelectOptions = list(
        "string"
      )
    )
  ),
  ClientToken = "string"
)