View a markdown version of this page

SystemMetadata - Amazon OpenSearch Memory

SystemMetadata

System-generated provenance for a memory or event: the owning actor and session, and the creation and last-update timestamps. SearchMemories, SearchEvents, ListMemories, and GetMemory return the same block.

ListMemories and GetMemory always return createdAt and updatedAt. The search operations return what is recorded and omit the block when nothing is.

In a query, the timestamps are system_metadata.created_at and system_metadata.updated_at. Scope by owner with the top-level parameters (actorId on the search operations, actorIds on ListMemories) and sessionIds (SearchEvents and ListMemories). The search operations reject actor and session fields inside the query or sort.

Contents

actorId

The owning actor. Absent when none was recorded.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

Required: No

createdAt

When the record was created. Always present on ListMemories and GetMemory. It can be absent from search results.

Type: Timestamp

Required: No

sessionId

The owning session. Absent when none was recorded.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

Required: No

updatedAt

When the record was last updated. Equals createdAt for a record that has never been updated, and always for a SearchEvents result.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: