end_session¶
Operation¶
end_session
¶
end_session(request: EndSessionInput | EndSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EndSessionInputDict]) -> EndSessionOutput
Ends the session. After you end a session, you can still access its content but you can't add to it. To delete the session and it's content, you use the DeleteSession 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
|
EndSessionInput | EndSessionInputDict | 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[EndSessionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EndSessionOutput
|
An instance of |
end_session
async
¶
end_session(request: EndSessionInput | EndSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EndSessionInputDict]) -> EndSessionOutput
Ends the session. After you end a session, you can still access its content but you can't add to it. To delete the session and it's content, you use the DeleteSession 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
|
EndSessionInput | EndSessionInputDict | 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[EndSessionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EndSessionOutput
|
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.
EndSessionInput
dataclass
¶
Output¶
EndSessionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for EndSessionOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
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.