Skip to content

get_metrics

get_metrics(
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    summary_metric_queries: Optional[SummaryMetricQueries] = None,
) -> GetMetricsResponse

Get the summary metrics for this AWS account.

Parameters:

Raises:

Source code in docs_src/capo_iot_wireless/_services/io_t_wireless.py
def get_metrics(
    self,
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    summary_metric_queries: Optional[
        "capo_iot_wireless.types.summary_metric_queries.SummaryMetricQueries"
    ] = None,
) -> "capo_iot_wireless.types.get_metrics_response.GetMetricsResponse":
    """<p>Get the summary metrics for this AWS account.</p>

    Args:
        summary_metric_queries: <p>The list of queries to retrieve the summary metrics.</p>

    Raises:
        capo_iot_wireless.errors.access_denied_exception.AccessDeniedException: <p>User does not have permission to perform this action.</p>
        capo_iot_wireless.errors.conflict_exception.ConflictException: <p>Adding, updating, or deleting the resource can cause an inconsistent state.</p>
        capo_iot_wireless.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing a request.</p>
        capo_iot_wireless.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource does not exist.</p>
        capo_iot_wireless.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed API request rate.</p>
        capo_iot_wireless.errors.validation_exception.ValidationException: <p>The input did not meet the specified constraints.</p>
        capo_iot_wireless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_wireless.types.get_metrics_request.GetMetricsRequest]",
    ) -> OperationResponse[
        "capo_iot_wireless.types.get_metrics_response.GetMetricsResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.get_metrics

        output, http_response = (
            capo_iot_wireless._operations.iotwireless.get_metrics.get_metrics(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetMetrics")
    )
    input_: capo_iot_wireless.types.get_metrics_request.GetMetricsRequest = {}
    if summary_metric_queries is not None:
        input_["summary_metric_queries"] = summary_metric_queries

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