QConnect / Paginator / ListMessageTemplateVersions

ListMessageTemplateVersions

class QConnect.Paginator.ListMessageTemplateVersions

paginator = client.get_paginator('list_message_template_versions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QConnect.Client.list_message_template_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    knowledgeBaseId='string',
    messageTemplateId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• knowledgeBaseId (string) –

  [REQUIRED]

  The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

• messageTemplateId (string) –

  [REQUIRED]

  The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

• 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

{
    'messageTemplateVersionSummaries': [
        {
            'channelSubtype': 'EMAIL'|'SMS',
            'isActive': True|False,
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'messageTemplateArn': 'string',
            'messageTemplateId': 'string',
            'name': 'string',
            'versionNumber': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • messageTemplateVersionSummaries (list) –

    Summary information about the versions of a message template.

    • (dict) –

      The summary of the message template version.

      • channelSubtype (string) –

        The channel subtype this message template applies to.

      • isActive (boolean) –

        Whether the version of the message template is activated.

      • knowledgeBaseArn (string) –

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId (string) –

        The identifier of the knowledge base.

      • messageTemplateArn (string) –

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

      • messageTemplateId (string) –

        The identifier of the message template.

      • name (string) –

        The name of the message template.

      • versionNumber (integer) –

        The version number of the message template version.

  • NextToken (string) –

    A token to resume pagination.