list_sessions ¶

def list_sessions(
    self,
    memory_id: "capo_bedrock_agentcore.types.memory_id.MemoryId",
    actor_id: "capo_bedrock_agentcore.types.actor_id.ActorId",
    *,
    config_overrides: Optional[BedrockAgentCoreClientConfig] = None,
    max_results: Optional[
        "capo_bedrock_agentcore.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_bedrock_agentcore.types.pagination_token.PaginationToken"
    ] = None,
    filter: Optional[
        "capo_bedrock_agentcore.types.session_filter.SessionFilter"
    ] = None,
) -> "capo_bedrock_agentcore.types.list_sessions_output.ListSessionsOutput":
    """<p>Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>Empty sessions are automatically deleted after one day.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:ListSessions</code> permission.</p>

    Args:
        memory_id: <p>The identifier of the AgentCore Memory resource for which to list sessions.</p>
        actor_id: <p>The identifier of the actor for which to list sessions. </p>
        max_results: <p>The maximum number of results to return in a single call. The default value is 20.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
        filter: <p>Filter criteria to apply when listing sessions.</p>

    Raises:
        capo_bedrock_agentcore.errors.access_denied_exception.AccessDeniedException: <p>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.</p>
        capo_bedrock_agentcore.errors.invalid_input_exception.InvalidInputException: <p>The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.</p>
        capo_bedrock_agentcore.errors.resource_not_found_exception.ResourceNotFoundException: <p>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.</p>
        capo_bedrock_agentcore.errors.service_exception.ServiceException: <p>The service encountered an internal error. Try your request again later.</p>
        capo_bedrock_agentcore.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>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.</p>
        capo_bedrock_agentcore.errors.throttled_exception.ThrottledException: <p>The request was denied due to request throttling. Reduce the frequency of requests and try again.</p>
        capo_bedrock_agentcore.errors.validation_exception.ValidationException: <p>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.</p>
        capo_bedrock_agentcore.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore.types.list_sessions_input.ListSessionsInput]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore.types.list_sessions_output.ListSessionsOutput"
    ]:
        import capo_bedrock_agentcore._operations.amazon_bedrock_agent_core.list_sessions

        output, http_response = (
            capo_bedrock_agentcore._operations.amazon_bedrock_agent_core.list_sessions.list_sessions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSessions")
    )
    input_: capo_bedrock_agentcore.types.list_sessions_input.ListSessionsInput = {
        "memory_id": memory_id,
        "actor_id": actor_id,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if filter is not None:
        input_["filter"] = filter

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