Skip to content

AgenticRetrieveMemoryConfigurationDict

Dictionary Type

AgenticRetrieveMemoryConfigurationDict

Bases: TypedDict

Dictionary form of AgenticRetrieveMemoryConfiguration.

Attributes

memory_id instance-attribute
memory_id: Required[str]

The identifier of the AgentCore Memory resource to use. The resource must exist in your account and be in the ACTIVE state.

persistence_mode instance-attribute
persistence_mode: str | None

Specifies whether the agent-generated answer is written back to the given short-term memory session, and applies only when sessionBinding is set. Valid values:

  • DEFAULT (default) -- Specifies that the question and the agent-generated answer are persisted to the session as a single event. This value requires generateResponse to be true.

  • NONE -- Specifies that the session is left unchanged.

retrieval_configs instance-attribute

Specifies the long-term memory configuration the agent can retrieve from. The agent decides whether to retrieve and composes its own query. This field currently accepts at most one entry.

session_binding instance-attribute

The short-term memory session whose history is restored for this retrieval. To persist the agent-generated answer to the session, omit persistenceMode or set it to DEFAULT. To leave the session unchanged, set persistenceMode to NONE. Supply session history through the existing messages parameter or through short-term memory, but not both.