| 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.LookoutVision.CreateDataset
Description
Creates a new dataset in an Amazon Lookout for Vision project.
CreateDataset can create a training or a test dataset from a valid
dataset source (DatasetSource).
If you want a single dataset project, specify train for the value of
DatasetType.
To have a project with separate training and test datasets, call
CreateDataset twice. On the first call, specify train for the value
of DatasetType. On the second call, specify test for the value of
DatasetType.
This operation requires permissions to perform the
lookoutvision:CreateDataset operation.
Synopsis
- data CreateDataset = CreateDataset' {}
- newCreateDataset :: Text -> Text -> CreateDataset
- createDataset_clientToken :: Lens' CreateDataset (Maybe Text)
- createDataset_datasetSource :: Lens' CreateDataset (Maybe DatasetSource)
- createDataset_projectName :: Lens' CreateDataset Text
- createDataset_datasetType :: Lens' CreateDataset Text
- data CreateDatasetResponse = CreateDatasetResponse' {}
- newCreateDatasetResponse :: Int -> CreateDatasetResponse
- createDatasetResponse_datasetMetadata :: Lens' CreateDatasetResponse (Maybe DatasetMetadata)
- createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int
Creating a Request
data CreateDataset Source #
See: newCreateDataset smart constructor.
Constructors
| CreateDataset' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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:clientToken:CreateDataset', createDataset_clientToken - ClientToken is an idempotency token that ensures a call to
CreateDataset completes only once. You choose the value to pass. For
example, An issue, such as an network outage, might prevent you from
getting a response from CreateDataset. In this case, safely retry your
call to CreateDataset by using the same ClientToken parameter value.
An error occurs if the other input parameters are not the same as in the
first request. Using a different value for ClientToken is considered a
new call to CreateDataset. An idempotency token is active for 8 hours.
$sel:datasetSource:CreateDataset', createDataset_datasetSource - The location of the manifest file that Amazon Lookout for Vision uses to
create the dataset.
If you don't specify DatasetSource, an empty dataset is created and
the operation synchronously returns. Later, you can add JSON Lines by
calling UpdateDatasetEntries.
If you specify a value for DataSource, the manifest at the S3 location
is validated and used to create the dataset. The call to CreateDataset
is asynchronous and might take a while to complete. To find out the
current status, Check the value of Status returned in a call to
DescribeDataset.
$sel:projectName:CreateDataset', createDataset_projectName - The name of the project in which you want to create a dataset.
$sel:datasetType:CreateDataset', createDataset_datasetType - The type of the dataset. Specify train for a training dataset. Specify
test for a test dataset.
Request Lenses
createDataset_clientToken :: Lens' CreateDataset (Maybe Text) Source #
ClientToken is an idempotency token that ensures a call to
CreateDataset completes only once. You choose the value to pass. For
example, An issue, such as an network outage, might prevent you from
getting a response from CreateDataset. In this case, safely retry your
call to CreateDataset by using the same ClientToken parameter value.
An error occurs if the other input parameters are not the same as in the
first request. Using a different value for ClientToken is considered a
new call to CreateDataset. An idempotency token is active for 8 hours.
createDataset_datasetSource :: Lens' CreateDataset (Maybe DatasetSource) Source #
The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
If you don't specify DatasetSource, an empty dataset is created and
the operation synchronously returns. Later, you can add JSON Lines by
calling UpdateDatasetEntries.
If you specify a value for DataSource, the manifest at the S3 location
is validated and used to create the dataset. The call to CreateDataset
is asynchronous and might take a while to complete. To find out the
current status, Check the value of Status returned in a call to
DescribeDataset.
createDataset_projectName :: Lens' CreateDataset Text Source #
The name of the project in which you want to create a dataset.
createDataset_datasetType :: Lens' CreateDataset Text Source #
The type of the dataset. Specify train for a training dataset. Specify
test for a test dataset.
Destructuring the Response
data CreateDatasetResponse Source #
See: newCreateDatasetResponse smart constructor.
Constructors
| CreateDatasetResponse' | |
Fields
| |
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:
$sel:datasetMetadata:CreateDatasetResponse', createDatasetResponse_datasetMetadata - Information about the dataset.
$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.
Response Lenses
createDatasetResponse_datasetMetadata :: Lens' CreateDatasetResponse (Maybe DatasetMetadata) Source #
Information about the dataset.
createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #
The response's http status code.