amazonka-lookoutequipment-2.0: Amazon Lookout for Equipment SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LookoutEquipment.Lens

Description

 
Synopsis

Operations

CreateDataset

createDataset_datasetSchema :: Lens' CreateDataset (Maybe DatasetSchema) Source #

A JSON description of the data that is in each time series dataset, including names, column names, and data types.

createDataset_serverSideKmsKeyId :: Lens' CreateDataset (Maybe Text) Source #

Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

createDataset_tags :: Lens' CreateDataset (Maybe [Tag]) Source #

Any tags associated with the ingested data described in the dataset.

createDataset_datasetName :: Lens' CreateDataset Text Source #

The name of the dataset being created.

createDataset_clientToken :: Lens' CreateDataset Text Source #

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset being created.

createDatasetResponse_status :: Lens' CreateDatasetResponse (Maybe DatasetStatus) Source #

Indicates the status of the CreateDataset operation.

CreateInferenceScheduler

createInferenceScheduler_dataDelayOffsetInMinutes :: Lens' CreateInferenceScheduler (Maybe Natural) Source #

The interval (in minutes) of planned delay at the start of each inference segment. For example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and restart the scheduler when uploading new data.

For more information, see Understanding the inference process.

createInferenceScheduler_serverSideKmsKeyId :: Lens' CreateInferenceScheduler (Maybe Text) Source #

Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.

createInferenceScheduler_tags :: Lens' CreateInferenceScheduler (Maybe [Tag]) Source #

Any tags associated with the inference scheduler.

createInferenceScheduler_modelName :: Lens' CreateInferenceScheduler Text Source #

The name of the previously trained ML model being used to create the inference scheduler.

createInferenceScheduler_inferenceSchedulerName :: Lens' CreateInferenceScheduler Text Source #

The name of the inference scheduler being created.

createInferenceScheduler_dataUploadFrequency :: Lens' CreateInferenceScheduler DataUploadFrequency Source #

How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment runs inference on your data.

For more information, see Understanding the inference process.

createInferenceScheduler_dataInputConfiguration :: Lens' CreateInferenceScheduler InferenceInputConfiguration Source #

Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

createInferenceScheduler_dataOutputConfiguration :: Lens' CreateInferenceScheduler InferenceOutputConfiguration Source #

Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.

createInferenceScheduler_roleArn :: Lens' CreateInferenceScheduler Text Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.

createInferenceScheduler_clientToken :: Lens' CreateInferenceScheduler Text Source #

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

createInferenceSchedulerResponse_inferenceSchedulerArn :: Lens' CreateInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the inference scheduler being created.

CreateLabel

createLabel_equipment :: Lens' CreateLabel (Maybe Text) Source #

Indicates that a label pertains to a particular piece of equipment.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabel_faultCode :: Lens' CreateLabel (Maybe Text) Source #

Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabel_notes :: Lens' CreateLabel (Maybe Text) Source #

Metadata providing additional information about the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabel_labelGroupName :: Lens' CreateLabel Text Source #

The name of a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabel_startTime :: Lens' CreateLabel UTCTime Source #

The start time of the labeled event.

createLabel_endTime :: Lens' CreateLabel UTCTime Source #

The end time of the labeled event.

createLabel_rating :: Lens' CreateLabel LabelRating Source #

Indicates whether a labeled event represents an anomaly.

createLabel_clientToken :: Lens' CreateLabel Text Source #

A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.

createLabelResponse_labelId :: Lens' CreateLabelResponse (Maybe Text) Source #

The ID of the label that you have created.

CreateLabelGroup

createLabelGroup_faultCodes :: Lens' CreateLabelGroup (Maybe [Text]) Source #

The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabelGroup_tags :: Lens' CreateLabelGroup (Maybe [Tag]) Source #

Tags that provide metadata about the label group you are creating.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabelGroup_labelGroupName :: Lens' CreateLabelGroup Text Source #

Names a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabelGroup_clientToken :: Lens' CreateLabelGroup Text Source #

A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.

createLabelGroupResponse_labelGroupArn :: Lens' CreateLabelGroupResponse (Maybe Text) Source #

The ARN of the label group that you have created.

createLabelGroupResponse_labelGroupName :: Lens' CreateLabelGroupResponse (Maybe Text) Source #

The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.

CreateModel

createModel_dataPreProcessingConfiguration :: Lens' CreateModel (Maybe DataPreProcessingConfiguration) Source #

The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

createModel_datasetSchema :: Lens' CreateModel (Maybe DatasetSchema) Source #

The data schema for the ML model being created.

createModel_evaluationDataEndTime :: Lens' CreateModel (Maybe UTCTime) Source #

Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.

createModel_evaluationDataStartTime :: Lens' CreateModel (Maybe UTCTime) Source #

Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.

createModel_labelsInputConfiguration :: Lens' CreateModel (Maybe LabelsInputConfiguration) Source #

The input configuration for the labels being used for the ML model that's being created.

createModel_offCondition :: Lens' CreateModel (Maybe Text) Source #

Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

createModel_roleArn :: Lens' CreateModel (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.

createModel_serverSideKmsKeyId :: Lens' CreateModel (Maybe Text) Source #

Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.

createModel_tags :: Lens' CreateModel (Maybe [Tag]) Source #

Any tags associated with the ML model being created.

createModel_trainingDataEndTime :: Lens' CreateModel (Maybe UTCTime) Source #

Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.

createModel_trainingDataStartTime :: Lens' CreateModel (Maybe UTCTime) Source #

Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.

createModel_modelName :: Lens' CreateModel Text Source #

The name for the ML model to be created.

createModel_datasetName :: Lens' CreateModel Text Source #

The name of the dataset for the ML model being created.

createModel_clientToken :: Lens' CreateModel Text Source #

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

createModelResponse_modelArn :: Lens' CreateModelResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model being created.

createModelResponse_status :: Lens' CreateModelResponse (Maybe ModelStatus) Source #

Indicates the status of the CreateModel operation.

DeleteDataset

deleteDataset_datasetName :: Lens' DeleteDataset Text Source #

The name of the dataset to be deleted.

DeleteInferenceScheduler

deleteInferenceScheduler_inferenceSchedulerName :: Lens' DeleteInferenceScheduler Text Source #

The name of the inference scheduler to be deleted.

DeleteLabel

deleteLabel_labelGroupName :: Lens' DeleteLabel Text Source #

The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.

deleteLabel_labelId :: Lens' DeleteLabel Text Source #

The ID of the label that you want to delete.

DeleteLabelGroup

deleteLabelGroup_labelGroupName :: Lens' DeleteLabelGroup Text Source #

The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.

DeleteModel

deleteModel_modelName :: Lens' DeleteModel Text Source #

The name of the ML model to be deleted.

DescribeDataIngestionJob

describeDataIngestionJobResponse_dataEndTime :: Lens' DescribeDataIngestionJobResponse (Maybe UTCTime) Source #

Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

describeDataIngestionJobResponse_dataQualitySummary :: Lens' DescribeDataIngestionJobResponse (Maybe DataQualitySummary) Source #

Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

describeDataIngestionJobResponse_dataStartTime :: Lens' DescribeDataIngestionJobResponse (Maybe UTCTime) Source #

Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

describeDataIngestionJobResponse_datasetArn :: Lens' DescribeDataIngestionJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.

describeDataIngestionJobResponse_failedReason :: Lens' DescribeDataIngestionJobResponse (Maybe Text) Source #

Specifies the reason for failure when a data ingestion job has failed.

describeDataIngestionJobResponse_ingestionInputConfiguration :: Lens' DescribeDataIngestionJobResponse (Maybe IngestionInputConfiguration) Source #

Specifies the S3 location configuration for the data input for the data ingestion job.

describeDataIngestionJobResponse_roleArn :: Lens' DescribeDataIngestionJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.

describeDataIngestionJobResponse_statusDetail :: Lens' DescribeDataIngestionJobResponse (Maybe Text) Source #

Provides details about status of the ingestion job that is currently in progress.

DescribeDataset

describeDataset_datasetName :: Lens' DescribeDataset Text Source #

The name of the dataset to be described.

describeDatasetResponse_createdAt :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #

Specifies the time the dataset was created in Lookout for Equipment.

describeDatasetResponse_dataEndTime :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #

Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

describeDatasetResponse_dataQualitySummary :: Lens' DescribeDatasetResponse (Maybe DataQualitySummary) Source #

Gives statistics associated with the given dataset for the latest successful associated ingestion job id. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

describeDatasetResponse_dataStartTime :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #

Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

describeDatasetResponse_datasetArn :: Lens' DescribeDatasetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset being described.

describeDatasetResponse_ingestedFilesSummary :: Lens' DescribeDatasetResponse (Maybe IngestedFilesSummary) Source #

IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.

describeDatasetResponse_ingestionInputConfiguration :: Lens' DescribeDatasetResponse (Maybe IngestionInputConfiguration) Source #

Specifies the S3 location configuration for the data input for the data ingestion job.

describeDatasetResponse_lastUpdatedAt :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #

Specifies the time the dataset was last updated, if it was.

describeDatasetResponse_roleArn :: Lens' DescribeDatasetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.

describeDatasetResponse_schema :: Lens' DescribeDatasetResponse (Maybe Text) Source #

A JSON description of the data that is in each time series dataset, including names, column names, and data types.

describeDatasetResponse_serverSideKmsKeyId :: Lens' DescribeDatasetResponse (Maybe Text) Source #

Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

DescribeInferenceScheduler

describeInferenceSchedulerResponse_createdAt :: Lens' DescribeInferenceSchedulerResponse (Maybe UTCTime) Source #

Specifies the time at which the inference scheduler was created.

describeInferenceSchedulerResponse_dataDelayOffsetInMinutes :: Lens' DescribeInferenceSchedulerResponse (Maybe Natural) Source #

A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

describeInferenceSchedulerResponse_dataInputConfiguration :: Lens' DescribeInferenceSchedulerResponse (Maybe InferenceInputConfiguration) Source #

Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

describeInferenceSchedulerResponse_dataOutputConfiguration :: Lens' DescribeInferenceSchedulerResponse (Maybe InferenceOutputConfiguration) Source #

Specifies information for the output results for the inference scheduler, including the output S3 location.

describeInferenceSchedulerResponse_dataUploadFrequency :: Lens' DescribeInferenceSchedulerResponse (Maybe DataUploadFrequency) Source #

Specifies how often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

describeInferenceSchedulerResponse_inferenceSchedulerArn :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the inference scheduler being described.

describeInferenceSchedulerResponse_latestInferenceResult :: Lens' DescribeInferenceSchedulerResponse (Maybe LatestInferenceResult) Source #

Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

describeInferenceSchedulerResponse_modelArn :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.

describeInferenceSchedulerResponse_modelName :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

The name of the ML model of the inference scheduler being described.

describeInferenceSchedulerResponse_roleArn :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.

describeInferenceSchedulerResponse_serverSideKmsKeyId :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.

describeInferenceSchedulerResponse_updatedAt :: Lens' DescribeInferenceSchedulerResponse (Maybe UTCTime) Source #

Specifies the time at which the inference scheduler was last updated, if it was.

DescribeLabel

describeLabel_labelGroupName :: Lens' DescribeLabel Text Source #

Returns the name of the group containing the label.

describeLabel_labelId :: Lens' DescribeLabel Text Source #

Returns the ID of the label.

describeLabelResponse_createdAt :: Lens' DescribeLabelResponse (Maybe UTCTime) Source #

The time at which the label was created.

describeLabelResponse_equipment :: Lens' DescribeLabelResponse (Maybe Text) Source #

Indicates that a label pertains to a particular piece of equipment.

describeLabelResponse_faultCode :: Lens' DescribeLabelResponse (Maybe Text) Source #

Indicates the type of anomaly associated with the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

describeLabelResponse_notes :: Lens' DescribeLabelResponse (Maybe Text) Source #

Metadata providing additional information about the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

describeLabelResponse_rating :: Lens' DescribeLabelResponse (Maybe LabelRating) Source #

Indicates whether a labeled event represents an anomaly.

DescribeLabelGroup

describeLabelGroupResponse_faultCodes :: Lens' DescribeLabelGroupResponse (Maybe [Text]) Source #

Codes indicating the type of anomaly associated with the labels in the lagbel group.

DescribeModel

describeModel_modelName :: Lens' DescribeModel Text Source #

The name of the ML model to be described.

describeModelResponse_createdAt :: Lens' DescribeModelResponse (Maybe UTCTime) Source #

Indicates the time and date at which the ML model was created.

describeModelResponse_dataPreProcessingConfiguration :: Lens' DescribeModelResponse (Maybe DataPreProcessingConfiguration) Source #

The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

describeModelResponse_datasetArn :: Lens' DescribeModelResponse (Maybe Text) Source #

The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.

describeModelResponse_datasetName :: Lens' DescribeModelResponse (Maybe Text) Source #

The name of the dataset being used by the ML being described.

describeModelResponse_evaluationDataEndTime :: Lens' DescribeModelResponse (Maybe UTCTime) Source #

Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.

describeModelResponse_evaluationDataStartTime :: Lens' DescribeModelResponse (Maybe UTCTime) Source #

Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.

describeModelResponse_failedReason :: Lens' DescribeModelResponse (Maybe Text) Source #

If the training of the ML model failed, this indicates the reason for that failure.

describeModelResponse_labelsInputConfiguration :: Lens' DescribeModelResponse (Maybe LabelsInputConfiguration) Source #

Specifies configuration information about the labels input, including its S3 location.

describeModelResponse_lastUpdatedTime :: Lens' DescribeModelResponse (Maybe UTCTime) Source #

Indicates the last time the ML model was updated. The type of update is not specified.

describeModelResponse_modelArn :: Lens' DescribeModelResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the ML model being described.

describeModelResponse_modelMetrics :: Lens' DescribeModelResponse (Maybe Text) Source #

The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.

describeModelResponse_modelName :: Lens' DescribeModelResponse (Maybe Text) Source #

The name of the ML model being described.

describeModelResponse_offCondition :: Lens' DescribeModelResponse (Maybe Text) Source #

Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

describeModelResponse_roleArn :: Lens' DescribeModelResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.

describeModelResponse_schema :: Lens' DescribeModelResponse (Maybe Text) Source #

A JSON description of the data that is in each time series dataset, including names, column names, and data types.

describeModelResponse_serverSideKmsKeyId :: Lens' DescribeModelResponse (Maybe Text) Source #

Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.

describeModelResponse_status :: Lens' DescribeModelResponse (Maybe ModelStatus) Source #

Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

describeModelResponse_trainingDataEndTime :: Lens' DescribeModelResponse (Maybe UTCTime) Source #

Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.

describeModelResponse_trainingDataStartTime :: Lens' DescribeModelResponse (Maybe UTCTime) Source #

Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.

describeModelResponse_trainingExecutionEndTime :: Lens' DescribeModelResponse (Maybe UTCTime) Source #

Indicates the time at which the training of the ML model was completed.

describeModelResponse_trainingExecutionStartTime :: Lens' DescribeModelResponse (Maybe UTCTime) Source #

Indicates the time at which the training of the ML model began.

ListDataIngestionJobs

listDataIngestionJobs_datasetName :: Lens' ListDataIngestionJobs (Maybe Text) Source #

The name of the dataset being used for the data ingestion job.

listDataIngestionJobs_maxResults :: Lens' ListDataIngestionJobs (Maybe Natural) Source #

Specifies the maximum number of data ingestion jobs to list.

listDataIngestionJobs_nextToken :: Lens' ListDataIngestionJobs (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of data ingestion jobs.

listDataIngestionJobs_status :: Lens' ListDataIngestionJobs (Maybe IngestionJobStatus) Source #

Indicates the status of the data ingestion job.

listDataIngestionJobsResponse_dataIngestionJobSummaries :: Lens' ListDataIngestionJobsResponse (Maybe [DataIngestionJobSummary]) Source #

Specifies information about the specific data ingestion job, including dataset name and status.

listDataIngestionJobsResponse_nextToken :: Lens' ListDataIngestionJobsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of data ingestion jobs.

ListDatasets

listDatasets_datasetNameBeginsWith :: Lens' ListDatasets (Maybe Text) Source #

The beginning of the name of the datasets to be listed.

listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural) Source #

Specifies the maximum number of datasets to list.

listDatasets_nextToken :: Lens' ListDatasets (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of datasets.

listDatasetsResponse_datasetSummaries :: Lens' ListDatasetsResponse (Maybe [DatasetSummary]) Source #

Provides information about the specified dataset, including creation time, dataset ARN, and status.

listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of datasets.

ListInferenceEvents

listInferenceEvents_maxResults :: Lens' ListInferenceEvents (Maybe Natural) Source #

Specifies the maximum number of inference events to list.

listInferenceEvents_nextToken :: Lens' ListInferenceEvents (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of inference events.

listInferenceEvents_inferenceSchedulerName :: Lens' ListInferenceEvents Text Source #

The name of the inference scheduler for the inference events listed.

listInferenceEvents_intervalStartTime :: Lens' ListInferenceEvents UTCTime Source #

Lookout for Equipment will return all the inference events with an end time equal to or greater than the start time given.

listInferenceEvents_intervalEndTime :: Lens' ListInferenceEvents UTCTime Source #

Returns all the inference events with an end start time equal to or greater than less than the end time given

listInferenceEventsResponse_inferenceEventSummaries :: Lens' ListInferenceEventsResponse (Maybe [InferenceEventSummary]) Source #

Provides an array of information about the individual inference events returned from the ListInferenceEvents operation, including scheduler used, event start time, event end time, diagnostics, and so on.

listInferenceEventsResponse_nextToken :: Lens' ListInferenceEventsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of inference executions.

ListInferenceExecutions

listInferenceExecutions_dataEndTimeBefore :: Lens' ListInferenceExecutions (Maybe UTCTime) Source #

The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the inference execution.

listInferenceExecutions_dataStartTimeAfter :: Lens' ListInferenceExecutions (Maybe UTCTime) Source #

The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference execution.

listInferenceExecutions_maxResults :: Lens' ListInferenceExecutions (Maybe Natural) Source #

Specifies the maximum number of inference executions to list.

listInferenceExecutions_nextToken :: Lens' ListInferenceExecutions (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of inference executions.

listInferenceExecutions_inferenceSchedulerName :: Lens' ListInferenceExecutions Text Source #

The name of the inference scheduler for the inference execution listed.

listInferenceExecutionsResponse_inferenceExecutionSummaries :: Lens' ListInferenceExecutionsResponse (Maybe [InferenceExecutionSummary]) Source #

Provides an array of information about the individual inference executions returned from the ListInferenceExecutions operation, including model used, inference scheduler, data configuration, and so on.

listInferenceExecutionsResponse_nextToken :: Lens' ListInferenceExecutionsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of inference executions.

ListInferenceSchedulers

listInferenceSchedulers_inferenceSchedulerNameBeginsWith :: Lens' ListInferenceSchedulers (Maybe Text) Source #

The beginning of the name of the inference schedulers to be listed.

listInferenceSchedulers_maxResults :: Lens' ListInferenceSchedulers (Maybe Natural) Source #

Specifies the maximum number of inference schedulers to list.

listInferenceSchedulers_modelName :: Lens' ListInferenceSchedulers (Maybe Text) Source #

The name of the ML model used by the inference scheduler to be listed.

listInferenceSchedulers_nextToken :: Lens' ListInferenceSchedulers (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of inference schedulers.

listInferenceSchedulers_status :: Lens' ListInferenceSchedulers (Maybe InferenceSchedulerStatus) Source #

Specifies the current status of the inference schedulers to list.

listInferenceSchedulersResponse_inferenceSchedulerSummaries :: Lens' ListInferenceSchedulersResponse (Maybe [InferenceSchedulerSummary]) Source #

Provides information about the specified inference scheduler, including data upload frequency, model name and ARN, and status.

listInferenceSchedulersResponse_nextToken :: Lens' ListInferenceSchedulersResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of inference schedulers.

ListLabelGroups

listLabelGroups_labelGroupNameBeginsWith :: Lens' ListLabelGroups (Maybe Text) Source #

The beginning of the name of the label groups to be listed.

listLabelGroups_maxResults :: Lens' ListLabelGroups (Maybe Natural) Source #

Specifies the maximum number of label groups to list.

listLabelGroups_nextToken :: Lens' ListLabelGroups (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of label groups.

listLabelGroupsResponse_nextToken :: Lens' ListLabelGroupsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of label groups.

ListLabels

listLabels_equipment :: Lens' ListLabels (Maybe Text) Source #

Lists the labels that pertain to a particular piece of equipment.

listLabels_faultCode :: Lens' ListLabels (Maybe Text) Source #

Returns labels with a particular fault code.

listLabels_intervalEndTime :: Lens' ListLabels (Maybe UTCTime) Source #

Returns all labels with a start time earlier than the end time given.

listLabels_intervalStartTime :: Lens' ListLabels (Maybe UTCTime) Source #

Returns all the labels with a end time equal to or later than the start time given.

listLabels_maxResults :: Lens' ListLabels (Maybe Natural) Source #

Specifies the maximum number of labels to list.

listLabels_nextToken :: Lens' ListLabels (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of label groups.

listLabels_labelGroupName :: Lens' ListLabels Text Source #

Retruns the name of the label group.

listLabelsResponse_labelSummaries :: Lens' ListLabelsResponse (Maybe [LabelSummary]) Source #

A summary of the items in the label group.

listLabelsResponse_nextToken :: Lens' ListLabelsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of datasets.

ListModels

listModels_datasetNameBeginsWith :: Lens' ListModels (Maybe Text) Source #

The beginning of the name of the dataset of the ML models to be listed.

listModels_maxResults :: Lens' ListModels (Maybe Natural) Source #

Specifies the maximum number of ML models to list.

listModels_modelNameBeginsWith :: Lens' ListModels (Maybe Text) Source #

The beginning of the name of the ML models being listed.

listModels_nextToken :: Lens' ListModels (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of ML models.

listModels_status :: Lens' ListModels (Maybe ModelStatus) Source #

The status of the ML model.

listModelsResponse_modelSummaries :: Lens' ListModelsResponse (Maybe [ModelSummary]) Source #

Provides information on the specified model, including created time, model and dataset ARNs, and status.

listModelsResponse_nextToken :: Lens' ListModelsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of ML models.

ListSensorStatistics

listSensorStatistics_ingestionJobId :: Lens' ListSensorStatistics (Maybe Text) Source #

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.

listSensorStatistics_maxResults :: Lens' ListSensorStatistics (Maybe Natural) Source #

Specifies the maximum number of sensors for which to retrieve statistics.

listSensorStatistics_nextToken :: Lens' ListSensorStatistics (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of sensor statistics.

listSensorStatistics_datasetName :: Lens' ListSensorStatistics Text Source #

The name of the dataset associated with the list of Sensor Statistics.

listSensorStatisticsResponse_nextToken :: Lens' ListSensorStatisticsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of sensor statistics.

listSensorStatisticsResponse_sensorStatisticsSummaries :: Lens' ListSensorStatisticsResponse (Maybe [SensorStatisticsSummary]) Source #

Provides ingestion-based statistics regarding the specified sensor with respect to various validation types, such as whether data exists, the number and percentage of missing values, and the number and percentage of duplicate timestamps.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource (such as the dataset or model) that is the focus of the ListTagsForResource operation.

StartDataIngestionJob

startDataIngestionJob_datasetName :: Lens' StartDataIngestionJob Text Source #

The name of the dataset being used by the data ingestion job.

startDataIngestionJob_ingestionInputConfiguration :: Lens' StartDataIngestionJob IngestionInputConfiguration Source #

Specifies information for the input data for the data ingestion job, including dataset S3 location.

startDataIngestionJob_roleArn :: Lens' StartDataIngestionJob Text Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.

startDataIngestionJob_clientToken :: Lens' StartDataIngestionJob Text Source #

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

startDataIngestionJobResponse_jobId :: Lens' StartDataIngestionJobResponse (Maybe Text) Source #

Indicates the job ID of the data ingestion job.

startDataIngestionJobResponse_status :: Lens' StartDataIngestionJobResponse (Maybe IngestionJobStatus) Source #

Indicates the status of the StartDataIngestionJob operation.

StartInferenceScheduler

startInferenceScheduler_inferenceSchedulerName :: Lens' StartInferenceScheduler Text Source #

The name of the inference scheduler to be started.

startInferenceSchedulerResponse_inferenceSchedulerArn :: Lens' StartInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the inference scheduler being started.

startInferenceSchedulerResponse_modelArn :: Lens' StartInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.

startInferenceSchedulerResponse_modelName :: Lens' StartInferenceSchedulerResponse (Maybe Text) Source #

The name of the ML model being used by the inference scheduler.

StopInferenceScheduler

stopInferenceScheduler_inferenceSchedulerName :: Lens' StopInferenceScheduler Text Source #

The name of the inference scheduler to be stopped.

stopInferenceSchedulerResponse_inferenceSchedulerArn :: Lens' StopInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the inference schedule being stopped.

stopInferenceSchedulerResponse_modelArn :: Lens' StopInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being stopped.

stopInferenceSchedulerResponse_modelName :: Lens' StopInferenceSchedulerResponse (Maybe Text) Source #

The name of the ML model used by the inference scheduler being stopped.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the specific resource to which the tag should be associated.

tagResource_tags :: Lens' TagResource [Tag] Source #

The tag or tags to be associated with a specific resource. Both the tag key and value are specified.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

Specifies the key of the tag to be removed from a specified resource.

UpdateInferenceScheduler

updateInferenceScheduler_dataDelayOffsetInMinutes :: Lens' UpdateInferenceScheduler (Maybe Natural) Source #

A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

updateInferenceScheduler_dataInputConfiguration :: Lens' UpdateInferenceScheduler (Maybe InferenceInputConfiguration) Source #

Specifies information for the input data for the inference scheduler, including delimiter, format, and dataset location.

updateInferenceScheduler_dataOutputConfiguration :: Lens' UpdateInferenceScheduler (Maybe InferenceOutputConfiguration) Source #

Specifies information for the output results from the inference scheduler, including the output S3 location.

updateInferenceScheduler_dataUploadFrequency :: Lens' UpdateInferenceScheduler (Maybe DataUploadFrequency) Source #

How often data is uploaded to the source S3 bucket for the input data. The value chosen is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

updateInferenceScheduler_roleArn :: Lens' UpdateInferenceScheduler (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.

updateInferenceScheduler_inferenceSchedulerName :: Lens' UpdateInferenceScheduler Text Source #

The name of the inference scheduler to be updated.

UpdateLabelGroup

updateLabelGroup_faultCodes :: Lens' UpdateLabelGroup (Maybe [Text]) Source #

Updates the code indicating the type of anomaly associated with the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

updateLabelGroup_labelGroupName :: Lens' UpdateLabelGroup Text Source #

The name of the label group to be updated.

Types

CategoricalValues

categoricalValues_numberOfCategory :: Lens' CategoricalValues (Maybe Int) Source #

Indicates the number of categories in the data.

categoricalValues_status :: Lens' CategoricalValues StatisticalIssueStatus Source #

Indicates whether there is a potential data issue related to categorical values.

CountPercent

countPercent_count :: Lens' CountPercent Int Source #

Indicates the count of occurences of the given statistic.

countPercent_percentage :: Lens' CountPercent Double Source #

Indicates the percentage of occurances of the given statistic.

DataIngestionJobSummary

dataIngestionJobSummary_datasetArn :: Lens' DataIngestionJobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset used in the data ingestion job.

dataIngestionJobSummary_datasetName :: Lens' DataIngestionJobSummary (Maybe Text) Source #

The name of the dataset used for the data ingestion job.

dataIngestionJobSummary_ingestionInputConfiguration :: Lens' DataIngestionJobSummary (Maybe IngestionInputConfiguration) Source #

Specifies information for the input data for the data inference job, including data Amazon S3 location parameters.

dataIngestionJobSummary_jobId :: Lens' DataIngestionJobSummary (Maybe Text) Source #

Indicates the job ID of the data ingestion job.

DataPreProcessingConfiguration

dataPreProcessingConfiguration_targetSamplingRate :: Lens' DataPreProcessingConfiguration (Maybe TargetSamplingRate) Source #

The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

DataQualitySummary

dataQualitySummary_insufficientSensorData :: Lens' DataQualitySummary InsufficientSensorData Source #

Parameter that gives information about insufficient data for sensors in the dataset. This includes information about those sensors that have complete data missing and those with a short date range.

dataQualitySummary_missingSensorData :: Lens' DataQualitySummary MissingSensorData Source #

Parameter that gives information about data that is missing over all the sensors in the input data.

dataQualitySummary_invalidSensorData :: Lens' DataQualitySummary InvalidSensorData Source #

Parameter that gives information about data that is invalid over all the sensors in the input data.

dataQualitySummary_unsupportedTimestamps :: Lens' DataQualitySummary UnsupportedTimestamps Source #

Parameter that gives information about unsupported timestamps in the input data.

dataQualitySummary_duplicateTimestamps :: Lens' DataQualitySummary DuplicateTimestamps Source #

Parameter that gives information about duplicate timestamps in the input data.

DatasetSchema

DatasetSummary

datasetSummary_createdAt :: Lens' DatasetSummary (Maybe UTCTime) Source #

The time at which the dataset was created in Amazon Lookout for Equipment.

datasetSummary_datasetArn :: Lens' DatasetSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the specified dataset.

datasetSummary_status :: Lens' DatasetSummary (Maybe DatasetStatus) Source #

Indicates the status of the dataset.

DuplicateTimestamps

duplicateTimestamps_totalNumberOfDuplicateTimestamps :: Lens' DuplicateTimestamps Int Source #

Indicates the total number of duplicate timestamps.

InferenceEventSummary

inferenceEventSummary_diagnostics :: Lens' InferenceEventSummary (Maybe Text) Source #

An array which specifies the names and values of all sensors contributing to an inference event.

inferenceEventSummary_eventDurationInSeconds :: Lens' InferenceEventSummary (Maybe Natural) Source #

Indicates the size of an inference event in seconds.

inferenceEventSummary_eventEndTime :: Lens' InferenceEventSummary (Maybe UTCTime) Source #

Indicates the ending time of an inference event.

inferenceEventSummary_eventStartTime :: Lens' InferenceEventSummary (Maybe UTCTime) Source #

Indicates the starting time of an inference event.

inferenceEventSummary_inferenceSchedulerArn :: Lens' InferenceEventSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the inference scheduler being used for the inference event.

inferenceEventSummary_inferenceSchedulerName :: Lens' InferenceEventSummary (Maybe Text) Source #

The name of the inference scheduler being used for the inference events.

InferenceExecutionSummary

inferenceExecutionSummary_dataEndTime :: Lens' InferenceExecutionSummary (Maybe UTCTime) Source #

Indicates the time reference in the dataset at which the inference execution stopped.

inferenceExecutionSummary_dataInputConfiguration :: Lens' InferenceExecutionSummary (Maybe InferenceInputConfiguration) Source #

Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

inferenceExecutionSummary_dataOutputConfiguration :: Lens' InferenceExecutionSummary (Maybe InferenceOutputConfiguration) Source #

Specifies configuration information for the output results from for the inference execution, including the output Amazon S3 location.

inferenceExecutionSummary_dataStartTime :: Lens' InferenceExecutionSummary (Maybe UTCTime) Source #

Indicates the time reference in the dataset at which the inference execution began.

inferenceExecutionSummary_failedReason :: Lens' InferenceExecutionSummary (Maybe Text) Source #

Specifies the reason for failure when an inference execution has failed.

inferenceExecutionSummary_inferenceSchedulerArn :: Lens' InferenceExecutionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the inference scheduler being used for the inference execution.

inferenceExecutionSummary_inferenceSchedulerName :: Lens' InferenceExecutionSummary (Maybe Text) Source #

The name of the inference scheduler being used for the inference execution.

inferenceExecutionSummary_modelArn :: Lens' InferenceExecutionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the ML model used for the inference execution.

inferenceExecutionSummary_modelName :: Lens' InferenceExecutionSummary (Maybe Text) Source #

The name of the ML model being used for the inference execution.

inferenceExecutionSummary_scheduledStartTime :: Lens' InferenceExecutionSummary (Maybe UTCTime) Source #

Indicates the start time at which the inference scheduler began the specific inference execution.

InferenceInputConfiguration

inferenceInputConfiguration_inferenceInputNameConfiguration :: Lens' InferenceInputConfiguration (Maybe InferenceInputNameConfiguration) Source #

Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

inferenceInputConfiguration_inputTimeZoneOffset :: Lens' InferenceInputConfiguration (Maybe Text) Source #

Indicates the difference between your time zone and Coordinated Universal Time (UTC).

inferenceInputConfiguration_s3InputConfiguration :: Lens' InferenceInputConfiguration (Maybe InferenceS3InputConfiguration) Source #

Specifies configuration information for the input data for the inference, including Amazon S3 location of input data.

InferenceInputNameConfiguration

inferenceInputNameConfiguration_componentTimestampDelimiter :: Lens' InferenceInputNameConfiguration (Maybe Text) Source #

Indicates the delimiter character used between items in the data.

inferenceInputNameConfiguration_timestampFormat :: Lens' InferenceInputNameConfiguration (Maybe Text) Source #

The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

InferenceOutputConfiguration

inferenceOutputConfiguration_kmsKeyId :: Lens' InferenceOutputConfiguration (Maybe Text) Source #

The ID number for the AWS KMS key used to encrypt the inference output.

inferenceOutputConfiguration_s3OutputConfiguration :: Lens' InferenceOutputConfiguration InferenceS3OutputConfiguration Source #

Specifies configuration information for the output results from for the inference, output S3 location.

InferenceS3InputConfiguration

inferenceS3InputConfiguration_prefix :: Lens' InferenceS3InputConfiguration (Maybe Text) Source #

The prefix for the S3 bucket used for the input data for the inference.

inferenceS3InputConfiguration_bucket :: Lens' InferenceS3InputConfiguration Text Source #

The bucket containing the input dataset for the inference.

InferenceS3OutputConfiguration

inferenceS3OutputConfiguration_prefix :: Lens' InferenceS3OutputConfiguration (Maybe Text) Source #

The prefix for the S3 bucket used for the output results from the inference.

inferenceS3OutputConfiguration_bucket :: Lens' InferenceS3OutputConfiguration Text Source #

The bucket containing the output results from the inference

InferenceSchedulerSummary

inferenceSchedulerSummary_dataDelayOffsetInMinutes :: Lens' InferenceSchedulerSummary (Maybe Natural) Source #

A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if an offset delay time of five minutes was selected, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

inferenceSchedulerSummary_dataUploadFrequency :: Lens' InferenceSchedulerSummary (Maybe DataUploadFrequency) Source #

How often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

inferenceSchedulerSummary_inferenceSchedulerArn :: Lens' InferenceSchedulerSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the inference scheduler.

inferenceSchedulerSummary_latestInferenceResult :: Lens' InferenceSchedulerSummary (Maybe LatestInferenceResult) Source #

Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

inferenceSchedulerSummary_modelArn :: Lens' InferenceSchedulerSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the ML model used by the inference scheduler.

inferenceSchedulerSummary_modelName :: Lens' InferenceSchedulerSummary (Maybe Text) Source #

The name of the ML model used for the inference scheduler.

IngestedFilesSummary

ingestedFilesSummary_discardedFiles :: Lens' IngestedFilesSummary (Maybe [S3Object]) Source #

Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.

ingestedFilesSummary_totalNumberOfFiles :: Lens' IngestedFilesSummary Int Source #

Indicates the total number of files that were submitted for ingestion.

ingestedFilesSummary_ingestedNumberOfFiles :: Lens' IngestedFilesSummary Int Source #

Indicates the number of files that were successfully ingested.

IngestionInputConfiguration

ingestionInputConfiguration_s3InputConfiguration :: Lens' IngestionInputConfiguration IngestionS3InputConfiguration Source #

The location information for the S3 bucket used for input data for the data ingestion.

IngestionS3InputConfiguration

ingestionS3InputConfiguration_keyPattern :: Lens' IngestionS3InputConfiguration (Maybe Text) Source #

Pattern for matching the Amazon S3 files which will be used for ingestion. If no KeyPattern is provided, we will use the default hierarchy file structure, which is same as KeyPattern {prefix}/{component_name}/*

ingestionS3InputConfiguration_prefix :: Lens' IngestionS3InputConfiguration (Maybe Text) Source #

The prefix for the S3 location being used for the input data for the data ingestion.

ingestionS3InputConfiguration_bucket :: Lens' IngestionS3InputConfiguration Text Source #

The name of the S3 bucket used for the input data for the data ingestion.

InsufficientSensorData

insufficientSensorData_missingCompleteSensorData :: Lens' InsufficientSensorData MissingCompleteSensorData Source #

Parameter that describes the total number of sensors that have data completely missing for it.

insufficientSensorData_sensorsWithShortDateRange :: Lens' InsufficientSensorData SensorsWithShortDateRange Source #

Parameter that describes the total number of sensors that have a short date range of less than 90 days of data overall.

InvalidSensorData

invalidSensorData_affectedSensorCount :: Lens' InvalidSensorData Int Source #

Indicates the number of sensors that have at least some invalid values.

invalidSensorData_totalNumberOfInvalidValues :: Lens' InvalidSensorData Int Source #

Indicates the total number of invalid values across all the sensors.

LabelGroupSummary

labelGroupSummary_createdAt :: Lens' LabelGroupSummary (Maybe UTCTime) Source #

The time at which the label group was created.

labelGroupSummary_updatedAt :: Lens' LabelGroupSummary (Maybe UTCTime) Source #

The time at which the label group was updated.

LabelSummary

labelSummary_createdAt :: Lens' LabelSummary (Maybe UTCTime) Source #

The time at which the label was created.

labelSummary_endTime :: Lens' LabelSummary (Maybe UTCTime) Source #

The timestamp indicating the end of the label.

labelSummary_equipment :: Lens' LabelSummary (Maybe Text) Source #

Indicates that a label pertains to a particular piece of equipment.

labelSummary_faultCode :: Lens' LabelSummary (Maybe Text) Source #

Indicates the type of anomaly associated with the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

labelSummary_rating :: Lens' LabelSummary (Maybe LabelRating) Source #

Indicates whether a labeled event represents an anomaly.

labelSummary_startTime :: Lens' LabelSummary (Maybe UTCTime) Source #

The timestamp indicating the start of the label.

LabelsInputConfiguration

labelsInputConfiguration_labelGroupName :: Lens' LabelsInputConfiguration (Maybe Text) Source #

The name of the label group to be used for label data.

labelsInputConfiguration_s3InputConfiguration :: Lens' LabelsInputConfiguration (Maybe LabelsS3InputConfiguration) Source #

Contains location information for the S3 location being used for label data.

LabelsS3InputConfiguration

labelsS3InputConfiguration_prefix :: Lens' LabelsS3InputConfiguration (Maybe Text) Source #

The prefix for the S3 bucket used for the label data.

labelsS3InputConfiguration_bucket :: Lens' LabelsS3InputConfiguration Text Source #

The name of the S3 bucket holding the label data.

LargeTimestampGaps

largeTimestampGaps_maxTimestampGapInDays :: Lens' LargeTimestampGaps (Maybe Int) Source #

Indicates the size of the largest timestamp gap, in days.

largeTimestampGaps_numberOfLargeTimestampGaps :: Lens' LargeTimestampGaps (Maybe Int) Source #

Indicates the number of large timestamp gaps, if there are any.

largeTimestampGaps_status :: Lens' LargeTimestampGaps StatisticalIssueStatus Source #

Indicates whether there is a potential data issue related to large gaps in timestamps.

MissingCompleteSensorData

missingCompleteSensorData_affectedSensorCount :: Lens' MissingCompleteSensorData Int Source #

Indicates the number of sensors that have data missing completely.

MissingSensorData

missingSensorData_affectedSensorCount :: Lens' MissingSensorData Int Source #

Indicates the number of sensors that have atleast some data missing.

missingSensorData_totalNumberOfMissingValues :: Lens' MissingSensorData Int Source #

Indicates the total number of missing values across all the sensors.

ModelSummary

modelSummary_createdAt :: Lens' ModelSummary (Maybe UTCTime) Source #

The time at which the specific model was created.

modelSummary_datasetArn :: Lens' ModelSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset used to create the model.

modelSummary_datasetName :: Lens' ModelSummary (Maybe Text) Source #

The name of the dataset being used for the ML model.

modelSummary_modelArn :: Lens' ModelSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the ML model.

modelSummary_status :: Lens' ModelSummary (Maybe ModelStatus) Source #

Indicates the status of the ML model.

MonotonicValues

monotonicValues_monotonicity :: Lens' MonotonicValues (Maybe Monotonicity) Source #

Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC.

monotonicValues_status :: Lens' MonotonicValues StatisticalIssueStatus Source #

Indicates whether there is a potential data issue related to having monotonic values.

MultipleOperatingModes

multipleOperatingModes_status :: Lens' MultipleOperatingModes StatisticalIssueStatus Source #

Indicates whether there is a potential data issue related to having multiple operating modes.

S3Object

s3Object_bucket :: Lens' S3Object Text Source #

The name of the specific S3 bucket.

s3Object_key :: Lens' S3Object Text Source #

The AWS Key Management Service (AWS KMS) key being used to encrypt the S3 object. Without this key, data in the bucket is not accessible.

SensorStatisticsSummary

sensorStatisticsSummary_categoricalValues :: Lens' SensorStatisticsSummary (Maybe CategoricalValues) Source #

Parameter that describes potential risk about whether data associated with the sensor is categorical.

sensorStatisticsSummary_componentName :: Lens' SensorStatisticsSummary (Maybe Text) Source #

Name of the component to which the particular sensor belongs for which the statistics belong to.

sensorStatisticsSummary_dataEndTime :: Lens' SensorStatisticsSummary (Maybe UTCTime) Source #

Indicates the time reference to indicate the end of valid data associated with the sensor that the statistics belong to.

sensorStatisticsSummary_dataExists :: Lens' SensorStatisticsSummary (Maybe Bool) Source #

Parameter that indicates whether data exists for the sensor that the statistics belong to.

sensorStatisticsSummary_dataStartTime :: Lens' SensorStatisticsSummary (Maybe UTCTime) Source #

Indicates the time reference to indicate the beginning of valid data associated with the sensor that the statistics belong to.

sensorStatisticsSummary_duplicateTimestamps :: Lens' SensorStatisticsSummary (Maybe CountPercent) Source #

Parameter that describes the total number of duplicate timestamp records associated with the sensor that the statistics belong to.

sensorStatisticsSummary_invalidDateEntries :: Lens' SensorStatisticsSummary (Maybe CountPercent) Source #

Parameter that describes the total number of invalid date entries associated with the sensor that the statistics belong to.

sensorStatisticsSummary_invalidValues :: Lens' SensorStatisticsSummary (Maybe CountPercent) Source #

Parameter that describes the total number of, and percentage of, values that are invalid for the sensor that the statistics belong to.

sensorStatisticsSummary_largeTimestampGaps :: Lens' SensorStatisticsSummary (Maybe LargeTimestampGaps) Source #

Parameter that describes potential risk about whether data associated with the sensor contains one or more large gaps between consecutive timestamps.

sensorStatisticsSummary_missingValues :: Lens' SensorStatisticsSummary (Maybe CountPercent) Source #

Parameter that describes the total number of, and percentage of, values that are missing for the sensor that the statistics belong to.

sensorStatisticsSummary_monotonicValues :: Lens' SensorStatisticsSummary (Maybe MonotonicValues) Source #

Parameter that describes potential risk about whether data associated with the sensor is mostly monotonic.

sensorStatisticsSummary_multipleOperatingModes :: Lens' SensorStatisticsSummary (Maybe MultipleOperatingModes) Source #

Parameter that describes potential risk about whether data associated with the sensor has more than one operating mode.

sensorStatisticsSummary_sensorName :: Lens' SensorStatisticsSummary (Maybe Text) Source #

Name of the sensor that the statistics belong to.

SensorsWithShortDateRange

sensorsWithShortDateRange_affectedSensorCount :: Lens' SensorsWithShortDateRange Int Source #

Indicates the number of sensors that have less than 90 days of data.

Tag

tag_key :: Lens' Tag Text Source #

The key for the specified tag.

tag_value :: Lens' Tag Text Source #

The value for the specified tag.

UnsupportedTimestamps

unsupportedTimestamps_totalNumberOfUnsupportedTimestamps :: Lens' UnsupportedTimestamps Int Source #

Indicates the total number of unsupported timestamps across the ingested data.