Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
Parameters:
Raises:
Source code in docs_src/capo_iot/_services/io_t.py
| def describe_fleet_metric(
self,
metric_name: "capo_iot.types.fleet_metric_name.FleetMetricName",
*,
config_overrides: Optional[IoTClientConfig] = None,
) -> "capo_iot.types.describe_fleet_metric_response.DescribeFleetMetricResponse":
"""<p>Gets information about the specified fleet 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">DescribeFleetMetric</a> action.</p>
Args:
metric_name: <p>The name of the fleet metric to describe.</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.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iot.types.describe_fleet_metric_request.DescribeFleetMetricRequest]",
) -> OperationResponse[
"capo_iot.types.describe_fleet_metric_response.DescribeFleetMetricResponse"
]:
import capo_iot._operations.aws_iot_service.describe_fleet_metric
output, http_response = (
capo_iot._operations.aws_iot_service.describe_fleet_metric.describe_fleet_metric(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeFleetMetric")
)
input_: capo_iot.types.describe_fleet_metric_request.DescribeFleetMetricRequest = {
"metric_name": metric_name
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|