Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateMemory

Update memory.

Request Syntax


PUT /memories/memoryId/update HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "eventExpiryDuration": number,
   "memoryExecutionRoleArn": "string",
   "memoryStrategies": { 
      "addMemoryStrategies": [ 
         { ... }
      ],
      "deleteMemoryStrategies": [ 
         { 
            "memoryStrategyId": "string"
         }
      ],
      "modifyMemoryStrategies": [ 
         { 
            "configuration": { 
               "consolidation": { ... },
               "extraction": { ... }
            },
            "description": "string",
            "memoryStrategyId": "string",
            "namespaces": [ "string" ]
         }
      ]
   }
}

URI Request Parameters

The request uses the following URI parameters.

memoryId

The unique identifier of the memory to update.

Length Constraints: Minimum length of 12.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

description

The updated description of the memory.

Type: String

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

Required: No

eventExpiryDuration

The number of days after which memory events will expire, between 7 and 365 days.

Type: Integer

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

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

memoryStrategies

The memory strategies to add, modify, or delete.

Type: ModifyMemoryStrategies object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "memory": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "encryptionKeyArn": "string",
      "eventExpiryDuration": number,
      "failureReason": "string",
      "id": "string",
      "memoryExecutionRoleArn": "string",
      "name": "string",
      "status": "string",
      "strategies": [ 
         { 
            "configuration": { 
               "consolidation": { ... },
               "extraction": { ... },
               "type": "string"
            },
            "createdAt": number,
            "description": "string",
            "name": "string",
            "namespaces": [ "string" ],
            "status": "string",
            "strategyId": "string",
            "type": "string",
            "updatedAt": number
         }
      ],
      "updatedAt": number
   }
}

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.

memory

The updated memory details.

Type: Memory object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ServiceException

An internal error occurred.

HTTP Status Code: 500

ServiceQuotaExceededException

This exception is thrown when a request is made beyond the service quota

HTTP Status Code: 402

ThrottledException

API rate limit has been exceeded.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400