Class: Aws::BedrockAgentCore::Types::ListMemoryRecordsInput

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCore::Types::ListMemoryRecordsInput

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

  The maximum number of results to return in a single call.

• #memory_id ⇒ String

  The identifier of the AgentCore Memory resource for which to list memory records.

• #memory_strategy_id ⇒ String

  The memory strategy identifier to filter memory records by.

• #metadata_filters ⇒ Array<Types::MemoryMetadataFilterExpression>

  A list of metadata filter expressions to scope the returned memory records.

• #namespace ⇒ String

  The namespace prefix to filter memory records by.

• #namespace_path ⇒ String

  Use namespacePath for hierarchical retrievals.

• #next_token ⇒ String

  The token for the next set of results.

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of results to return in a single call. The default value is 20.

Returns:

• (Integer)

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

class ListMemoryRecordsInput < Struct.new(
  :memory_id,
  :namespace,
  :namespace_path,
  :memory_strategy_id,
  :max_results,
  :next_token,
  :metadata_filters)
  SENSITIVE = []
  include Aws::Structure
end

#memory_id ⇒ String

The identifier of the AgentCore Memory resource for which to list memory records.

Returns:

• (String)

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

class ListMemoryRecordsInput < Struct.new(
  :memory_id,
  :namespace,
  :namespace_path,
  :memory_strategy_id,
  :max_results,
  :next_token,
  :metadata_filters)
  SENSITIVE = []
  include Aws::Structure
end

#memory_strategy_id ⇒ String

The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.

Returns:

• (String)

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

class ListMemoryRecordsInput < Struct.new(
  :memory_id,
  :namespace,
  :namespace_path,
  :memory_strategy_id,
  :max_results,
  :next_token,
  :metadata_filters)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_filters ⇒ Array<Types::MemoryMetadataFilterExpression>

A list of metadata filter expressions to scope the returned memory records.

Returns:

• (Array<Types::MemoryMetadataFilterExpression>)

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

class ListMemoryRecordsInput < Struct.new(
  :memory_id,
  :namespace,
  :namespace_path,
  :memory_strategy_id,
  :max_results,
  :next_token,
  :metadata_filters)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace prefix to filter memory records by. Returns all memory records in namespaces that start with the provided prefix. Either namespace or namespacePath is required.

Returns:

• (String)

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

class ListMemoryRecordsInput < Struct.new(
  :memory_id,
  :namespace,
  :namespace_path,
  :memory_strategy_id,
  :max_results,
  :next_token,
  :metadata_filters)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_path ⇒ String

Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy. Either namespace or namespacePath is required.

Returns:

• (String)

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

class ListMemoryRecordsInput < Struct.new(
  :memory_id,
  :namespace,
  :namespace_path,
  :memory_strategy_id,
  :max_results,
  :next_token,
  :metadata_filters)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (String)

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

class ListMemoryRecordsInput < Struct.new(
  :memory_id,
  :namespace,
  :namespace_path,
  :memory_strategy_id,
  :max_results,
  :next_token,
  :metadata_filters)
  SENSITIVE = []
  include Aws::Structure
end