Skip to content

delete_memory

delete_memory(
    memory_id: MemoryId,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    client_token: Optional[NonEmptyString] = None,
) -> DeleteMemoryOutput

Deletes an Amazon Bedrock AgentCore Memory resource. When you delete a memory resource, it is permanently removed.

Parameters:

  • client_token (Optional[NonEmptyString], default: None ) –

    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 Amazon Web Services identifier.

  • memory_id (MemoryId) –

    The unique identifier of the memory to delete.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def delete_memory(
    self,
    memory_id: "capo_bedrock_agentcore_control.types.memory_id.MemoryId",
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    client_token: Optional[
        "capo_bedrock_agentcore_control.types.non_empty_string.NonEmptyString"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.delete_memory_output.DeleteMemoryOutput":
    """<p>Deletes an Amazon Bedrock AgentCore Memory resource. When you delete a memory resource, it is permanently removed.</p>

    Args:
        client_token: <p>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 Amazon Web Services identifier.</p>
        memory_id: <p>The unique identifier of the memory to delete.</p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.conflict_exception.ConflictException: <p>This exception is thrown when there is a conflict performing an operation</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.service_exception.ServiceException: <p>An internal error occurred.</p>
        capo_bedrock_agentcore_control.errors.throttled_exception.ThrottledException: <p>API rate limit has been exceeded.</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.delete_memory_input.DeleteMemoryInput]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.delete_memory_output.DeleteMemoryOutput"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.delete_memory

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.delete_memory.delete_memory(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteMemory")
    )
    input_: capo_bedrock_agentcore_control.types.delete_memory_input.DeleteMemoryInput = {
        "memory_id": memory_id
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output