Class: Aws::BedrockAgentCore::Types::CreateEventInput

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCore::Types::CreateEventInput

Defined in:

gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actor_id ⇒ String

  The identifier of the actor associated with this event.

• #branch ⇒ Types::Branch

  The branch information for this event.

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure that the operation completes no more than one time.

• #event_timestamp ⇒ Time

  The timestamp when the event occurred.

• #memory_id ⇒ String

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

• #metadata ⇒ Hash<String,Types::MetadataValue>

  The key-value metadata to attach to the event.

• #payload ⇒ Array<Types::PayloadType>

  The content payload of the event.

• #session_id ⇒ String

  The identifier of the session in which this event occurs.

Instance Attribute Details

#actor_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 980

class CreateEventInput < Struct.new(
  :memory_id,
  :actor_id,
  :session_id,
  :event_timestamp,
  :payload,
  :branch,
  :client_token,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#branch ⇒ Types::Branch

The branch information for this event. Branches allow for organizing events into different conversation threads or paths.

Returns:

• (Types::Branch)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 980

class CreateEventInput < Struct.new(
  :memory_id,
  :actor_id,
  :session_id,
  :event_timestamp,
  :payload,
  :branch,
  :client_token,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 980

class CreateEventInput < Struct.new(
  :memory_id,
  :actor_id,
  :session_id,
  :event_timestamp,
  :payload,
  :branch,
  :client_token,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#event_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 980

class CreateEventInput < Struct.new(
  :memory_id,
  :actor_id,
  :session_id,
  :event_timestamp,
  :payload,
  :branch,
  :client_token,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#memory_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 980

class CreateEventInput < Struct.new(
  :memory_id,
  :actor_id,
  :session_id,
  :event_timestamp,
  :payload,
  :branch,
  :client_token,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ Hash<String,Types::MetadataValue>

The key-value metadata to attach to the event.

Returns:

• (Hash<String,Types::MetadataValue>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 980

class CreateEventInput < Struct.new(
  :memory_id,
  :actor_id,
  :session_id,
  :event_timestamp,
  :payload,
  :branch,
  :client_token,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#payload ⇒ Array<Types::PayloadType>

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

Returns:

• (Array<Types::PayloadType>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 980

class CreateEventInput < Struct.new(
  :memory_id,
  :actor_id,
  :session_id,
  :event_timestamp,
  :payload,
  :branch,
  :client_token,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 980

class CreateEventInput < Struct.new(
  :memory_id,
  :actor_id,
  :session_id,
  :event_timestamp,
  :payload,
  :branch,
  :client_token,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end