Skip to content

get_agent_memory

get_agent_memory(
    agent_id: AgentId,
    agent_alias_id: AgentAliasId,
    memory_type: MemoryType,
    memory_id: MemoryId,
    *,
    config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_items: Optional[MaxResults] = None,
) -> GetAgentMemoryResponse

Gets the sessions stored in the memory of the agent.

Parameters:

  • next_token (Optional[NextToken], default: None ) –

    If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

  • max_items (Optional[MaxResults], default: None ) –

    The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • agent_id (AgentId) –

    The unique identifier of the agent to which the alias belongs.

  • agent_alias_id (AgentAliasId) –

    The unique identifier of an alias of an agent.

  • memory_type (MemoryType) –

    The type of memory.

  • memory_id (MemoryId) –

    The unique identifier of the memory.

Raises:

  • AccessDeniedException –

    The request is denied because of missing access permissions. Check your permissions and retry your request.

  • BadGatewayException –

    There was an issue with a dependency due to a server issue. Retry your request.

  • ConflictException –

    There was a conflict performing an operation. Resolve the conflict and retry your request.

  • DependencyFailedException –

    There was an issue with a dependency. Check the resource configurations and retry the request.

  • InternalServerException –

    An internal server error occurred. Retry your request.

  • ResourceNotFoundException –

    The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ServiceQuotaExceededException –

    The number of requests exceeds the service quota. Resubmit your request later.

  • ThrottlingException –

    The number of requests exceeds the limit. Resubmit your request later.

  • ValidationException –

    Input validation failed. Check your request parameters and retry the request.

  • UnknownServiceError –

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

Source code in docs_src/capo_bedrock_agent_runtime/_services/bedrock_agent_runtime.py
def get_agent_memory(
    self,
    agent_id: "capo_bedrock_agent_runtime.types.agent_id.AgentId",
    agent_alias_id: "capo_bedrock_agent_runtime.types.agent_alias_id.AgentAliasId",
    memory_type: "capo_bedrock_agent_runtime.types.memory_type.MemoryType",
    memory_id: "capo_bedrock_agent_runtime.types.memory_id.MemoryId",
    *,
    config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
    next_token: Optional[
        "capo_bedrock_agent_runtime.types.next_token.NextToken"
    ] = None,
    max_items: Optional[
        "capo_bedrock_agent_runtime.types.max_results.MaxResults"
    ] = None,
) -> "capo_bedrock_agent_runtime.types.get_agent_memory_response.GetAgentMemoryResponse":
    """<p>Gets the sessions stored in the memory of the agent.</p>

    Args:
        next_token: <p>If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
        max_items: <p>The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
        agent_id: <p>The unique identifier of the agent to which the alias belongs.</p>
        agent_alias_id: <p>The unique identifier of an alias of an agent.</p>
        memory_type: <p>The type of memory.</p>
        memory_id: <p>The unique identifier of the memory. </p>

    Raises:
        capo_bedrock_agent_runtime.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
        capo_bedrock_agent_runtime.errors.bad_gateway_exception.BadGatewayException: <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
        capo_bedrock_agent_runtime.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
        capo_bedrock_agent_runtime.errors.dependency_failed_exception.DependencyFailedException: <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
        capo_bedrock_agent_runtime.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent_runtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent_runtime.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
        capo_bedrock_agent_runtime.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent_runtime.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent_runtime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent_runtime.types.get_agent_memory_request.GetAgentMemoryRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent_runtime.types.get_agent_memory_response.GetAgentMemoryResponse"
    ]:
        import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.get_agent_memory

        output, http_response = (
            capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.get_agent_memory.get_agent_memory(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAgentMemory")
    )
    input_: capo_bedrock_agent_runtime.types.get_agent_memory_request.GetAgentMemoryRequest = {
        "agent_id": agent_id,
        "agent_alias_id": agent_alias_id,
        "memory_type": memory_type,
        "memory_id": memory_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_items is not None:
        input_["max_items"] = max_items

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