deactivate_message_template ¶

deactivate_message_template(
    knowledge_base_id: UuidOrArn,
    message_template_id: UuidOrArnOrEitherWithQualifier,
    version_number: Version,
    *,
    config_overrides: Optional[QConnectClientConfig] = None,
) -> DeactivateMessageTemplateResponse

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.

Parameters:

knowledge_base_id (UuidOrArn) –

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
message_template_id (UuidOrArnOrEitherWithQualifier) –

The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
version_number (Version) –

The version number of the message template version to deactivate.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
ResourceNotFoundException –

The specified resource does not exist.
ThrottlingException –

The throttling limit has been exceeded.
ValidationException –

The input fails to satisfy the constraints specified by a service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_qconnect/_services/q_connect.py

def deactivate_message_template(
    self,
    knowledge_base_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn",
    message_template_id: "capo_qconnect.types.uuid_or_arn_or_either_with_qualifier.UuidOrArnOrEitherWithQualifier",
    version_number: "capo_qconnect.types.version.Version",
    *,
    config_overrides: Optional[QConnectClientConfig] = None,
) -> "capo_qconnect.types.deactivate_message_template_response.DeactivateMessageTemplateResponse":
    """<p>Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the <code>$ACTIVE_VERSION</code> qualifier to reference the version in active status.</p>

    Args:
        knowledge_base_id: <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
        message_template_id: <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
        version_number: <p>The version number of the message template version to deactivate.</p>

    Raises:
        capo_qconnect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_qconnect.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
        capo_qconnect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_qconnect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_qconnect.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by a service.</p>
        capo_qconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qconnect.types.deactivate_message_template_request.DeactivateMessageTemplateRequest]",
    ) -> OperationResponse[
        "capo_qconnect.types.deactivate_message_template_response.DeactivateMessageTemplateResponse"
    ]:
        import capo_qconnect._operations.wisdom_service.deactivate_message_template

        output, http_response = (
            capo_qconnect._operations.wisdom_service.deactivate_message_template.deactivate_message_template(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeactivateMessageTemplate")
    )
    input_: capo_qconnect.types.deactivate_message_template_request.DeactivateMessageTemplateRequest = {
        "knowledge_base_id": knowledge_base_id,
        "message_template_id": message_template_id,
        "version_number": version_number,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output