amazonka-ml-2.0: Amazon Machine Learning 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.MachineLearning.DeleteEvaluation

Description

Assigns the DELETED status to an Evaluation, rendering it unusable.

After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.

Caution: The results of the DeleteEvaluation operation are irreversible.

Synopsis

Creating a Request

data DeleteEvaluation Source #

See: newDeleteEvaluation smart constructor.

Constructors

DeleteEvaluation' 

Fields

  • evaluationId :: Text

    A user-supplied ID that uniquely identifies the Evaluation to delete.

Instances

Instances details
ToJSON DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

ToHeaders DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

ToPath DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

ToQuery DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

AWSRequest DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

Associated Types

type AWSResponse DeleteEvaluation #

Generic DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

Associated Types

type Rep DeleteEvaluation :: Type -> Type #

Read DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

Show DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

NFData DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

Methods

rnf :: DeleteEvaluation -> () #

Eq DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

Hashable DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

type AWSResponse DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

type Rep DeleteEvaluation Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

type Rep DeleteEvaluation = D1 ('MetaData "DeleteEvaluation" "Amazonka.MachineLearning.DeleteEvaluation" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "DeleteEvaluation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "evaluationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteEvaluation Source #

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

DeleteEvaluation, deleteEvaluation_evaluationId - A user-supplied ID that uniquely identifies the Evaluation to delete.

Request Lenses

deleteEvaluation_evaluationId :: Lens' DeleteEvaluation Text Source #

A user-supplied ID that uniquely identifies the Evaluation to delete.

Destructuring the Response

data DeleteEvaluationResponse Source #

Represents the output of a DeleteEvaluation operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.

You can use the GetEvaluation operation and check the value of the Status parameter to see whether an Evaluation is marked as DELETED.

See: newDeleteEvaluationResponse smart constructor.

Constructors

DeleteEvaluationResponse' 

Fields

  • evaluationId :: Maybe Text

    A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DeleteEvaluationResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

Associated Types

type Rep DeleteEvaluationResponse :: Type -> Type #

Read DeleteEvaluationResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

Show DeleteEvaluationResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

NFData DeleteEvaluationResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

Eq DeleteEvaluationResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

type Rep DeleteEvaluationResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.DeleteEvaluation

type Rep DeleteEvaluationResponse = D1 ('MetaData "DeleteEvaluationResponse" "Amazonka.MachineLearning.DeleteEvaluation" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "DeleteEvaluationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "evaluationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteEvaluationResponse Source #

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

DeleteEvaluation, deleteEvaluationResponse_evaluationId - A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.

$sel:httpStatus:DeleteEvaluationResponse', deleteEvaluationResponse_httpStatus - The response's http status code.

Response Lenses

deleteEvaluationResponse_evaluationId :: Lens' DeleteEvaluationResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.