create_memory¶
Operation¶
create_memory
¶
create_memory(request: CreateMemoryInput | CreateMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateMemoryInputDict]) -> CreateMemoryOutput
Creates a new Amazon Bedrock AgentCore Memory resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateMemoryInput | CreateMemoryInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateMemoryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateMemoryOutput
|
An instance of |
create_memory
async
¶
create_memory(request: CreateMemoryInput | CreateMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateMemoryInputDict]) -> CreateMemoryOutput
Creates a new Amazon Bedrock AgentCore Memory resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateMemoryInput | CreateMemoryInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateMemoryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateMemoryOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateMemoryInputDict
¶
Bases: TypedDict
Dictionary form of CreateMemoryInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.
This field is autopopulated if not provided.
encryption_key_arn
instance-attribute
¶
encryption_key_arn: str | None
The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.
event_expiry_duration
instance-attribute
¶
The number of days after which memory events expire, between 7 and 3650 days.
indexed_keys
instance-attribute
¶
indexed_keys: Sequence[IndexedKey | IndexedKeyDict] | None
Metadata keys to index for filtering. Once declared, indexed keys cannot be removed.
memory_execution_role_arn
instance-attribute
¶
memory_execution_role_arn: str | None
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.
memory_strategies
instance-attribute
¶
memory_strategies: Sequence[MemoryStrategyInput | MemoryStrategyInputDict] | None
The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.
name
instance-attribute
¶
The name of the memory. The name must be unique within your account.
namespace_keys
instance-attribute
¶
namespace_keys: Sequence[NamespaceKeyEntry | NamespaceKeyEntryDict] | None
The namespace variable key definitions with optional validation rules.
Use these namespaceKeys in namespaceTemplates to control namespace
hierarchy.
stream_delivery_resources
instance-attribute
¶
stream_delivery_resources: StreamDeliveryResources | StreamDeliveryResourcesDict | None
Configuration for streaming memory record data to external resources.
CreateMemoryInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateMemoryInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.
This field is autopopulated if not provided.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the memory.
encryption_key_arn
class-attribute
instance-attribute
¶
encryption_key_arn: str | None = ...
The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.
event_expiry_duration
class-attribute
instance-attribute
¶
event_expiry_duration: int | None = ...
The number of days after which memory events expire, between 7 and 3650 days.
indexed_keys
class-attribute
instance-attribute
¶
indexed_keys: list[IndexedKey] | None = ...
Metadata keys to index for filtering. Once declared, indexed keys cannot be removed.
memory_execution_role_arn
class-attribute
instance-attribute
¶
memory_execution_role_arn: str | None = ...
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.
memory_strategies
class-attribute
instance-attribute
¶
memory_strategies: list[MemoryStrategyInput] | None = ...
The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the memory. The name must be unique within your account.
namespace_keys
class-attribute
instance-attribute
¶
namespace_keys: list[NamespaceKeyEntry] | None = ...
The namespace variable key definitions with optional validation rules.
Use these namespaceKeys in namespaceTemplates to control namespace
hierarchy.
stream_delivery_resources
class-attribute
instance-attribute
¶
stream_delivery_resources: StreamDeliveryResources | None = ...
Configuration for streaming memory record data to external resources.
Output¶
CreateMemoryOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateMemoryOutput structure.
Attributes¶
memory
class-attribute
instance-attribute
¶
memory: Memory | None = ...
The details of the created memory, including its ID, ARN, name, description, and configuration settings.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.