QConnect / Client / deactivate_message_template

deactivate_message_template

QConnect.Client.deactivate_message_template(**kwargs)

Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.

See also: AWS API Documentation

Request Syntax

response = client.deactivate_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 deactivate.

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 has been deactivated.

Exceptions

• QConnect.Client.exceptions.ConflictException

• QConnect.Client.exceptions.ValidationException

• QConnect.Client.exceptions.AccessDeniedException

• QConnect.Client.exceptions.ResourceNotFoundException

• QConnect.Client.exceptions.ThrottlingException