get_agent_memory¶
Operation¶
get_agent_memory
¶
get_agent_memory(request: GetAgentMemoryInput | GetAgentMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentMemoryInputDict]) -> GetAgentMemoryOutput
Gets the sessions stored in the memory of the agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetAgentMemoryInput | GetAgentMemoryInputDict | 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[GetAgentMemoryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetAgentMemoryOutput
|
An instance of |
get_agent_memory
async
¶
get_agent_memory(request: GetAgentMemoryInput | GetAgentMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentMemoryInputDict]) -> GetAgentMemoryOutput
Gets the sessions stored in the memory of the agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetAgentMemoryInput | GetAgentMemoryInputDict | 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[GetAgentMemoryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetAgentMemoryOutput
|
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.
GetAgentMemoryInputDict
¶
Bases: TypedDict
Dictionary form of GetAgentMemoryInput.
Attributes¶
agent_alias_id
instance-attribute
¶
The unique identifier of an alias of an agent.
agent_id
instance-attribute
¶
The unique identifier of the agent to which the alias belongs.
GetAgentMemoryInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetAgentMemoryInput structure.
Attributes¶
agent_alias_id
class-attribute
instance-attribute
¶
agent_alias_id: str | None = ...
The unique identifier of an alias of an agent.
agent_id
class-attribute
instance-attribute
¶
agent_id: str | None = ...
The unique identifier of the agent to which the alias belongs.
max_items
class-attribute
instance-attribute
¶
max_items: int | None = ...
The maximum number of items to return in the response. If the total
number of results is greater than this value, use the token returned in
the response in the nextToken field when making another request to
return the next batch of results.
Output¶
GetAgentMemoryOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetAgentMemoryOutput structure.
Attributes¶
memory_contents
class-attribute
instance-attribute
¶
Contains details of the sessions stored in the memory
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
If the total number of results is greater than the maxItems value
provided in the request, use this token when making another request in
the nextToken field to return the next batch of results.
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.