The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
Parameters:
-
metric_name
(MetricName)
–
The name of the custom metric.
Raises:
Source code in docs_src/capo_iot/_services/io_t.py
| def describe_custom_metric(
self,
metric_name: "capo_iot.types.metric_name.MetricName",
*,
config_overrides: Optional[IoTClientConfig] = None,
) -> "capo_iot.types.describe_custom_metric_response.DescribeCustomMetricResponse":
"""<note> <p>The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.</p> </note> <p> Gets information about a Device Defender detect custom metric. </p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeCustomMetric</a> action.</p>
Args:
metric_name: <p> The name of the custom metric. </p>
Raises:
capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iot.types.describe_custom_metric_request.DescribeCustomMetricRequest]",
) -> OperationResponse[
"capo_iot.types.describe_custom_metric_response.DescribeCustomMetricResponse"
]:
import capo_iot._operations.aws_iot_service.describe_custom_metric
output, http_response = (
capo_iot._operations.aws_iot_service.describe_custom_metric.describe_custom_metric(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeCustomMetric")
)
input_: capo_iot.types.describe_custom_metric_request.DescribeCustomMetricRequest = {
"metric_name": metric_name
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|