update_memory¶
Operation¶
update_memory
¶
update_memory(request: UpdateMemoryInput | UpdateMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateMemoryInputDict]) -> UpdateMemoryOutput
Update an Amazon Bedrock AgentCore Memory resource memory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateMemoryInput | UpdateMemoryInputDict | 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[UpdateMemoryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateMemoryOutput
|
An instance of |
update_memory
async
¶
update_memory(request: UpdateMemoryInput | UpdateMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateMemoryInputDict]) -> UpdateMemoryOutput
Update an Amazon Bedrock AgentCore Memory resource memory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateMemoryInput | UpdateMemoryInputDict | 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[UpdateMemoryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateMemoryOutput
|
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.
UpdateMemoryInputDict
¶
Bases: TypedDict
Dictionary form of UpdateMemoryInput.
Attributes¶
add_indexed_keys
instance-attribute
¶
add_indexed_keys: Sequence[IndexedKey | IndexedKeyDict] | None
Additional metadata keys to index. Previously indexed keys cannot be removed.
client_token
instance-attribute
¶
client_token: str | None
A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique Amazon Web Services identifier.
This field is autopopulated if not provided.
description
instance-attribute
¶
description: str | None
The updated description of the AgentCore Memory resource.
event_expiry_duration
instance-attribute
¶
event_expiry_duration: int | None
The number of days after which memory events expire, between 7 and 3650 days.
memory_execution_role_arn
instance-attribute
¶
memory_execution_role_arn: str | None
The ARN of the IAM role that provides permissions for the AgentCore Memory resource.
memory_id
instance-attribute
¶
The unique identifier of the memory to update.
memory_strategies
instance-attribute
¶
memory_strategies: ModifyMemoryStrategies | ModifyMemoryStrategiesDict | None
The memory strategies to add, modify, or delete.
namespace_keys
instance-attribute
¶
namespace_keys: Sequence[NamespaceKeyEntry | NamespaceKeyEntryDict] | None
The namespace variable key definitions with validation rules for this
memory. This value fully replaces the existing set --- any key you omit
is removed. Any referenced namespaceKey omission will throw
ValidationException.
stream_delivery_resources
instance-attribute
¶
stream_delivery_resources: StreamDeliveryResources | StreamDeliveryResourcesDict | None
Configuration for streaming memory record data to external resources.
UpdateMemoryInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateMemoryInput structure.
Attributes¶
add_indexed_keys
class-attribute
instance-attribute
¶
add_indexed_keys: list[IndexedKey] | None = ...
Additional metadata keys to index. Previously indexed keys cannot be removed.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique Amazon Web Services identifier.
This field is autopopulated if not provided.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The updated description of the AgentCore Memory resource.
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.
memory_execution_role_arn
class-attribute
instance-attribute
¶
memory_execution_role_arn: str | None = ...
The ARN of the IAM role that provides permissions for the AgentCore Memory resource.
memory_id
class-attribute
instance-attribute
¶
memory_id: str | None = ...
The unique identifier of the memory to update.
memory_strategies
class-attribute
instance-attribute
¶
memory_strategies: ModifyMemoryStrategies | None = ...
The memory strategies to add, modify, or delete.
namespace_keys
class-attribute
instance-attribute
¶
namespace_keys: list[NamespaceKeyEntry] | None = ...
The namespace variable key definitions with validation rules for this
memory. This value fully replaces the existing set --- any key you omit
is removed. Any referenced namespaceKey omission will throw
ValidationException.
stream_delivery_resources
class-attribute
instance-attribute
¶
stream_delivery_resources: StreamDeliveryResources | None = ...
Configuration for streaming memory record data to external resources.
Output¶
UpdateMemoryOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateMemoryOutput structure.
Attributes¶
memory
class-attribute
instance-attribute
¶
memory: Memory | None = ...
The updated AgentCore Memory resource details.
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.