delete_session¶
Operation¶
delete_session
¶
delete_session(request: DeleteSessionInput | DeleteSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteSessionInputDict]) -> DeleteSessionOutput
Deletes a session that you ended. You can't delete a session with an
ACTIVE status. To delete an active session, you must first end it with
the
EndSession
API operation. For more information about sessions, see Store and
retrieve conversation history and context with Amazon Bedrock
sessions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteSessionInput | DeleteSessionInputDict | 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[DeleteSessionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteSessionOutput
|
An instance of |
delete_session
async
¶
delete_session(request: DeleteSessionInput | DeleteSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteSessionInputDict]) -> DeleteSessionOutput
Deletes a session that you ended. You can't delete a session with an
ACTIVE status. To delete an active session, you must first end it with
the
EndSession
API operation. For more information about sessions, see Store and
retrieve conversation history and context with Amazon Bedrock
sessions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteSessionInput | DeleteSessionInputDict | 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[DeleteSessionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteSessionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
DeleteSessionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteSessionOutput structure.