DeleteEvent
Deletes an event from a memory store. When you delete an event, it is permanently removed.
To use this operation, you must have the DeleteEvent
permission.
Request Syntax
DELETE /memories/memoryId
/actor/actorId
/sessions/sessionId
/events/eventId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- actorId
-
The identifier of the actor associated with the event to delete.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-_/]*
Required: Yes
- eventId
-
The identifier of the event to delete.
Pattern:
[0-9]+#[a-fA-F0-9]+
Required: Yes
- memoryId
-
The identifier of the memory store from which to delete the event.
Length Constraints: Minimum length of 12.
Pattern:
[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}
Required: Yes
- sessionId
-
The identifier of the session containing the event to delete.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-_]*
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"eventId": "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.
- eventId
-
The identifier of the event that was deleted.
Type: String
Pattern:
[0-9]+#[a-fA-F0-9]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.
HTTP Status Code: 403
- InvalidInputException
-
The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.
HTTP Status Code: 400
- ResourceNotFoundException
-
The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.
HTTP Status Code: 404
- ServiceException
-
The service encountered an internal error. Try your request again later.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.
HTTP Status Code: 402
- ThrottledException
-
The request was denied due to request throttling. Reduce the frequency of requests and try again.
HTTP Status Code: 429
- ValidationException
-
The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: