Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . bedrock-agentcore-control ]
update-memory¶
Synopsis¶
update-memory
[--client-token <value>]
--memory-id <value>
[--description <value>]
[--event-expiry-duration <value>]
[--memory-execution-role-arn <value>]
[--memory-strategies <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--client-token (string)
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 AWS identifier.
--memory-id (string)
The unique identifier of the memory to update.
--description (string)
The updated description of the memory.
--event-expiry-duration (integer)
The number of days after which memory events will expire, between 7 and 365 days.
--memory-execution-role-arn (string)
The ARN of the IAM role that provides permissions for the memory.
--memory-strategies (structure)
The memory strategies to add, modify, or delete.
addMemoryStrategies -> (list)
The list of memory strategies to add.
(tagged union structure)
Contains input information for creating a memory strategy.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:semanticMemoryStrategy,summaryMemoryStrategy,userPreferenceMemoryStrategy,customMemoryStrategy.semanticMemoryStrategy -> (structure)
Input for creating a semantic memory strategy.
name -> (string)
The name of the semantic memory strategy.description -> (string)
The description of the semantic memory strategy.namespaces -> (list)
The namespaces associated with the semantic memory strategy.
(string)
summaryMemoryStrategy -> (structure)
Input for creating a summary memory strategy.
name -> (string)
The name of the summary memory strategy.description -> (string)
The description of the summary memory strategy.namespaces -> (list)
The namespaces associated with the summary memory strategy.
(string)
userPreferenceMemoryStrategy -> (structure)
Input for creating a user preference memory strategy.
name -> (string)
The name of the user preference memory strategy.description -> (string)
The description of the user preference memory strategy.namespaces -> (list)
The namespaces associated with the user preference memory strategy.
(string)
customMemoryStrategy -> (structure)
Input for creating a custom memory strategy.
name -> (string)
The name of the custom memory strategy.description -> (string)
The description of the custom memory strategy.namespaces -> (list)
The namespaces associated with the custom memory strategy.
(string)
configuration -> (tagged union structure)
The configuration for the custom memory strategy.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:semanticOverride,summaryOverride,userPreferenceOverride.semanticOverride -> (structure)
The semantic override configuration for a custom memory strategy.
extraction -> (structure)
The extraction configuration for a semantic override.
appendToPrompt -> (string)
The text to append to the prompt for semantic extraction.modelId -> (string)
The model ID to use for semantic extraction.consolidation -> (structure)
The consolidation configuration for a semantic override.
appendToPrompt -> (string)
The text to append to the prompt for semantic consolidation.modelId -> (string)
The model ID to use for semantic consolidation.summaryOverride -> (structure)
The summary override configuration for a custom memory strategy.
consolidation -> (structure)
The consolidation configuration for a summary override.
appendToPrompt -> (string)
The text to append to the prompt for summary consolidation.modelId -> (string)
The model ID to use for summary consolidation.userPreferenceOverride -> (structure)
The user preference override configuration for a custom memory strategy.
extraction -> (structure)
The extraction configuration for a user preference override.
appendToPrompt -> (string)
The text to append to the prompt for user preference extraction.modelId -> (string)
The model ID to use for user preference extraction.consolidation -> (structure)
The consolidation configuration for a user preference override.
appendToPrompt -> (string)
The text to append to the prompt for user preference consolidation.modelId -> (string)
The model ID to use for user preference consolidation.modifyMemoryStrategies -> (list)
The list of memory strategies to modify.
(structure)
Input for modifying a memory strategy.
memoryStrategyId -> (string)
The unique identifier of the memory strategy to modify.description -> (string)
The updated description of the memory strategy.namespaces -> (list)
The updated namespaces for the memory strategy.
(string)
configuration -> (structure)
The updated configuration for the memory strategy.
extraction -> (tagged union structure)
The updated extraction configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:customExtractionConfiguration.customExtractionConfiguration -> (tagged union structure)
The updated custom extraction configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:semanticExtractionOverride,userPreferenceExtractionOverride.semanticExtractionOverride -> (structure)
The semantic extraction override configuration input.
appendToPrompt -> (string)
The text to append to the prompt for semantic extraction.modelId -> (string)
The model ID to use for semantic extraction.userPreferenceExtractionOverride -> (structure)
The user preference extraction override configuration input.
appendToPrompt -> (string)
The text to append to the prompt for user preference extraction.modelId -> (string)
The model ID to use for user preference extraction.consolidation -> (tagged union structure)
The updated consolidation configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:customConsolidationConfiguration.customConsolidationConfiguration -> (tagged union structure)
The updated custom consolidation configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:semanticConsolidationOverride,summaryConsolidationOverride,userPreferenceConsolidationOverride.semanticConsolidationOverride -> (structure)
The semantic consolidation override configuration input.
appendToPrompt -> (string)
The text to append to the prompt for semantic consolidation.modelId -> (string)
The model ID to use for semantic consolidation.summaryConsolidationOverride -> (structure)
The summary consolidation override configuration input.
appendToPrompt -> (string)
The text to append to the prompt for summary consolidation.modelId -> (string)
The model ID to use for summary consolidation.userPreferenceConsolidationOverride -> (structure)
The user preference consolidation override configuration input.
appendToPrompt -> (string)
The text to append to the prompt for user preference consolidation.modelId -> (string)
The model ID to use for user preference consolidation.deleteMemoryStrategies -> (list)
The list of memory strategies to delete.
(structure)
Input for deleting a memory strategy.
memoryStrategyId -> (string)
The unique identifier of the memory strategy to delete.
JSON Syntax:
{
"addMemoryStrategies": [
{
"semanticMemoryStrategy": {
"name": "string",
"description": "string",
"namespaces": ["string", ...]
},
"summaryMemoryStrategy": {
"name": "string",
"description": "string",
"namespaces": ["string", ...]
},
"userPreferenceMemoryStrategy": {
"name": "string",
"description": "string",
"namespaces": ["string", ...]
},
"customMemoryStrategy": {
"name": "string",
"description": "string",
"namespaces": ["string", ...],
"configuration": {
"semanticOverride": {
"extraction": {
"appendToPrompt": "string",
"modelId": "string"
},
"consolidation": {
"appendToPrompt": "string",
"modelId": "string"
}
},
"summaryOverride": {
"consolidation": {
"appendToPrompt": "string",
"modelId": "string"
}
},
"userPreferenceOverride": {
"extraction": {
"appendToPrompt": "string",
"modelId": "string"
},
"consolidation": {
"appendToPrompt": "string",
"modelId": "string"
}
}
}
}
}
...
],
"modifyMemoryStrategies": [
{
"memoryStrategyId": "string",
"description": "string",
"namespaces": ["string", ...],
"configuration": {
"extraction": {
"customExtractionConfiguration": {
"semanticExtractionOverride": {
"appendToPrompt": "string",
"modelId": "string"
},
"userPreferenceExtractionOverride": {
"appendToPrompt": "string",
"modelId": "string"
}
}
},
"consolidation": {
"customConsolidationConfiguration": {
"semanticConsolidationOverride": {
"appendToPrompt": "string",
"modelId": "string"
},
"summaryConsolidationOverride": {
"appendToPrompt": "string",
"modelId": "string"
},
"userPreferenceConsolidationOverride": {
"appendToPrompt": "string",
"modelId": "string"
}
}
}
}
}
...
],
"deleteMemoryStrategies": [
{
"memoryStrategyId": "string"
}
...
]
}
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output¶
memory -> (structure)
The updated memory details.
arn -> (string)
The Amazon Resource Name (ARN) of the memory.id -> (string)
The unique identifier of the memory.name -> (string)
The name of the memory.description -> (string)
The description of the memory.encryptionKeyArn -> (string)
The ARN of the KMS key used to encrypt the memory.memoryExecutionRoleArn -> (string)
The ARN of the IAM role that provides permissions for the memory.eventExpiryDuration -> (integer)
The number of days after which memory events will expire.status -> (string)
The current status of the memory.failureReason -> (string)
The reason for failure if the memory is in a failed state.createdAt -> (timestamp)
The timestamp when the memory was created.updatedAt -> (timestamp)
The timestamp when the memory was last updated.strategies -> (list)
The list of memory strategies associated with this memory.
(structure)
Contains information about a memory strategy.
strategyId -> (string)
The unique identifier of the memory strategy.name -> (string)
The name of the memory strategy.description -> (string)
The description of the memory strategy.configuration -> (structure)
The configuration of the memory strategy.
type -> (string)
The type of override for the strategy configuration.extraction -> (tagged union structure)
The extraction configuration for the memory strategy.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:customExtractionConfiguration.customExtractionConfiguration -> (tagged union structure)
The custom extraction configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:semanticExtractionOverride,userPreferenceExtractionOverride.semanticExtractionOverride -> (structure)
The semantic extraction override configuration.
appendToPrompt -> (string)
The text to append to the prompt for semantic extraction.modelId -> (string)
The model ID to use for semantic extraction.userPreferenceExtractionOverride -> (structure)
The user preference extraction override configuration.
appendToPrompt -> (string)
The text to append to the prompt for user preference extraction.modelId -> (string)
The model ID to use for user preference extraction.consolidation -> (tagged union structure)
The consolidation configuration for the memory strategy.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:customConsolidationConfiguration.customConsolidationConfiguration -> (tagged union structure)
The custom consolidation configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:semanticConsolidationOverride,summaryConsolidationOverride,userPreferenceConsolidationOverride.semanticConsolidationOverride -> (structure)
The semantic consolidation override configuration.
appendToPrompt -> (string)
The text to append to the prompt for semantic consolidation.modelId -> (string)
The model ID to use for semantic consolidation.summaryConsolidationOverride -> (structure)
The summary consolidation override configuration.
appendToPrompt -> (string)
The text to append to the prompt for summary consolidation.modelId -> (string)
The model ID to use for summary consolidation.userPreferenceConsolidationOverride -> (structure)
The user preference consolidation override configuration.
appendToPrompt -> (string)
The text to append to the prompt for user preference consolidation.modelId -> (string)
The model ID to use for user preference consolidation.type -> (string)
The type of the memory strategy.namespaces -> (list)
The namespaces associated with the memory strategy.
(string)
createdAt -> (timestamp)
The timestamp when the memory strategy was created.updatedAt -> (timestamp)
The timestamp when the memory strategy was last updated.status -> (string)
The current status of the memory strategy.