Connect / Client / list_task_templates

list_task_templates#

Connect.Client.list_task_templates(**kwargs)#

Lists task templates for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_task_templates(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    Status='ACTIVE'|'INACTIVE',
    Name='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

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

  • NextToken (string) –

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    Warning

    It is not expected that you set this because the value returned in the previous response is always null.

  • MaxResults (integer) –

    The maximum number of results to return per page.

    Warning

    It is not expected that you set this.

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

  • Name (string) – The name of the task template.

Return type:

dict

Returns:

Response Syntax

{
    'TaskTemplates': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Status': 'ACTIVE'|'INACTIVE',
            'LastModifiedTime': datetime(2015, 1, 1),
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TaskTemplates (list) –

      Provides details about a list of task templates belonging to an instance.

      • (dict) –

        Contains summary information about the task template.

        • Id (string) –

          A unique identifier for the task template.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the task template.

        • Name (string) –

          The name of the task template.

        • Description (string) –

          The description of the task template.

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

        • LastModifiedTime (datetime) –

          The timestamp when the task template was last modified.

        • CreatedTime (datetime) –

          The timestamp when the task template was created.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

      Warning

      This is always returned as a null in the response.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException