Skip to content

GetTaskTemplateResponse

Source code in docs_src/capo_connect/types/get_task_template_response.py
class GetTaskTemplateResponse(TypedDict, closed=True):
    instance_id: NotRequired["capo_connect.types.instance_id.InstanceId"]
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    id: "capo_connect.types.task_template_id.TaskTemplateId"
    """<p>A unique identifier for the task template.</p>"""
    arn: "capo_connect.types.task_template_arn.TaskTemplateArn"
    """<p>The Amazon Resource Name (ARN).</p>"""
    name: "capo_connect.types.task_template_name.TaskTemplateName"
    """<p>The name of the task template.</p>"""
    description: NotRequired[
        "capo_connect.types.task_template_description.TaskTemplateDescription"
    ]
    """<p>The description of the task template.</p>"""
    contact_flow_id: NotRequired["capo_connect.types.contact_flow_id.ContactFlowId"]
    """<p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>"""
    self_assign_flow_id: NotRequired["capo_connect.types.contact_flow_id.ContactFlowId"]
    """<p>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</p>"""
    constraints: NotRequired[
        "capo_connect.types.task_template_constraints.TaskTemplateConstraints"
    ]
    """<p>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 <code>CreateTaskTemplate</code> or <code>UpdateTaskTemplate</code>. The <code>RequiredFields</code> array must contain at least one element, and the field of type <code>NAME</code> must be included in <code>RequiredFields</code>.</p>"""
    defaults: NotRequired[
        "capo_connect.types.task_template_defaults.TaskTemplateDefaults"
    ]
    """<p>The default values for fields when a task is created by referencing this template.</p>"""
    fields: NotRequired["capo_connect.types.task_template_fields.TaskTemplateFields"]
    """<p>Fields that are part of the template.</p>"""
    status: NotRequired["capo_connect.types.task_template_status.TaskTemplateStatus"]
    """<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>"""
    last_modified_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when the task template was last modified.</p>"""
    created_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when the task template was created.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>"""

arn instance-attribute

The Amazon Resource Name (ARN).

constraints instance-attribute

constraints: NotRequired[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.

contact_flow_id instance-attribute

contact_flow_id: NotRequired[ContactFlowId]

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

created_time instance-attribute

created_time: NotRequired[Timestamp]

The timestamp when the task template was created.

defaults instance-attribute

defaults: NotRequired[TaskTemplateDefaults]

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

description instance-attribute

description: NotRequired[TaskTemplateDescription]

The description of the task template.

fields instance-attribute

fields: NotRequired[TaskTemplateFields]

Fields that are part of the template.

id instance-attribute

A unique identifier for the task template.

instance_id instance-attribute

instance_id: NotRequired[InstanceId]

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

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The timestamp when the task template was last modified.

name instance-attribute

The name of the task template.

self_assign_flow_id instance-attribute

self_assign_flow_id: NotRequired[ContactFlowId]

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

status instance-attribute

status: NotRequired[TaskTemplateStatus]

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.

tags instance-attribute

tags: NotRequired[TagMap]

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