amazonka-lookoutvision-2.0: Amazon Lookout for Vision SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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

Creating a Request

data CreateDataset Source #

See: newCreateDataset smart constructor.

Constructors

CreateDataset' 

Fields

  • clientToken :: Maybe Text

    ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You choose the value to pass. For example, An issue 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.

    If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

    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.

  • datasetSource :: Maybe 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.

  • projectName :: Text

    The name of the project in which you want to create a dataset.

  • datasetType :: Text

    The type of the dataset. Specify train for a training dataset. Specify test for a test dataset.

Instances

Instances details
ToJSON CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

ToHeaders CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

ToPath CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

ToQuery CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

AWSRequest CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

Associated Types

type AWSResponse CreateDataset #

Generic CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

Associated Types

type Rep CreateDataset :: Type -> Type #

Read CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

Show CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

NFData CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

Methods

rnf :: CreateDataset -> () #

Eq CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

Hashable CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

type AWSResponse CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

type Rep CreateDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

type Rep CreateDataset = D1 ('MetaData "CreateDataset" "Amazonka.LookoutVision.CreateDataset" "amazonka-lookoutvision-2.0-3cIJAF9xWxx8xGDY24BOkS" 'False) (C1 ('MetaCons "CreateDataset'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "datasetSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetSource))) :*: (S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "datasetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDataset Source #

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

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

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.

CreateDataset, createDataset_projectName - The name of the project in which you want to create a dataset.

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

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

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

Instances details
Generic CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

Associated Types

type Rep CreateDatasetResponse :: Type -> Type #

Read CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

Show CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

NFData CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

Methods

rnf :: CreateDatasetResponse -> () #

Eq CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

type Rep CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.CreateDataset

type Rep CreateDatasetResponse = D1 ('MetaData "CreateDatasetResponse" "Amazonka.LookoutVision.CreateDataset" "amazonka-lookoutvision-2.0-3cIJAF9xWxx8xGDY24BOkS" 'False) (C1 ('MetaCons "CreateDatasetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetMetadata)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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