Skip to content

delete_conversation

Operation

delete_conversation

delete_conversation(request: DeleteConversationInput | DeleteConversationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteConversationInputDict]) -> DeleteConversationOutput

Deletes an Amazon Q Business web experience conversation.

Parameters:

Name Type Description Default
request DeleteConversationInput | DeleteConversationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DeleteConversationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteConversationOutput

An instance of DeleteConversationOutput.

delete_conversation async

delete_conversation(request: DeleteConversationInput | DeleteConversationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteConversationInputDict]) -> DeleteConversationOutput

Deletes an Amazon Q Business web experience conversation.

Parameters:

Name Type Description Default
request DeleteConversationInput | DeleteConversationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DeleteConversationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteConversationOutput

An instance of DeleteConversationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteConversationInputDict

Bases: TypedDict

Dictionary form of DeleteConversationInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application associated with the conversation.

conversation_id instance-attribute
conversation_id: Required[str]

The identifier of the Amazon Q Business web experience conversation being deleted.

user_id instance-attribute
user_id: str | None

The identifier of the user who is deleting the conversation.

DeleteConversationInput dataclass

Bases: _SerdeShape

Dataclass for DeleteConversationInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application associated with the conversation.

conversation_id class-attribute instance-attribute
conversation_id: str | None = ...

The identifier of the Amazon Q Business web experience conversation being deleted.

user_id class-attribute instance-attribute
user_id: str | None = ...

The identifier of the user who is deleting the conversation.

Output

DeleteConversationOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteConversationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.