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 |
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
- data CreateDataset = CreateDataset' {}
- newCreateDataset :: Text -> Text -> Text -> Text -> CreateDataset
- createDataset_tags :: Lens' CreateDataset (Maybe [Tag])
- createDataset_name :: Lens' CreateDataset Text
- createDataset_schemaArn :: Lens' CreateDataset Text
- createDataset_datasetGroupArn :: Lens' CreateDataset Text
- createDataset_datasetType :: Lens' CreateDataset Text
- data CreateDatasetResponse = CreateDatasetResponse' {
- datasetArn :: Maybe Text
- httpStatus :: Int
- newCreateDatasetResponse :: Int -> CreateDatasetResponse
- createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text)
- createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int
Creating a Request
data CreateDataset Source #
See: newCreateDataset
smart constructor.
CreateDataset' | |
|
Instances
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.
CreateDatasetResponse' | |
|
Instances
newCreateDatasetResponse Source #
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.