QConnect / Client / list_message_template_versions

list_message_template_versions#

QConnect.Client.list_message_template_versions(**kwargs)#

Lists all the available versions for the specified Amazon Q in Connect message template.

See also: AWS API Documentation

Request Syntax

response = client.list_message_template_versions(
    knowledgeBaseId='string',
    maxResults=123,
    messageTemplateId='string',
    nextToken='string'
)
Parameters:

  • knowledgeBaseId (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of results to return per page.

  • messageTemplateId (string) –

    [REQUIRED]

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

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

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) –

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

Exceptions

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException

  • QConnect.Client.exceptions.ThrottlingException