Skip to content

list_sessions

list_sessions(
    *,
    config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListSessionsResponse

Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

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

    The maximum number of results 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.

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

    If the total number of results is greater than the maxResults 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.

Raises:

Source code in docs_src/capo_bedrock_agent_runtime/_services/bedrock_agent_runtime.py
def list_sessions(
    self,
    *,
    config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
    max_results: Optional[
        "capo_bedrock_agent_runtime.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_bedrock_agent_runtime.types.next_token.NextToken"
    ] = None,
) -> "capo_bedrock_agent_runtime.types.list_sessions_response.ListSessionsResponse":
    """<p>Lists all sessions in your Amazon Web Services account. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>

    Args:
        max_results: <p>The maximum number of results 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>
        next_token: <p>If the total number of results is greater than the <code>maxResults</code> 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>

    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.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</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.list_sessions_request.ListSessionsRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent_runtime.types.list_sessions_response.ListSessionsResponse"
    ]:
        import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.list_sessions

        output, http_response = (
            capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.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_agent_runtime.types.list_sessions_request.ListSessionsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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