AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agentcore ]

create-event

Description

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

To use this operation, you must have the bedrock-agentcore:CreateEvent permission.

This operation is subject to request rate limiting.

See also: AWS API Documentation

create-event uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  create-event
--memory-id <value>
--actor-id <value>
[--session-id <value>]
--event-timestamp <value>
--payload <value>
[--branch <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--memory-id (string)

The identifier of the AgentCore Memory resource in which to create the event.

--actor-id (string)

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

--session-id (string)

The identifier of the session in which this event occurs. A session represents a sequence of related events.

--event-timestamp (timestamp)

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

--payload (list)

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

(tagged union structure)

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 -> (structure)

The conversational content of the payload.

content -> (tagged union structure)

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)

The role of the participant in the conversation (for example, “user” or “assistant”).

blob -> (document)

The binary content of the payload.

Shorthand Syntax:

conversational={content={text=string},role=string} ...

JSON Syntax:

[
  {
    "conversational": {
      "content": {
        "text": "string"
      },
      "role": "ASSISTANT"|"USER"|"TOOL"|"OTHER"
    },
    "blob": {...}
  }
  ...
]

--branch (structure)

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)

The name of the branch.

Shorthand Syntax:

rootEventId=string,name=string

JSON Syntax:

{
  "rootEventId": "string",
  "name": "string"
}

--client-token (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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

event -> (structure)

The event that was created.

memoryId -> (string)

The identifier of the AgentCore Memory resource 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 -> (timestamp)

The timestamp when the event occurred.

payload -> (list)

The content payload of the event.

(tagged union structure)

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 -> (structure)

The conversational content of the payload.

content -> (tagged union structure)

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)

The role of the participant in the conversation (for example, “user” or “assistant”).

blob -> (document)

The binary content of the payload.

branch -> (structure)

The branch information for the event.

rootEventId -> (string)

The identifier of the root event for this branch.

name -> (string)

The name of the branch.