QConnect / Client / delete_message_template

delete_message_template#

QConnect.Client.delete_message_template(**kwargs)#

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

See also: AWS API Documentation

Request Syntax

response = client.delete_message_template(
    knowledgeBaseId='string',
    messageTemplateId='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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • QConnect.Client.exceptions.ConflictException

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException

  • QConnect.Client.exceptions.ThrottlingException