BedrockAgentCoreDataPlaneFrontingLayer / Client / get_event
get_event¶
- BedrockAgentCoreDataPlaneFrontingLayer.Client.get_event(**kwargs)¶
Retrieves information about a specific event in a memory store.
To use this operation, you must have the
genesismemory:GetEvent
permission.See also: AWS API Documentation
Request Syntax
response = client.get_event( memoryId='string', sessionId='string', actorId='string', eventId='string' )
- Parameters:
memoryId (string) –
[REQUIRED]
The identifier of the memory store containing the event.
sessionId (string) –
[REQUIRED]
The identifier of the session containing the event.
actorId (string) –
[REQUIRED]
The identifier of the actor associated with the event.
eventId (string) –
[REQUIRED]
The identifier of the event to retrieve.
- Return type:
dict
- Returns:
Response Syntax
{ 'event': { 'memoryId': 'string', 'actorId': 'string', 'sessionId': 'string', 'eventId': 'string', 'eventTimestamp': datetime(2015, 1, 1), 'payload': [ { 'conversational': { 'content': { 'text': 'string' }, 'role': 'ASSISTANT'|'USER'|'TOOL'|'OTHER' }, 'blob': {...}|[...]|123|123.4|'string'|True|None }, ], 'branch': { 'rootEventId': 'string', 'name': 'string' } } }
Response Structure
(dict) –
event (dict) –
The requested event information.
memoryId (string) –
The identifier of the memory store containing the event.
actorId (string) –
The identifier of the actor associated with the event.
sessionId (string) –
The identifier of the session containing the event.
eventId (string) –
The unique identifier of the event.
eventTimestamp (datetime) –
The timestamp when the event occurred.
payload (list) –
The content payload of the event.
(dict) –
Contains the payload content for an event.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
conversational
,blob
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
conversational (dict) –
The conversational content of the payload.
content (dict) –
The content of the conversation message.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
text
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
text (string) –
The text content of the memory item.
role (string) –
The role of the participant in the conversation (for example, “user” or “assistant”).
blob (document) –
The binary content of the payload.
branch (dict) –
The branch information for the event.
rootEventId (string) –
The identifier of the root event for this branch.
name (string) –
The name of the branch.
Exceptions
BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.AccessDeniedException
BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ValidationException
BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.InvalidInputException
BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ThrottledException
BedrockAgentCoreDataPlaneFrontingLayer.Client.exceptions.ServiceException