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

DeleteMemory

Deletes a memory.

Request Syntax


DELETE /memories/memoryId/delete?clientToken=clientToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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.

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

memoryId

The unique identifier of the memory to delete.

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 does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "memoryId": "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.

memoryId

The unique identifier of the deleted memory.

Type: String

Length Constraints: Minimum length of 12.

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

status

The current status of the memory deletion.

Type: String

Valid Values: CREATING | ACTIVE | FAILED | DELETING

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

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

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