BedrockAgentCoreDataPlaneFrontingLayer / Client / create_event

create_event

BedrockAgentCoreDataPlaneFrontingLayer.Client.create_event(**kwargs)

Creates an event in a memory store. Events represent interactions or activities that occur within a session and are associated with specific actors.

To use this operation, you must have the genesismemory:CreateEvent permission.

This operation is subject to request rate limiting.

See also: AWS API Documentation

Request Syntax

response = client.create_event(
    memoryId='string',
    actorId='string',
    sessionId='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'
    },
    clientToken='string'
)
Parameters:

  • memoryId (string) –

    [REQUIRED]

    The identifier of the memory store in which to create the event.

  • actorId (string) –

    [REQUIRED]

    The identifier of the actor associated with this event. An actor represents an entity that participates in sessions and generates events.

  • sessionId (string) – The identifier of the session in which this event occurs. A session represents a sequence of related events.

  • eventTimestamp (datetime) –

    [REQUIRED]

    The timestamp when the event occurred. If not specified, the current time is used.

  • payload (list) –

    [REQUIRED]

    The content payload of the event. This can include conversational data or binary content.

    • (dict) –

      Contains the payload content for an event.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: conversational, blob.

      • conversational (dict) –

        The conversational content of the payload.

        • content (dict) – [REQUIRED]

          The content of the conversation message.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: text.

          • text (string) –

            The text content of the memory item.

        • role (string) – [REQUIRED]

          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 this event. Branches allow for organizing events into different conversation threads or paths.

    • rootEventId (string) –

      The identifier of the root event for this branch.

    • name (string) – [REQUIRED]

      The name of the branch.

  • clientToken (string) –

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, AgentCore ignores the request, but does not return an error.

    This field is autopopulated if not provided.

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 event that was created.

      • 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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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