Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.LookoutEquipment.DescribeDataset

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a JSON description of the data that is 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' {
- ingestionInputConfiguration :: Maybe IngestionInputConfiguration
- status :: Maybe DatasetStatus
- datasetArn :: Maybe Text
- lastUpdatedAt :: Maybe POSIX
- createdAt :: Maybe POSIX
- schema :: Maybe Text
- datasetName :: Maybe Text
- serverSideKmsKeyId :: Maybe Text
- httpStatus :: Int
}
newDescribeDatasetResponse :: Int -> DescribeDatasetResponse
describeDatasetResponse_ingestionInputConfiguration :: Lens' DescribeDatasetResponse (Maybe IngestionInputConfiguration)
describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe DatasetStatus)
describeDatasetResponse_datasetArn :: Lens' DescribeDatasetResponse (Maybe Text)
describeDatasetResponse_lastUpdatedAt :: Lens' DescribeDatasetResponse (Maybe UTCTime)
describeDatasetResponse_createdAt :: Lens' DescribeDatasetResponse (Maybe UTCTime)
describeDatasetResponse_schema :: Lens' DescribeDatasetResponse (Maybe Text)
describeDatasetResponse_datasetName :: Lens' DescribeDatasetResponse (Maybe Text)
describeDatasetResponse_serverSideKmsKeyId :: Lens' DescribeDatasetResponse (Maybe Text)
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

Eq DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods (==) :: DescribeDataset -> DescribeDataset -> Bool # (/=) :: DescribeDataset -> DescribeDataset -> Bool #
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 #
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 #
NFData DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods rnf :: DescribeDataset -> () #
Hashable DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods hashWithSalt :: Int -> DescribeDataset -> Int # hash :: DescribeDataset -> Int #
ToJSON DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods toJSON :: DescribeDataset -> Value # toEncoding :: DescribeDataset -> Encoding # toJSONList :: [DescribeDataset] -> Value # toEncodingList :: [DescribeDataset] -> Encoding #
AWSRequest DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Associated Types type AWSResponse DescribeDataset # Methods request :: DescribeDataset -> Request DescribeDataset # response :: MonadResource m => Logger -> Service -> Proxy DescribeDataset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDataset))) #
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 #
type Rep DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset type Rep DescribeDataset = D1 ('MetaData "DescribeDataset" "Amazonka.LookoutEquipment.DescribeDataset" "libZSservicesZSamazonka-lookoutequipmentZSamazonka-lookoutequipment" 'False) (C1 ('MetaCons "DescribeDataset'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDataset Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset type AWSResponse DescribeDataset = DescribeDatasetResponse

newDescribeDataset Source #

Arguments

:: Text	`$sel:datasetName: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:

$sel:datasetName: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

ingestionInputConfiguration :: Maybe IngestionInputConfiguration
Specifies the S3 location configuration for the data input for the data ingestion job.
status :: Maybe DatasetStatus
Indicates the status of the dataset.
datasetArn :: Maybe Text
The Amazon Resource Name (ARN) of the dataset being described.
lastUpdatedAt :: Maybe POSIX
Specifies the time the dataset was last updated, if it was.
createdAt :: Maybe POSIX
Specifies the time the dataset was created in Amazon Lookout for Equipment.
schema :: Maybe Text
A JSON description of the data that is in each time series dataset, including names, column names, and data types.
datasetName :: Maybe Text
The name of the dataset being described.
serverSideKmsKeyId :: Maybe Text
Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods (==) :: DescribeDatasetResponse -> DescribeDatasetResponse -> Bool # (/=) :: DescribeDatasetResponse -> DescribeDatasetResponse -> Bool #
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 #
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 #
NFData DescribeDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset Methods rnf :: DescribeDatasetResponse -> () #
type Rep DescribeDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataset type Rep DescribeDatasetResponse = D1 ('MetaData "DescribeDatasetResponse" "Amazonka.LookoutEquipment.DescribeDataset" "libZSservicesZSamazonka-lookoutequipmentZSamazonka-lookoutequipment" 'False) (C1 ('MetaCons "DescribeDatasetResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "ingestionInputConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestionInputConfiguration)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetStatus))) :: (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serverSideKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:

$sel:ingestionInputConfiguration:DescribeDatasetResponse', describeDatasetResponse_ingestionInputConfiguration - Specifies the S3 location configuration for the data input for the data ingestion job.

$sel:status:DescribeDatasetResponse', describeDatasetResponse_status - Indicates the status of the dataset.

$sel:datasetArn:DescribeDatasetResponse', describeDatasetResponse_datasetArn - The Amazon Resource Name (ARN) of the dataset being described.

$sel:lastUpdatedAt:DescribeDatasetResponse', describeDatasetResponse_lastUpdatedAt - Specifies the time the dataset was last updated, if it was.

$sel:createdAt:DescribeDatasetResponse', describeDatasetResponse_createdAt - Specifies the time the dataset was created in Amazon Lookout for Equipment.

$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:datasetName:DescribeDataset', describeDatasetResponse_datasetName - The name of the dataset being described.

$sel:serverSideKmsKeyId:DescribeDatasetResponse', describeDatasetResponse_serverSideKmsKeyId - Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

$sel:httpStatus:DescribeDatasetResponse', describeDatasetResponse_httpStatus - The response's http status code.

Response Lenses

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

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

describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe DatasetStatus) Source #

Indicates the status of the dataset.

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

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

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

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

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

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

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_datasetName :: Lens' DescribeDatasetResponse (Maybe Text) Source #

The name of the dataset being described.

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_httpStatus :: Lens' DescribeDatasetResponse Int Source #

The response's http status code.