Skip to content

get_memory async

get_memory(
    space_id: SpaceId,
    memory_id: MemoryId,
    *,
    config_overrides: Optional[AsyncOpenSearchMemoryClientConfig] = None,
    actor_id: Optional[ActorId] = None,
    strategy_name: Optional[StrategyName] = None,
) -> GetMemoryOutput

Gets a memory by ID, as returned by SearchMemories or ListMemories. A memory that doesn't exist returns ResourceNotFoundException. Unlike SearchMemories, this operation also returns memories that consolidation has superseded.

A memory past its expiry (set from the space's memoryExpiryDays when the memory is written) reads as not found: ResourceNotFoundException, the same answer as for an ID that does not exist.

If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.

Parameters:

  • space_id (SpaceId) –

    The ID of the space that holds the memory.

  • memory_id (MemoryId) –

    The memory's ID, as returned by SearchMemories or ListMemories.

  • actor_id (Optional[ActorId], default: None ) –

    The ID of the actor the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.

  • strategy_name (Optional[StrategyName], default: None ) –

    The name of the strategy the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.

Raises:

  • 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.

  • InternalServerException –

    The service couldn't process the request because of an internal error. Retry the request.

  • ResourceNotFoundException –

    The specified resource doesn't exist. Check the IDs in the request.

  • ThrottlingException –

    The service throttled the request. Retry the request with exponential backoff.

  • ValidationException –

    The request isn't valid. The reason, message, and fieldList members describe the problem. Fix the request, and then try again.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_opensearchmemory/_services/async_open_search_memory.py
async def get_memory(
    self,
    space_id: "capo_opensearchmemory.types.space_id.SpaceId",
    memory_id: "capo_opensearchmemory.types.memory_id.MemoryId",
    *,
    config_overrides: Optional[AsyncOpenSearchMemoryClientConfig] = None,
    actor_id: Optional["capo_opensearchmemory.types.actor_id.ActorId"] = None,
    strategy_name: Optional[
        "capo_opensearchmemory.types.strategy_name.StrategyName"
    ] = None,
) -> "capo_opensearchmemory.types.get_memory_output.GetMemoryOutput":
    """<p>Gets a memory by ID, as returned by <code>SearchMemories</code> or <code>ListMemories</code>. A memory that doesn't exist returns <code>ResourceNotFoundException</code>. Unlike <code>SearchMemories</code>, this operation also returns memories that consolidation has superseded.</p> <p>A memory past its expiry (set from the space's <code>memoryExpiryDays</code> when the memory is written) reads as not found: <code>ResourceNotFoundException</code>, the same answer as for an ID that does not exist.</p> <p>If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with <code>AccessDeniedException</code> if you aren't allowed to use the key, and with <code>ThrottlingException</code> if AWS KMS throttles the request. It fails with <code>ValidationException</code> if the key is disabled, pending deletion, or deleted.</p>

    Args:
        space_id: <p>The ID of the space that holds the memory.</p>
        memory_id: <p>The memory's ID, as returned by <code>SearchMemories</code> or <code>ListMemories</code>.</p>
        actor_id: <p>The ID of the actor the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with <code>ResourceNotFoundException</code>, as if the memory did not exist.</p>
        strategy_name: <p>The name of the strategy the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with <code>ResourceNotFoundException</code>, as if the memory did not exist.</p>

    Raises:
        capo_opensearchmemory.errors.access_denied_exception.AccessDeniedException: <p>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.</p>
        capo_opensearchmemory.errors.internal_server_exception.InternalServerException: <p>The service couldn't process the request because of an internal error. Retry the request.</p>
        capo_opensearchmemory.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource doesn't exist. Check the IDs in the request.</p>
        capo_opensearchmemory.errors.throttling_exception.ThrottlingException: <p>The service throttled the request. Retry the request with exponential backoff.</p>
        capo_opensearchmemory.errors.validation_exception.ValidationException: <p>The request isn't valid. The <code>reason</code>, <code>message</code>, and <code>fieldList</code> members describe the problem. Fix the request, and then try again.</p>
        capo_opensearchmemory.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearchmemory.types.get_memory_input.GetMemoryInput]",
    ) -> AsyncOperationResponse[
        "capo_opensearchmemory.types.get_memory_output.GetMemoryOutput"
    ]:
        import capo_opensearchmemory._operations.open_search_memory.get_memory

        (
            output,
            http_response,
        ) = await capo_opensearchmemory._operations.open_search_memory.get_memory.async_get_memory(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_opensearchmemory.types.get_memory_output.GetMemoryOutput",
    ) -> dict[str, Any]:
        import capo_opensearchmemory.types.get_memory_output

        return capo_opensearchmemory.types.get_memory_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetMemory", redact_output=_redact_output),
    )
    input_: capo_opensearchmemory.types.get_memory_input.GetMemoryInput = {
        "space_id": space_id,
        "memory_id": memory_id,
    }
    if actor_id is not None:
        input_["actor_id"] = actor_id
    if strategy_name is not None:
        input_["strategy_name"] = strategy_name

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output