Skip to content

get_memory

Operation

get_memory

get_memory(request: GetMemoryInput | GetMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMemoryInputDict]) -> GetMemoryOutput

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

Parameters:

Name Type Description Default
request GetMemoryInput | GetMemoryInputDict | 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[GetMemoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMemoryOutput

An instance of GetMemoryOutput.

get_memory async

get_memory(request: GetMemoryInput | GetMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMemoryInputDict]) -> GetMemoryOutput

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

Parameters:

Name Type Description Default
request GetMemoryInput | GetMemoryInputDict | 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[GetMemoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMemoryOutput

An instance of GetMemoryOutput.

Input

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

GetMemoryInputDict

Bases: TypedDict

Dictionary form of GetMemoryInput.

Attributes

memory_id instance-attribute
memory_id: Required[str]

The unique identifier of the memory to retrieve.

view instance-attribute
view: str | None

The level of detail to return for the memory.

GetMemoryInput dataclass

Bases: _SerdeShape

Dataclass for GetMemoryInput structure.

Attributes

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

The unique identifier of the memory to retrieve.

view class-attribute instance-attribute
view: str = ...

The level of detail to return for the memory.

Output

GetMemoryOutput dataclass

Bases: _SerdeShape

Dataclass for GetMemoryOutput structure.

Attributes

memory instance-attribute
memory: Memory

The retrieved AgentCore Memory resource details.

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.