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 a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.
To create a training dataset for a project, specify train
for the
value of DatasetType
. To create the test dataset for a project,
specify test
for the value of DatasetType
.
The response from CreateDataset
is the Amazon Resource Name (ARN) for
the dataset. Creating a dataset takes a while to complete. Use
DescribeDataset to check the current status. The dataset created
successfully if the value of Status
is CREATE_COMPLETE
.
To check if any non-terminal errors occurred, call ListDatasetEntries
and check for the presence of errors
lists in the JSON Lines.
Dataset creation fails if a terminal error occurs (Status
=
CREATE_FAILED
). Currently, you can't access the terminal error
information.
For more information, see Creating dataset in the /Amazon Rekognition Custom Labels Developer Guide/.
This operation requires permissions to perform the
rekognition:CreateDataset
action. If you want to copy an existing
dataset, you also require permission to perform the
rekognition:ListDatasetEntries
action.
Synopsis
- data CreateDataset = CreateDataset' {}
- newCreateDataset :: DatasetType -> Text -> CreateDataset
- createDataset_datasetSource :: Lens' CreateDataset (Maybe DatasetSource)
- createDataset_datasetType :: Lens' CreateDataset DatasetType
- createDataset_projectArn :: 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:datasetSource:CreateDataset'
, createDataset_datasetSource
- The source files for the dataset. You can specify the ARN of an existing
dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker
format manifest file. If you don't specify datasetSource
, an empty
dataset is created. To add labeled images to the dataset, You can use
the console or call UpdateDatasetEntries.
CreateDataset
, createDataset_datasetType
- The type of the dataset. Specify train
to create a training dataset.
Specify test
to create a test dataset.
CreateDataset
, createDataset_projectArn
- The ARN of the Amazon Rekognition Custom Labels project to which you
want to asssign the dataset.
Request Lenses
createDataset_datasetSource :: Lens' CreateDataset (Maybe DatasetSource) Source #
The source files for the dataset. You can specify the ARN of an existing
dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker
format manifest file. If you don't specify datasetSource
, an empty
dataset is created. To add labeled images to the dataset, You can use
the console or call UpdateDatasetEntries.
createDataset_datasetType :: Lens' CreateDataset DatasetType Source #
The type of the dataset. Specify train
to create a training dataset.
Specify test
to create a test dataset.
createDataset_projectArn :: Lens' CreateDataset Text Source #
The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.
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 created Amazon Rekognition Custom Labels 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 created Amazon Rekognition Custom Labels dataset.
createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #
The response's http status code.