Deletes an Amazon Q Business web experience conversation.
Parameters:
-
conversation_id
(ConversationId)
–
The identifier of the Amazon Q Business web experience conversation being deleted.
-
application_id
(ApplicationId)
–
The identifier of the Amazon Q Business application associated with the conversation.
-
user_id
(Optional[UserId], default:
None
)
–
The identifier of the user who is deleting 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.
-
ConflictException
–
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources 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_conversation(
self,
conversation_id: "capo_qbusiness.types.conversation_id.ConversationId",
application_id: "capo_qbusiness.types.application_id.ApplicationId",
*,
config_overrides: Optional[QBusinessClientConfig] = None,
user_id: Optional["capo_qbusiness.types.user_id.UserId"] = None,
) -> "capo_qbusiness.types.delete_conversation_response.DeleteConversationResponse":
"""<p>Deletes an Amazon Q Business web experience conversation.</p>
Args:
conversation_id: <p>The identifier of the Amazon Q Business web experience conversation being deleted.</p>
application_id: <p>The identifier of the Amazon Q Business application associated with the conversation.</p>
user_id: <p>The identifier of the user who is deleting 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.conflict_exception.ConflictException: <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources 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_conversation_request.DeleteConversationRequest]",
) -> OperationResponse[
"capo_qbusiness.types.delete_conversation_response.DeleteConversationResponse"
]:
import capo_qbusiness._operations.expert_q.delete_conversation
output, http_response = (
capo_qbusiness._operations.expert_q.delete_conversation.delete_conversation(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteConversation")
)
input_: capo_qbusiness.types.delete_conversation_request.DeleteConversationRequest = {
"conversation_id": conversation_id,
"application_id": application_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
|