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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are three types of datasets:

Interactions
Items
Users

Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

Synopsis

Creating a Request

data CreateDataset Source #

See: newCreateDataset smart constructor.

Constructors

CreateDataset'

Fields

tags :: Maybe [Tag]
A list of tags to apply to the dataset.
name :: Text
The name for the dataset.
schemaArn :: Text
The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
datasetGroupArn :: Text
The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
datasetType :: Text
The type of dataset.
One of the following (case insensitive) values:
- Interactions
- Items
- Users

Instances

Instances details

ToJSON CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods toJSON :: CreateDataset -> Value # toEncoding :: CreateDataset -> Encoding # toJSONList :: [CreateDataset] -> Value # toEncodingList :: [CreateDataset] -> Encoding #
ToHeaders CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods toHeaders :: CreateDataset -> [Header] #
ToPath CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods toPath :: CreateDataset -> ByteString #
ToQuery CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods toQuery :: CreateDataset -> QueryString #
AWSRequest CreateDataset Source #
Instance details Defined in Amazonka.Personalize.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.Personalize.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.Personalize.CreateDataset Methods readsPrec :: Int -> ReadS CreateDataset # readList :: ReadS [CreateDataset] # readPrec :: ReadPrec CreateDataset # readListPrec :: ReadPrec [CreateDataset] #
Show CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods showsPrec :: Int -> CreateDataset -> ShowS # show :: CreateDataset -> String # showList :: [CreateDataset] -> ShowS #
NFData CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods rnf :: CreateDataset -> () #
Eq CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods (==) :: CreateDataset -> CreateDataset -> Bool # (/=) :: CreateDataset -> CreateDataset -> Bool #
Hashable CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods hashWithSalt :: Int -> CreateDataset -> Int # hash :: CreateDataset -> Int #
type AWSResponse CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset type AWSResponse CreateDataset = CreateDatasetResponse
type Rep CreateDataset Source #
Instance details Defined in Amazonka.Personalize.CreateDataset type Rep CreateDataset = D1 ('MetaData "CreateDataset" "Amazonka.Personalize.CreateDataset" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateDataset'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "schemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "datasetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateDataset Source #

Arguments

:: Text	`CreateDataset`
-> Text	`CreateDataset`
-> Text	`CreateDataset`
-> Text	`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 - A list of tags to apply to the dataset.

CreateDataset, createDataset_name - The name for the dataset.

CreateDataset, createDataset_schemaArn - The ARN of the schema to associate with the dataset. The schema defines the dataset fields.

CreateDataset, createDataset_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

CreateDataset, createDataset_datasetType - The type of dataset.

One of the following (case insensitive) values:

Interactions
Items
Users

Request Lenses

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

A list of tags to apply to the dataset.

createDataset_name :: Lens' CreateDataset Text Source #

The name for the dataset.

createDataset_schemaArn :: Lens' CreateDataset Text Source #

The ARN of the schema to associate with the dataset. The schema defines the dataset fields.

createDataset_datasetGroupArn :: Lens' CreateDataset Text Source #

The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

createDataset_datasetType :: Lens' CreateDataset Text Source #

The type of dataset.

One of the following (case insensitive) values:

Interactions
Items
Users

Destructuring the Response

data CreateDatasetResponse Source #

See: newCreateDatasetResponse smart constructor.

Constructors

CreateDatasetResponse'
Fields datasetArn :: Maybe Text The ARN of the dataset. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDatasetResponse Source #
Instance details Defined in Amazonka.Personalize.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.Personalize.CreateDataset Methods readsPrec :: Int -> ReadS CreateDatasetResponse # readList :: ReadS [CreateDatasetResponse] # readPrec :: ReadPrec CreateDatasetResponse # readListPrec :: ReadPrec [CreateDatasetResponse] #
Show CreateDatasetResponse Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods showsPrec :: Int -> CreateDatasetResponse -> ShowS # show :: CreateDatasetResponse -> String # showList :: [CreateDatasetResponse] -> ShowS #
NFData CreateDatasetResponse Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods rnf :: CreateDatasetResponse -> () #
Eq CreateDatasetResponse Source #
Instance details Defined in Amazonka.Personalize.CreateDataset Methods (==) :: CreateDatasetResponse -> CreateDatasetResponse -> Bool # (/=) :: CreateDatasetResponse -> CreateDatasetResponse -> Bool #
type Rep CreateDatasetResponse Source #
Instance details Defined in Amazonka.Personalize.CreateDataset type Rep CreateDatasetResponse = D1 ('MetaData "CreateDatasetResponse" "Amazonka.Personalize.CreateDataset" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateDatasetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetArn") '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:

CreateDatasetResponse, createDatasetResponse_datasetArn - The ARN of the dataset.

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

Response Lenses

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

The ARN of the dataset.

createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #

The response's http status code.