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.
Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
Parameters:
-
metric_name
(MetricName)
–
The name of the custom metric. Cannot be updated.
-
display_name
(CustomMetricDisplayName)
–
Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
Raises:
Source code in docs_src/capo_iot/_services/io_t.py
| def update_custom_metric(
self,
metric_name: "capo_iot.types.metric_name.MetricName",
display_name: "capo_iot.types.custom_metric_display_name.CustomMetricDisplayName",
*,
config_overrides: Optional[IoTClientConfig] = None,
) -> "capo_iot.types.update_custom_metric_response.UpdateCustomMetricResponse":
"""<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>Updates 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">UpdateCustomMetric</a> action.</p>
Args:
metric_name: <p> The name of the custom metric. Cannot be updated. </p>
display_name: <p> Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated. </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.update_custom_metric_request.UpdateCustomMetricRequest]",
) -> OperationResponse[
"capo_iot.types.update_custom_metric_response.UpdateCustomMetricResponse"
]:
import capo_iot._operations.aws_iot_service.update_custom_metric
output, http_response = (
capo_iot._operations.aws_iot_service.update_custom_metric.update_custom_metric(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("UpdateCustomMetric")
)
input_: capo_iot.types.update_custom_metric_request.UpdateCustomMetricRequest = {
"metric_name": metric_name,
"display_name": display_name,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|