delete_message_template `async` ¶

delete_message_template(
    knowledge_base_id: UuidOrArn,
    message_template_id: UuidOrArnOrEitherWithQualifier,
    *,
    config_overrides: Optional[AsyncQConnectClientConfig] = None,
) -> DeleteMessageTemplateResponse

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.

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.

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/async_q_connect.py

async def delete_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",
    *,
    config_overrides: Optional[AsyncQConnectClientConfig] = None,
) -> "capo_qconnect.types.delete_message_template_response.DeleteMessageTemplateResponse":
    """<p>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 <code>&lt;message-template-id&gt;:&lt;versionNumber&gt;</code> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.</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.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qconnect.types.delete_message_template_request.DeleteMessageTemplateRequest]",
    ) -> AsyncOperationResponse[
        "capo_qconnect.types.delete_message_template_response.DeleteMessageTemplateResponse"
    ]:
        import capo_qconnect._operations.wisdom_service.delete_message_template

        (
            output,
            http_response,
        ) = await capo_qconnect._operations.wisdom_service.delete_message_template.async_delete_message_template(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteMessageTemplate")
    )
    input_: capo_qconnect.types.delete_message_template_request.DeleteMessageTemplateRequest = {
        "knowledge_base_id": knowledge_base_id,
        "message_template_id": message_template_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_message_template async ¶

delete_message_template `async` ¶