list_telemetry_query_sessions `async` ¶

list_telemetry_query_sessions(
    *,
    config_overrides: Optional[AsyncCloudWatchOmniClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> ListTelemetryQuerySessionsResponse

Lists telemetry query sessions. Returns a list of telemetry query sessions owned by the caller.

Parameters:

next_token (Optional[str], default: None ) –

A token to retrieve the next page of results.
max_results (Optional[int], default: None ) –

The maximum number of sessions to return per page.

Raises:

InternalServerException –

An unexpected error occurred while processing the request.
ThrottlingException –

The request was throttled due to exceeding the allowed request rate.
ValidationException –

A parameter is specified incorrectly.
UnknownServiceError –

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

Examples:

List telemetry query sessions The following example lists the query sessions owned by the caller. Payloads are shown as JSON; on the wire they are CBOR-encoded.

>>> await client.list_telemetry_query_sessions(max_results=10)

Source code in docs_src/capo_cloudwatchomni/_services/async_cloud_watch_omni.py

async def list_telemetry_query_sessions(
    self,
    *,
    config_overrides: Optional[AsyncCloudWatchOmniClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_cloudwatchomni.types.list_telemetry_query_sessions_response.ListTelemetryQuerySessionsResponse":
    """Lists telemetry query sessions. Returns a list of telemetry query sessions owned by the caller.

    Args:
        next_token: A token to retrieve the next page of results.
        max_results: The maximum number of sessions to return per page.

    Raises:
        capo_cloudwatchomni.errors.internal_server_exception.InternalServerException: An unexpected error occurred while processing the request.
        capo_cloudwatchomni.errors.throttling_exception.ThrottlingException: The request was throttled due to exceeding the allowed request rate.
        capo_cloudwatchomni.errors.validation_exception.ValidationException: A parameter is specified incorrectly.
        capo_cloudwatchomni.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List telemetry query sessions
        The following example lists the query sessions owned by the caller. Payloads are shown as JSON; on the wire they are CBOR-encoded.

        >>> await client.list_telemetry_query_sessions(max_results=10)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatchomni.types.list_telemetry_query_sessions_request.ListTelemetryQuerySessionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatchomni.types.list_telemetry_query_sessions_response.ListTelemetryQuerySessionsResponse"
    ]:
        import capo_cloudwatchomni._operations.cloud_watch_omni_frontend.list_telemetry_query_sessions

        (
            output,
            http_response,
        ) = await capo_cloudwatchomni._operations.cloud_watch_omni_frontend.list_telemetry_query_sessions.async_list_telemetry_query_sessions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTelemetryQuerySessions")
    )
    input_: capo_cloudwatchomni.types.list_telemetry_query_sessions_request.ListTelemetryQuerySessionsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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

list_telemetry_query_sessions async ¶

list_telemetry_query_sessions `async` ¶