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.
Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
The token for the next set of results.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return at one time. The default is 25.
Raises:
Source code in docs_src/capo_iot/_services/io_t.py
| def list_custom_metrics(
self,
*,
config_overrides: Optional[IoTClientConfig] = None,
next_token: Optional["capo_iot.types.next_token.NextToken"] = None,
max_results: Optional["capo_iot.types.max_results.MaxResults"] = None,
) -> "capo_iot.types.list_custom_metrics_response.ListCustomMetricsResponse":
"""<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> Lists your Device Defender detect custom metrics. </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">ListCustomMetrics</a> action.</p>
Args:
next_token: <p> The token for the next set of results. </p>
max_results: <p> The maximum number of results to return at one time. The default is 25. </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.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.list_custom_metrics_request.ListCustomMetricsRequest]",
) -> OperationResponse[
"capo_iot.types.list_custom_metrics_response.ListCustomMetricsResponse"
]:
import capo_iot._operations.aws_iot_service.list_custom_metrics
output, http_response = (
capo_iot._operations.aws_iot_service.list_custom_metrics.list_custom_metrics(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListCustomMetrics")
)
input_: capo_iot.types.list_custom_metrics_request.ListCustomMetricsRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|