UpdateSpace
Updates a space's memory strategies, retention settings, or extraction model. Supply only the fields to change. Omitted fields keep their current values.
If the request changes the set of strategies, a strategy's configuration, a retention setting, or the
extraction model, the space moves to UPDATING. When the change is complete, the space returns to
ACTIVE, or moves to FAILED if the change can't be applied. While the space is
UPDATING, GetSpace returns the previous configuration. A request that only changes
strategy descriptions or repeats the values the space has stored is applied immediately and doesn't change the
status. Sending a retention value that the space never set also moves the space to UPDATING, even
one that matches the behavior without it, such as 90 for eventExpiryDays or 0 for
memoryExpiryDays. A space that is CREATING, UPDATING, or
DELETING can't be updated: the request fails with ConflictException.
Request Syntax
{
"eventExpiryDays": number,
"extractionModelId": "string",
"memoryExpiryDays": number,
"memoryStrategies": [
{
"configuration": {
"consolidationEnabled": boolean,
"extractEveryNMessages": number,
"extractEveryNTokens": number,
"extractionPrompt": "string",
"extractionSeedRecentN": number,
"extractionSeedTopK": number,
"idleTimeoutSeconds": number
},
"description": "string",
"name": "string",
"type": "string"
}
],
"spaceId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- eventExpiryDays
-
How many days the space keeps each event, from 1 to 365. Omit it to leave the current value unchanged. Events already stored keep the expiry they were written with.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 365.
Required: No
- extractionModelId
-
The model that extracts and consolidates memories for every strategy in the space:
anthropic.claude-opus-5-5oranthropic.claude-haiku-5-5. Omit it to leave the current value unchanged. Once set, it can't be cleared back to the service default.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9._:-]*Required: No
- memoryExpiryDays
-
How many days the space keeps each memory, from 0 to 3650. 0 means memories never expire. Omit it to leave the current value unchanged. You can't clear the setting. To make memories written from then on never expire, send 0.
GetSpacethen returns 0.A change applies to memories written after it. Memories already stored keep the expiry they were written with. A memory the service rewrites later, such as a summary it keeps up to date, takes the setting in force at that rewrite. A change moves the space to
UPDATING. Sending the value that the space has stored doesn't.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 3650.
Required: No
- memoryStrategies
-
The complete new list of memory strategies. The service removes strategies that aren't in the list from the space. Removing a strategy stops extraction for it but doesn't delete its memories: they're kept, until they expire if the space sets
memoryExpiryDays, and they're available again if you later add a strategy with the sametypeandname. To delete them, useDeleteMemorybefore you remove the strategy, or delete the space.To keep a strategy, include it with the same
typeandnamethatGetSpacereturns. For a kept strategy, anyconfigurationmember you omit keeps its current value. It doesn't return to the default, and you can't clear a member once it's set. Omit this field to leave the strategies unchanged. The list must name at least one strategy. You can't remove every strategy from a space withUpdateSpace.The serialized list can be at most 384 KiB.
Type: Array of MemoryStrategy objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- spaceId
-
The ID of the space to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
sp-[a-f0-9]{12}Required: Yes
Response Syntax
{
"spaceId": "string",
"status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- spaceId
-
The ID of the space.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
sp-[a-f0-9]{12} - status
-
The status of the space:
UPDATINGwhen the change has to be applied to the space's strategies, retention, or extraction model. Otherwise, the space's current status.Type: String
Valid Values:
CREATING | ACTIVE | UPDATING | DELETING | DELETED | FAILED
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You don't have sufficient access to perform this operation. To use this operation, you must have AWS Identity and Access Management (IAM) permissions for the operation, and on the resource it acts on. If the space uses a customer managed AWS Key Management Service (AWS KMS) key, you must also have permission to use the key.
- message
-
A message that describes which access the request is missing.
HTTP Status Code: 403
- ConflictException
-
The request conflicts with the current state of the resource. For example, the space is being created, updated, or deleted, a space with the same name already exists, or you reused a client token with different parameters. Wait for the space to finish being created, updated, or deleted, or use a different name or client token, and then retry.
- message
-
A message that describes the conflict.
- resourceId
-
The ID of the resource that caused the conflict.
- resourceType
-
The type of the resource that caused the conflict.
HTTP Status Code: 409
- InternalServerException
-
The service couldn't process the request because of an internal error. Retry the request.
- message
-
A message that describes the internal error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource doesn't exist. Check the IDs in the request.
- message
-
A message that describes which resource wasn't found.
- resourceId
-
The ID of the resource that wasn't found.
- resourceType
-
The type of the resource that wasn't found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request would exceed a quota, such as the number of spaces in your account or the number of strategies in a space.
- message
-
A message that describes which quota the request would exceed.
- quotaCode
-
The Service Quotas code of the quota that the request would exceed. Not currently returned.
- serviceCode
-
The Service Quotas code of the service. Not currently returned.
HTTP Status Code: 402
- ThrottlingException
-
The service throttled the request. Retry the request with exponential backoff.
- message
-
A message that describes the throttling.
- retryAfterSeconds
-
The number of seconds to wait before you retry the request.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. The
reason,message, andfieldListmembers describe the problem. Fix the request, and then try again.- fieldList
-
The fields that failed validation, if any.
- message
-
A message that describes why the request failed validation, such as the field, key, or limit involved.
- reason
-
The reason that the request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: