Connect / Paginator / ListTaskTemplates

ListTaskTemplates

class Connect.Paginator.ListTaskTemplates

paginator = client.get_paginator('list_task_templates')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_task_templates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    Status='ACTIVE'|'INACTIVE',
    Name='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.