stop_telemetry_query ¶

stop_telemetry_query(
    query_id: str, *, config_overrides: Optional[CloudWatchOmniClientConfig] = None
) -> StopTelemetryQueryResponse

Stops a running telemetry query.

Parameters:

query_id (str) –

The unique ID of the query.

Raises:

AccessDeniedException –

The caller is not authorized to perform this action.
InternalServerException –

An unexpected error occurred while processing the request.
ResourceNotFoundException –

The specified resource does not exist.
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:

Stop a running telemetry query The following example stops a running query by its ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

>>> client.stop_telemetry_query(query_id='3b2a1c0d-7e6f-4a5b-8c9d-0e1f2a3b4c5d')

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

def stop_telemetry_query(
    self,
    query_id: str,
    *,
    config_overrides: Optional[CloudWatchOmniClientConfig] = None,
) -> "capo_cloudwatchomni.types.stop_telemetry_query_response.StopTelemetryQueryResponse":
    """Stops a running telemetry query.

    Args:
        query_id: The unique ID of the query.

    Raises:
        capo_cloudwatchomni.errors.access_denied_exception.AccessDeniedException: The caller is not authorized to perform this action.
        capo_cloudwatchomni.errors.internal_server_exception.InternalServerException: An unexpected error occurred while processing the request.
        capo_cloudwatchomni.errors.resource_not_found_exception.ResourceNotFoundException: The specified resource does not exist.
        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:
        Stop a running telemetry query
        The following example stops a running query by its ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

        >>> client.stop_telemetry_query(query_id='3b2a1c0d-7e6f-4a5b-8c9d-0e1f2a3b4c5d')
    """

    def _handler(
        req: "OperationRequest[capo_cloudwatchomni.types.stop_telemetry_query_request.StopTelemetryQueryRequest]",
    ) -> OperationResponse[
        "capo_cloudwatchomni.types.stop_telemetry_query_response.StopTelemetryQueryResponse"
    ]:
        import capo_cloudwatchomni._operations.cloud_watch_omni_frontend.stop_telemetry_query

        output, http_response = (
            capo_cloudwatchomni._operations.cloud_watch_omni_frontend.stop_telemetry_query.stop_telemetry_query(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopTelemetryQuery")
    )
    input_: capo_cloudwatchomni.types.stop_telemetry_query_request.StopTelemetryQueryRequest = {
        "query_id": query_id
    }

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