QConnect / Client / activate_message_template

activate_message_template#

QConnect.Client.activate_message_template(**kwargs)#

Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.

See also: AWS API Documentation

Request Syntax

response = client.activate_message_template(
    knowledgeBaseId='string',
    messageTemplateId='string',
    versionNumber=123
)
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.

  • versionNumber (integer) –

    [REQUIRED]

    The version number of the message template version to activate.

Return type:

dict

Returns:

Response Syntax

{
    'messageTemplateArn': 'string',
    'messageTemplateId': 'string',
    'versionNumber': 123
}

Response Structure

  • (dict) –

    • messageTemplateArn (string) –

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

    • messageTemplateId (string) –

      The identifier of the message template.

    • versionNumber (integer) –

      The version number of the message template version that is activated.

Exceptions

  • QConnect.Client.exceptions.ConflictException

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException

  • QConnect.Client.exceptions.ThrottlingException