libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.LookoutVision.DeleteDataset

Description

Deletes an existing Amazon Lookout for Vision dataset.

If your the project has a single dataset, you must create a new dataset before you can create a model.

If you project has a training dataset and a test dataset consider the following.

  • If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.
  • If you delete the training dataset, you must create a training dataset before you can create a model.

This operation requires permissions to perform the lookoutvision:DeleteDataset operation.

Synopsis

Creating a Request

data DeleteDataset Source #

See: newDeleteDataset smart constructor.

Constructors

DeleteDataset' 

Fields

  • clientToken :: Maybe Text

    ClientToken is an idempotency token that ensures a call to DeleteDataset 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 DeleteDataset. In this case, safely retry your call to DeleteDataset 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 DeleteDataset. An idempotency token is active for 8 hours.

  • projectName :: Text

    The name of the project that contains the dataset that you want to delete.

  • datasetType :: Text

    The type of the dataset to delete. Specify train to delete the training dataset. Specify test to delete the test dataset. To delete the dataset in a single dataset project, specify train.

Instances

Instances details
Eq DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Read DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Show DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Generic DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Associated Types

type Rep DeleteDataset :: Type -> Type #

NFData DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Methods

rnf :: DeleteDataset -> () #

Hashable DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

AWSRequest DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Associated Types

type AWSResponse DeleteDataset #

ToHeaders DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

ToPath DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

ToQuery DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

type Rep DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

type Rep DeleteDataset = D1 ('MetaData "DeleteDataset" "Amazonka.LookoutVision.DeleteDataset" "libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision" 'False) (C1 ('MetaCons "DeleteDataset'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "datasetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteDataset Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

newDeleteDataset Source #

Create a value of DeleteDataset 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:DeleteDataset', deleteDataset_clientToken - ClientToken is an idempotency token that ensures a call to DeleteDataset 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 DeleteDataset. In this case, safely retry your call to DeleteDataset 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 DeleteDataset. An idempotency token is active for 8 hours.

$sel:projectName:DeleteDataset', deleteDataset_projectName - The name of the project that contains the dataset that you want to delete.

$sel:datasetType:DeleteDataset', deleteDataset_datasetType - The type of the dataset to delete. Specify train to delete the training dataset. Specify test to delete the test dataset. To delete the dataset in a single dataset project, specify train.

Request Lenses

deleteDataset_clientToken :: Lens' DeleteDataset (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to DeleteDataset 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 DeleteDataset. In this case, safely retry your call to DeleteDataset 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 DeleteDataset. An idempotency token is active for 8 hours.

deleteDataset_projectName :: Lens' DeleteDataset Text Source #

The name of the project that contains the dataset that you want to delete.

deleteDataset_datasetType :: Lens' DeleteDataset Text Source #

The type of the dataset to delete. Specify train to delete the training dataset. Specify test to delete the test dataset. To delete the dataset in a single dataset project, specify train.

Destructuring the Response

data DeleteDatasetResponse Source #

See: newDeleteDatasetResponse smart constructor.

Constructors

DeleteDatasetResponse' 

Fields

Instances

Instances details
Eq DeleteDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Read DeleteDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Show DeleteDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Generic DeleteDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Associated Types

type Rep DeleteDatasetResponse :: Type -> Type #

NFData DeleteDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

Methods

rnf :: DeleteDatasetResponse -> () #

type Rep DeleteDatasetResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteDataset

type Rep DeleteDatasetResponse = D1 ('MetaData "DeleteDatasetResponse" "Amazonka.LookoutVision.DeleteDataset" "libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision" 'False) (C1 ('MetaCons "DeleteDatasetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteDatasetResponse Source #

Create a value of DeleteDatasetResponse 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:httpStatus:DeleteDatasetResponse', deleteDatasetResponse_httpStatus - The response's http status code.

Response Lenses