Skip to content

delete_attachment

delete_attachment(
    application_id: ApplicationId,
    conversation_id: ConversationId,
    attachment_id: AttachmentId,
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    user_id: Optional[UserId] = None,
) -> DeleteAttachmentResponse

Deletes an attachment associated with a specific Amazon Q Business conversation.

Parameters:

  • application_id (ApplicationId) –

    The unique identifier for the Amazon Q Business application environment.

  • conversation_id (ConversationId) –

    The unique identifier of the conversation.

  • attachment_id (AttachmentId) –

    The unique identifier for the attachment.

  • user_id (Optional[UserId], default: None ) –

    The unique identifier of the user involved in the conversation.

Raises:

  • AccessDeniedException –

    You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • InternalServerException –

    An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

  • LicenseNotFoundException –

    You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

  • ResourceNotFoundException –

    The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • ThrottlingException –

    The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException –

    The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • UnknownServiceError –

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

Source code in docs_src/capo_qbusiness/_services/q_business.py
def delete_attachment(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    conversation_id: "capo_qbusiness.types.conversation_id.ConversationId",
    attachment_id: "capo_qbusiness.types.attachment_id.AttachmentId",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    user_id: Optional["capo_qbusiness.types.user_id.UserId"] = None,
) -> "capo_qbusiness.types.delete_attachment_response.DeleteAttachmentResponse":
    """<p>Deletes an attachment associated with a specific Amazon Q Business conversation.</p>

    Args:
        application_id: <p>The unique identifier for the Amazon Q Business application environment.</p>
        conversation_id: <p>The unique identifier of the conversation.</p>
        attachment_id: <p>The unique identifier for the attachment.</p>
        user_id: <p>The unique identifier of the user involved in the conversation.</p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.license_not_found_exception.LicenseNotFoundException: <p>You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qbusiness.types.delete_attachment_request.DeleteAttachmentRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.delete_attachment_response.DeleteAttachmentResponse"
    ]:
        import capo_qbusiness._operations.expert_q.delete_attachment

        output, http_response = (
            capo_qbusiness._operations.expert_q.delete_attachment.delete_attachment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteAttachment")
    )
    input_: capo_qbusiness.types.delete_attachment_request.DeleteAttachmentRequest = {
        "application_id": application_id,
        "conversation_id": conversation_id,
        "attachment_id": attachment_id,
    }
    if user_id is not None:
        input_["user_id"] = user_id

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