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

Amazonka.LookoutEquipment.DescribeDataset

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Constructors

DescribeDataset'
Fields datasetName :: Text The name of the dataset to be described.

Instances

Instances details

ToJSON DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods toJSON :: DescribeDataset -> Value # toEncoding :: DescribeDataset -> Encoding # toJSONList :: [DescribeDataset] -> Value # toEncodingList :: [DescribeDataset] -> Encoding #
ToHeaders DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods toHeaders :: DescribeDataset -> [Header] #
ToPath DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods toPath :: DescribeDataset -> ByteString #
ToQuery DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods toQuery :: DescribeDataset -> QueryString #
AWSRequest DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Associated Types type AWSResponse DescribeDataset # Methods request :: (Service -> Service) -> DescribeDataset -> Request DescribeDataset # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDataset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDataset))) #
Generic DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Associated Types type Rep DescribeDataset :: Type -> Type # Methods from :: DescribeDataset -> Rep DescribeDataset x # to :: Rep DescribeDataset x -> DescribeDataset #
Read DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods readsPrec :: Int -> ReadS DescribeDataset # readList :: ReadS [DescribeDataset] # readPrec :: ReadPrec DescribeDataset # readListPrec :: ReadPrec [DescribeDataset] #
Show DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods showsPrec :: Int -> DescribeDataset -> ShowS # show :: DescribeDataset -> String # showList :: [DescribeDataset] -> ShowS #
NFData DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods rnf :: DescribeDataset -> () #
Eq DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods (==) :: DescribeDataset -> DescribeDataset -> Bool # (/=) :: DescribeDataset -> DescribeDataset -> Bool #
Hashable DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods hashWithSalt :: Int -> DescribeDataset -> Int # hash :: DescribeDataset -> Int #
type AWSResponse DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset type AWSResponse DescribeDataset = DescribeDatasetResponse
type Rep DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset type Rep DescribeDataset = D1 ('MetaData "DescribeDataset" "Amazonka.LookoutEquipment.DescribeDataset" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "DescribeDataset'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDataset Source #

Arguments

:: Text	`DescribeDataset`
-> DescribeDataset

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.

Constructors

DescribeDatasetResponse'

Fields

createdAt :: Maybe POSIX
Specifies the time the dataset was created in Lookout for Equipment.
dataEndTime :: Maybe POSIX
Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.
dataQualitySummary :: Maybe 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.
dataStartTime :: Maybe POSIX
Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.
datasetArn :: Maybe Text
The Amazon Resource Name (ARN) of the dataset being described.
datasetName :: Maybe Text
The name of the dataset being described.
ingestedFilesSummary :: Maybe IngestedFilesSummary
IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.
ingestionInputConfiguration :: Maybe IngestionInputConfiguration
Specifies the S3 location configuration for the data input for the data ingestion job.
lastUpdatedAt :: Maybe POSIX
Specifies the time the dataset was last updated, if it was.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.
schema :: Maybe Text
A JSON description of the data that is in each time series dataset, including names, column names, and data types.
serverSideKmsKeyId :: Maybe Text
Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.
status :: Maybe DatasetStatus
Indicates the status of the dataset.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Associated Types type Rep DescribeDatasetResponse :: Type -> Type # Methods from :: DescribeDatasetResponse -> Rep DescribeDatasetResponse x # to :: Rep DescribeDatasetResponse x -> DescribeDatasetResponse #
Read DescribeDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods readsPrec :: Int -> ReadS DescribeDatasetResponse # readList :: ReadS [DescribeDatasetResponse] # readPrec :: ReadPrec DescribeDatasetResponse # readListPrec :: ReadPrec [DescribeDatasetResponse] #
Show DescribeDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods showsPrec :: Int -> DescribeDatasetResponse -> ShowS # show :: DescribeDatasetResponse -> String # showList :: [DescribeDatasetResponse] -> ShowS #
NFData DescribeDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods rnf :: DescribeDatasetResponse -> () #
Eq DescribeDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods (==) :: DescribeDatasetResponse -> DescribeDatasetResponse -> Bool # (/=) :: DescribeDatasetResponse -> DescribeDatasetResponse -> Bool #
type Rep DescribeDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset type Rep DescribeDatasetResponse = D1 ('MetaData "DescribeDatasetResponse" "Amazonka.LookoutEquipment.DescribeDataset" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "DescribeDatasetResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "dataEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "dataQualitySummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataQualitySummary)))) :: ((S1 ('MetaSel ('Just "dataStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ingestedFilesSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestedFilesSummary))))) :: ((S1 ('MetaSel ('Just "ingestionInputConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestionInputConfiguration)) :: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serverSideKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeDatasetResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDatasetResponse'`
-> DescribeDatasetResponse

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.