list_sensor_statistics ¶

def list_sensor_statistics(
    self,
    dataset_name: "capo_lookoutequipment.types.dataset_name.DatasetName",
    *,
    config_overrides: Optional[LookoutEquipmentClientConfig] = None,
    ingestion_job_id: Optional[
        "capo_lookoutequipment.types.ingestion_job_id.IngestionJobId"
    ] = None,
    max_results: Optional[
        "capo_lookoutequipment.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_lookoutequipment.types.next_token.NextToken"] = None,
) -> "capo_lookoutequipment.types.list_sensor_statistics_response.ListSensorStatisticsResponse":
    """<p> Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job. </p>

    Args:
        dataset_name: <p> The name of the dataset associated with the list of Sensor Statistics. </p>
        ingestion_job_id: <p> The ingestion job id associated with the list of Sensor Statistics. To get sensor statistics for a particular ingestion job id, both dataset name and ingestion job id must be submitted as inputs. </p>
        max_results: <p>Specifies the maximum number of sensors for which to retrieve statistics. </p>
        next_token: <p>An opaque pagination token indicating where to continue the listing of sensor statistics. </p>

    Raises:
        capo_lookoutequipment.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have access to the resource. </p>
        capo_lookoutequipment.errors.internal_server_exception.InternalServerException: <p> Processing of the request has failed because of an unknown error, exception or failure. </p>
        capo_lookoutequipment.errors.resource_not_found_exception.ResourceNotFoundException: <p> The resource requested could not be found. Verify the resource ID and retry your request. </p>
        capo_lookoutequipment.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_lookoutequipment.errors.validation_exception.ValidationException: <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized. </p>
        capo_lookoutequipment.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lookoutequipment.types.list_sensor_statistics_request.ListSensorStatisticsRequest]",
    ) -> OperationResponse[
        "capo_lookoutequipment.types.list_sensor_statistics_response.ListSensorStatisticsResponse"
    ]:
        import capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.list_sensor_statistics

        output, http_response = (
            capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.list_sensor_statistics.list_sensor_statistics(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSensorStatistics")
    )
    input_: capo_lookoutequipment.types.list_sensor_statistics_request.ListSensorStatisticsRequest = {
        "dataset_name": dataset_name
    }
    if ingestion_job_id is not None:
        input_["ingestion_job_id"] = ingestion_job_id
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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