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

Description

Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call DescribeModel.

After the model hosting stops, the Status of the model is TRAINED.

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

Synopsis

Creating a Request

data StopModel Source #

See: newStopModel smart constructor.

Constructors

StopModel' 

Fields

  • clientToken :: Maybe Text

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

  • projectName :: Text

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

  • modelVersion :: Text

    The version of the model that you want to stop.

Instances

Instances details
Eq StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Read StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Show StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Generic StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Associated Types

type Rep StopModel :: Type -> Type #

NFData StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Methods

rnf :: StopModel -> () #

Hashable StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

ToJSON StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

AWSRequest StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Associated Types

type AWSResponse StopModel #

ToHeaders StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Methods

toHeaders :: StopModel -> [Header] #

ToPath StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

ToQuery StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

type Rep StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

type Rep StopModel = D1 ('MetaData "StopModel" "Amazonka.LookoutVision.StopModel" "libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision" 'False) (C1 ('MetaCons "StopModel'" '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))))
type AWSResponse StopModel Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

newStopModel Source #

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

$sel:projectName:StopModel', stopModel_projectName - The name of the project that contains the model that you want to stop.

$sel:modelVersion:StopModel', stopModel_modelVersion - The version of the model that you want to stop.

Request Lenses

stopModel_clientToken :: Lens' StopModel (Maybe Text) Source #

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

stopModel_projectName :: Lens' StopModel Text Source #

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

stopModel_modelVersion :: Lens' StopModel Text Source #

The version of the model that you want to stop.

Destructuring the Response

data StopModelResponse Source #

See: newStopModelResponse smart constructor.

Constructors

StopModelResponse' 

Fields

Instances

Instances details
Eq StopModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Read StopModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Show StopModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Generic StopModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Associated Types

type Rep StopModelResponse :: Type -> Type #

NFData StopModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

Methods

rnf :: StopModelResponse -> () #

type Rep StopModelResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.StopModel

type Rep StopModelResponse = D1 ('MetaData "StopModelResponse" "Amazonka.LookoutVision.StopModel" "libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision" 'False) (C1 ('MetaCons "StopModelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelHostingStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopModelResponse Source #

Create a value of StopModelResponse 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:status:StopModelResponse', stopModelResponse_status - The status of the model.

$sel:httpStatus:StopModelResponse', stopModelResponse_httpStatus - The response's http status code.

Response Lenses

stopModelResponse_httpStatus :: Lens' StopModelResponse Int Source #

The response's http status code.