Skip to content

Update Task Template

connect_update_task_template R Documentation

Updates details about a specific task template in the specified Amazon Connect instance

Description

Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

Usage

connect_update_task_template(TaskTemplateId, InstanceId, Name,
  Description, ContactFlowId, Constraints, Defaults, Status, Fields)

Arguments

TaskTemplateId

[required] A unique identifier for the task template.

InstanceId

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

Name

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.

Constraints

Constraints that are applicable to the fields listed.

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

Fields that are part of the template.

Value

A list with the following syntax: 

list(
  InstanceId = "string",
  Id = "string",
  Arn = "string",
  Name = "string",
  Description = "string",
  ContactFlowId = "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"
      )
    )
  ),
  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",
      SingleSelectOptions = list(
        "string"
      )
    )
  ),
  Status = "ACTIVE"|"INACTIVE",
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  ),
  CreatedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$update_task_template(
  TaskTemplateId = "string",
  InstanceId = "string",
  Name = "string",
  Description = "string",
  ContactFlowId = "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",
      SingleSelectOptions = list(
        "string"
      )
    )
  )
)