Skip to content

list_session_loggers

list_session_loggers(
    *,
    config_overrides: Optional[WorkSpacesWebClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListSessionLoggersResponse

Lists all available session logger resources.

Parameters:

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

    The pagination token used to retrieve the next page of results for this operation.

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

    The maximum number of results to be included in the next page.

Raises:

Examples:

List All Session Loggers Lists all session loggers in the account without pagination

>>> client.list_session_loggers()
List Session Loggers with Pagination
Lists session loggers with pagination parameters
>>> client.list_session_loggers(max_results=1, next_token='eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9')
Source code in docs_src/capo_workspaces_web/_services/work_spaces_web.py
def list_session_loggers(
    self,
    *,
    config_overrides: Optional[WorkSpacesWebClientConfig] = None,
    next_token: Optional[
        "capo_workspaces_web.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_workspaces_web.types.max_results.MaxResults"
    ] = None,
) -> "capo_workspaces_web.types.list_session_loggers_response.ListSessionLoggersResponse":
    """<p>Lists all available session logger resources.</p>

    Args:
        next_token: <p>The pagination token used to retrieve the next page of results for this operation.</p>
        max_results: <p>The maximum number of results to be included in the next page.</p>

    Raises:
        capo_workspaces_web.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_workspaces_web.errors.internal_server_exception.InternalServerException: <p>There is an internal server error.</p>
        capo_workspaces_web.errors.throttling_exception.ThrottlingException: <p>There is a throttling error.</p>
        capo_workspaces_web.errors.validation_exception.ValidationException: <p>There is a validation error.</p>
        capo_workspaces_web.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List All Session Loggers
        Lists all session loggers in the account without pagination

        >>> client.list_session_loggers()
        List Session Loggers with Pagination
        Lists session loggers with pagination parameters

        >>> client.list_session_loggers(max_results=1, next_token='eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9')
    """

    def _handler(
        req: "OperationRequest[capo_workspaces_web.types.list_session_loggers_request.ListSessionLoggersRequest]",
    ) -> OperationResponse[
        "capo_workspaces_web.types.list_session_loggers_response.ListSessionLoggersResponse"
    ]:
        import capo_workspaces_web._operations.aws_ermine_control_plane_service.list_session_loggers

        output, http_response = (
            capo_workspaces_web._operations.aws_ermine_control_plane_service.list_session_loggers.list_session_loggers(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_workspaces_web.types.list_session_loggers_response.ListSessionLoggersResponse",
    ) -> dict[str, Any]:
        import capo_workspaces_web.types.list_session_loggers_response

        return capo_workspaces_web.types.list_session_loggers_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListSessionLoggers", redact_output=_redact_output),
    )
    input_: capo_workspaces_web.types.list_session_loggers_request.ListSessionLoggersRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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