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

Creating a Request

data CreateDataset Source #

See: newCreateDataset smart constructor.

Constructors

CreateDataset'

Fields

datasetSchema :: Maybe DatasetSchema
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.
tags :: Maybe [Tag]
Any tags associated with the ingested data described in the dataset.
datasetName :: Text
The name of the dataset being created.
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

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

newCreateDataset Source #

Arguments

:: Text	`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: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:serverSideKmsKeyId:CreateDataset', createDataset_serverSideKmsKeyId - Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

$sel:tags:CreateDataset', createDataset_tags - Any tags associated with the ingested data described in the dataset.

CreateDataset, createDataset_datasetName - The name of the dataset being created.

$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_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.

Destructuring the Response

data CreateDatasetResponse Source #

See: newCreateDatasetResponse smart constructor.

Constructors

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

Instances

Instances details

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 #
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 #
NFData CreateDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateDataset Methods rnf :: CreateDatasetResponse -> () #
Eq CreateDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateDataset Methods (==) :: CreateDatasetResponse -> CreateDatasetResponse -> Bool # (/=) :: CreateDatasetResponse -> CreateDatasetResponse -> Bool #
type Rep CreateDatasetResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateDataset type Rep CreateDatasetResponse = D1 ('MetaData "CreateDatasetResponse" "Amazonka.LookoutEquipment.CreateDataset" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "CreateDatasetResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "datasetName") '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))))

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:

CreateDatasetResponse, createDatasetResponse_datasetArn - The Amazon Resource Name (ARN) of the dataset being created.

CreateDataset, createDatasetResponse_datasetName - The name of the dataset being created.

CreateDatasetResponse, createDatasetResponse_status - Indicates the status of the CreateDataset operation.

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

Response Lenses

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_status :: Lens' CreateDatasetResponse (Maybe DatasetStatus) Source #

Indicates the status of the CreateDataset operation.

createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #

The response's http status code.