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

Description

Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the StopModel operation.

It might take a few seconds to delete a model. To determine if a model has been deleted, call ListModels and check if the version of the model (ModelVersion) is in the Models array.

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

Synopsis

Creating a Request

data DeleteModel Source #

See: newDeleteModel smart constructor.

Constructors

DeleteModel' 

Fields

  • clientToken :: Maybe Text

    ClientToken is an idempotency token that ensures a call to DeleteModel completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from DeleteModel. In this case, safely retry your call to DeleteModel 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 model deletion 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 DeleteModel. An idempotency token is active for 8 hours.

  • projectName :: Text

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

  • modelVersion :: Text

    The version of the model that you want to delete.

Instances

Instances details
ToHeaders DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

Methods

toHeaders :: DeleteModel -> [Header] #

ToPath DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

ToQuery DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

AWSRequest DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

Associated Types

type AWSResponse DeleteModel #

Generic DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

Associated Types

type Rep DeleteModel :: Type -> Type #

Read DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

Show DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

NFData DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

Methods

rnf :: DeleteModel -> () #

Eq DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

Hashable DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

type AWSResponse DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

type Rep DeleteModel Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

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

newDeleteModel Source #

Create a value of DeleteModel 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:DeleteModel', deleteModel_clientToken - ClientToken is an idempotency token that ensures a call to DeleteModel completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from DeleteModel. In this case, safely retry your call to DeleteModel 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 model deletion 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 DeleteModel. An idempotency token is active for 8 hours.

DeleteModel, deleteModel_projectName - The name of the project that contains the model that you want to delete.

DeleteModel, deleteModel_modelVersion - The version of the model that you want to delete.

Request Lenses

deleteModel_clientToken :: Lens' DeleteModel (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to DeleteModel completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from DeleteModel. In this case, safely retry your call to DeleteModel 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 model deletion 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 DeleteModel. An idempotency token is active for 8 hours.

deleteModel_projectName :: Lens' DeleteModel Text Source #

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

deleteModel_modelVersion :: Lens' DeleteModel Text Source #

The version of the model that you want to delete.

Destructuring the Response

data DeleteModelResponse Source #

See: newDeleteModelResponse smart constructor.

Constructors

DeleteModelResponse' 

Fields

Instances

Instances details
Generic DeleteModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

Associated Types

type Rep DeleteModelResponse :: Type -> Type #

Read DeleteModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

Show DeleteModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

NFData DeleteModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

Methods

rnf :: DeleteModelResponse -> () #

Eq DeleteModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

type Rep DeleteModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DeleteModel

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

newDeleteModelResponse Source #

Create a value of DeleteModelResponse 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:

DeleteModelResponse, deleteModelResponse_modelArn - The Amazon Resource Name (ARN) of the model that was deleted.

$sel:httpStatus:DeleteModelResponse', deleteModelResponse_httpStatus - The response's http status code.

Response Lenses

deleteModelResponse_modelArn :: Lens' DeleteModelResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model that was deleted.