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.CreateDataset

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a container for a collection of data being ingested for analysis. The dataset contains the metadata describing where the data is and what the data actually looks like. In other words, it contains the location of the data source, the data schema, and other information. A dataset also contains any tags associated with the ingested data.

Synopsis

data CreateDataset = CreateDataset' {
- tags :: Maybe [Tag]
- serverSideKmsKeyId :: Maybe Text
- datasetName :: Text
- datasetSchema :: DatasetSchema
- clientToken :: Text
}
newCreateDataset :: Text -> DatasetSchema -> Text -> CreateDataset
createDataset_tags :: Lens' CreateDataset (Maybe [Tag])
createDataset_serverSideKmsKeyId :: Lens' CreateDataset (Maybe Text)
createDataset_datasetName :: Lens' CreateDataset Text
createDataset_datasetSchema :: Lens' CreateDataset DatasetSchema
createDataset_clientToken :: Lens' CreateDataset Text
data CreateDatasetResponse = CreateDatasetResponse' {
- status :: Maybe DatasetStatus
- datasetArn :: Maybe Text
- datasetName :: Maybe Text
- httpStatus :: Int
}
newCreateDatasetResponse :: Int -> CreateDatasetResponse
createDatasetResponse_status :: Lens' CreateDatasetResponse (Maybe DatasetStatus)
createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text)
createDatasetResponse_datasetName :: Lens' CreateDatasetResponse (Maybe Text)
createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int

Creating a Request

data CreateDataset Source #

See: newCreateDataset smart constructor.

Constructors

CreateDataset'

Fields

tags :: Maybe [Tag]
Any tags associated with the ingested data described in the dataset.
serverSideKmsKeyId :: Maybe Text
Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.
datasetName :: Text
The name of the dataset being created.
datasetSchema :: DatasetSchema
A JSON description of the data that is in each time series dataset, including names, column names, and data types.
clientToken :: Text
A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Instances

Instances details

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

newCreateDataset Source #

Arguments

:: Text	`$sel:datasetName:CreateDataset'`
-> DatasetSchema	`$sel:datasetSchema:CreateDataset'`
-> Text	`$sel:clientToken:CreateDataset'`
-> CreateDataset

Create a value of CreateDataset 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:tags:CreateDataset', createDataset_tags - Any tags associated with the ingested data described in the dataset.

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

$sel:datasetName:CreateDataset', createDataset_datasetName - The name of the dataset being created.

$sel:datasetSchema:CreateDataset', createDataset_datasetSchema - A JSON description of the data that is in each time series dataset, including names, column names, and data types.

$sel:clientToken:CreateDataset', createDataset_clientToken - A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Request Lenses

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

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

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_datasetName :: Lens' CreateDataset Text Source #

The name of the dataset being created.

createDataset_datasetSchema :: Lens' CreateDataset DatasetSchema Source #

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

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.

Destructuring the Response

data CreateDatasetResponse Source #

See: newCreateDatasetResponse smart constructor.

Constructors

CreateDatasetResponse'
Fields status :: Maybe DatasetStatus Indicates the status of the `CreateDataset` operation. datasetArn :: Maybe Text The Amazon Resource Name (ARN) of the dataset being created. datasetName :: Maybe Text The name of the dataset being created. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateDataset Methods (==) :: CreateDatasetResponse -> CreateDatasetResponse -> Bool # (/=) :: CreateDatasetResponse -> CreateDatasetResponse -> Bool #
Read CreateDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateDataset Methods readsPrec :: Int -> ReadS CreateDatasetResponse # readList :: ReadS [CreateDatasetResponse] # readPrec :: ReadPrec CreateDatasetResponse # readListPrec :: ReadPrec [CreateDatasetResponse] #
Show CreateDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateDataset Methods showsPrec :: Int -> CreateDatasetResponse -> ShowS # show :: CreateDatasetResponse -> String # showList :: [CreateDatasetResponse] -> ShowS #
Generic CreateDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateDataset Associated Types type Rep CreateDatasetResponse :: Type -> Type # Methods from :: CreateDatasetResponse -> Rep CreateDatasetResponse x # to :: Rep CreateDatasetResponse x -> CreateDatasetResponse #
NFData CreateDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateDataset Methods rnf :: CreateDatasetResponse -> () #
type Rep CreateDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateDataset type Rep CreateDatasetResponse = D1 ('MetaData "CreateDatasetResponse" "Amazonka.LookoutEquipment.CreateDataset" "libZSservicesZSamazonka-lookoutequipmentZSamazonka-lookoutequipment" 'False) (C1 ('MetaCons "CreateDatasetResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetStatus)) :: S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateDatasetResponse Source #

Arguments

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

Create a value of CreateDatasetResponse 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:status:CreateDatasetResponse', createDatasetResponse_status - Indicates the status of the CreateDataset operation.

$sel:datasetArn:CreateDatasetResponse', createDatasetResponse_datasetArn - The Amazon Resource Name (ARN) of the dataset being created.

$sel:datasetName:CreateDataset', createDatasetResponse_datasetName - The name of the dataset being created.

$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.

Response Lenses

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

Indicates the status of the CreateDataset operation.

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

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

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

The name of the dataset being created.

createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #

The response's http status code.