Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Provides a JSON description of the data in each time series dataset, including names, column names, and data types.
Synopsis
- data DescribeDataset = DescribeDataset' {
- datasetName :: Text
- newDescribeDataset :: Text -> DescribeDataset
- describeDataset_datasetName :: Lens' DescribeDataset Text
- data DescribeDatasetResponse = DescribeDatasetResponse' {
- createdAt :: Maybe POSIX
- dataEndTime :: Maybe POSIX
- dataQualitySummary :: Maybe DataQualitySummary
- dataStartTime :: Maybe POSIX
- datasetArn :: Maybe Text
- datasetName :: Maybe Text
- ingestedFilesSummary :: Maybe IngestedFilesSummary
- ingestionInputConfiguration :: Maybe IngestionInputConfiguration
- lastUpdatedAt :: Maybe POSIX
- roleArn :: Maybe Text
- schema :: Maybe Text
- serverSideKmsKeyId :: Maybe Text
- status :: Maybe DatasetStatus
- httpStatus :: Int
- newDescribeDatasetResponse :: Int -> DescribeDatasetResponse
- describeDatasetResponse_createdAt :: Lens' DescribeDatasetResponse (Maybe UTCTime)
- describeDatasetResponse_dataEndTime :: Lens' DescribeDatasetResponse (Maybe UTCTime)
- describeDatasetResponse_dataQualitySummary :: Lens' DescribeDatasetResponse (Maybe DataQualitySummary)
- describeDatasetResponse_dataStartTime :: Lens' DescribeDatasetResponse (Maybe UTCTime)
- describeDatasetResponse_datasetArn :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_datasetName :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_ingestedFilesSummary :: Lens' DescribeDatasetResponse (Maybe IngestedFilesSummary)
- describeDatasetResponse_ingestionInputConfiguration :: Lens' DescribeDatasetResponse (Maybe IngestionInputConfiguration)
- describeDatasetResponse_lastUpdatedAt :: Lens' DescribeDatasetResponse (Maybe UTCTime)
- describeDatasetResponse_roleArn :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_schema :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_serverSideKmsKeyId :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe DatasetStatus)
- describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int
Creating a Request
data DescribeDataset Source #
See: newDescribeDataset
smart constructor.
DescribeDataset' | |
|
Instances
Create a value of DescribeDataset
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDataset
, describeDataset_datasetName
- The name of the dataset to be described.
Request Lenses
describeDataset_datasetName :: Lens' DescribeDataset Text Source #
The name of the dataset to be described.
Destructuring the Response
data DescribeDatasetResponse Source #
See: newDescribeDatasetResponse
smart constructor.
DescribeDatasetResponse' | |
|
Instances
newDescribeDatasetResponse Source #
Create a value of DescribeDatasetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDatasetResponse
, describeDatasetResponse_createdAt
- Specifies the time the dataset was created in Lookout for Equipment.
DescribeDatasetResponse
, describeDatasetResponse_dataEndTime
- Indicates the latest timestamp corresponding to data that was
successfully ingested during the most recent ingestion of this
particular dataset.
$sel:dataQualitySummary:DescribeDatasetResponse'
, describeDatasetResponse_dataQualitySummary
- 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
, describeDatasetResponse_dataStartTime
- Indicates the earliest timestamp corresponding to data that was
successfully ingested during the most recent ingestion of this
particular dataset.
DescribeDatasetResponse
, describeDatasetResponse_datasetArn
- The Amazon Resource Name (ARN) of the dataset being described.
DescribeDataset
, describeDatasetResponse_datasetName
- The name of the dataset being described.
$sel:ingestedFilesSummary:DescribeDatasetResponse'
, describeDatasetResponse_ingestedFilesSummary
- IngestedFilesSummary associated with the given dataset for the latest
successful associated ingestion job id.
DescribeDatasetResponse
, describeDatasetResponse_ingestionInputConfiguration
- Specifies the S3 location configuration for the data input for the data
ingestion job.
$sel:lastUpdatedAt:DescribeDatasetResponse'
, describeDatasetResponse_lastUpdatedAt
- Specifies the time the dataset was last updated, if it was.
$sel:roleArn:DescribeDatasetResponse'
, describeDatasetResponse_roleArn
- The Amazon Resource Name (ARN) of the IAM role that you are using for
this the data ingestion job.
$sel:schema:DescribeDatasetResponse'
, describeDatasetResponse_schema
- A JSON description of the data that is in each time series dataset,
including names, column names, and data types.
$sel:serverSideKmsKeyId:DescribeDatasetResponse'
, describeDatasetResponse_serverSideKmsKeyId
- Provides the identifier of the KMS key used to encrypt dataset data by
Amazon Lookout for Equipment.
DescribeDatasetResponse
, describeDatasetResponse_status
- Indicates the status of the dataset.
$sel:httpStatus:DescribeDatasetResponse'
, describeDatasetResponse_httpStatus
- The response's http status code.
Response Lenses
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_datasetName :: Lens' DescribeDatasetResponse (Maybe Text) Source #
The name 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.
describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe DatasetStatus) Source #
Indicates the status of the dataset.
describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int Source #
The response's http status code.