Starts a new telemetry query session. A session provides a logical grouping for one or more telemetry queries. The returned session ID is required when starting queries via StartTelemetryQuery.
Parameters:
-
session_name
(Optional[str], default:
None
)
–
A human-readable name for the session. Names under /aws/ are reserved for service integrations.
Raises:
Examples:
Start a telemetry query session
The following example starts a session for grouping telemetry queries and returns its session ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.
>>> client.start_telemetry_query_session(session_name='prod-latency-investigation')
Source code in docs_src/capo_cloudwatchomni/_services/cloud_watch_omni.py
| def start_telemetry_query_session(
self,
*,
config_overrides: Optional[CloudWatchOmniClientConfig] = None,
session_name: Optional[str] = None,
) -> "capo_cloudwatchomni.types.start_telemetry_query_session_response.StartTelemetryQuerySessionResponse":
"""Starts a new telemetry query session. A session provides a logical grouping for one or more telemetry queries. The returned session ID is required when starting queries via StartTelemetryQuery.
Args:
session_name: A human-readable name for the session. Names under `/aws/` are reserved for service integrations.
Raises:
capo_cloudwatchomni.errors.conflict_exception.ConflictException: The operation could not be completed because of a conflict with the current state of the resource.
capo_cloudwatchomni.errors.internal_server_exception.InternalServerException: An unexpected error occurred while processing the request.
capo_cloudwatchomni.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: A service quota was exceeded.
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:
Start a telemetry query session
The following example starts a session for grouping telemetry queries and returns its session ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.
>>> client.start_telemetry_query_session(session_name='prod-latency-investigation')
"""
def _handler(
req: "OperationRequest[capo_cloudwatchomni.types.start_telemetry_query_session_request.StartTelemetryQuerySessionRequest]",
) -> OperationResponse[
"capo_cloudwatchomni.types.start_telemetry_query_session_response.StartTelemetryQuerySessionResponse"
]:
import capo_cloudwatchomni._operations.cloud_watch_omni_frontend.start_telemetry_query_session
output, http_response = (
capo_cloudwatchomni._operations.cloud_watch_omni_frontend.start_telemetry_query_session.start_telemetry_query_session(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("StartTelemetryQuerySession")
)
input_: capo_cloudwatchomni.types.start_telemetry_query_session_request.StartTelemetryQuerySessionRequest = {}
if session_name is not None:
input_["session_name"] = session_name
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|