View a markdown version of this page

Memory - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Memory

Contains information about a memory resource.

Contents

arn

The Amazon Resource Name (ARN) of the memory.

Type: String

Pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:memory\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

Required: Yes

createdAt

The timestamp when the memory was created.

Type: Timestamp

Required: Yes

eventExpiryDuration

The number of days after which memory events will expire.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 365.

Required: Yes

id

The unique identifier of the memory.

Type: String

Length Constraints: Minimum length of 12.

Pattern: [a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

Required: Yes

name

The name of the memory.

Type: String

Pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}

Required: Yes

status

The current status of the memory.

Type: String

Valid Values: CREATING | ACTIVE | FAILED | DELETING | UPDATING

Required: Yes

updatedAt

The timestamp when the memory was last updated.

Type: Timestamp

Required: Yes

description

The description of the memory.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

encryptionKeyArn

The ARN of the KMS key used to encrypt the memory.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

failureReason

The reason for failure if the memory is in a failed state.

Type: String

Required: No

indexedKeys

The indexed metadata keys for this memory. Only indexed keys can be used in metadata filters.

Type: Array of IndexedKey objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

managedByResourceArn

ARN of the resource managing this memory (e.g. a harness). When set, strategy modifications and deletion are only allowed through the managing resource.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

memoryExecutionRoleArn

The ARN of the IAM role that provides permissions for the memory.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

namespaceKeys

The namespace variable key definitions for this memory. Namespace keys define custom variables used in namespaceTemplates with optional validation rules.

Type: Array of NamespaceKeyEntry objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: No

strategies

The list of memory strategies associated with this memory.

Type: Array of MemoryStrategy objects

Required: No

streamDeliveryResources

Configuration for streaming memory record data to external resources.

Type: StreamDeliveryResources object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: