Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.StopInferenceExperiment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops an inference experiment.

Synopsis

Creating a Request

data StopInferenceExperiment Source #

See: newStopInferenceExperiment smart constructor.

Constructors

StopInferenceExperiment'

Fields

desiredModelVariants :: Maybe (NonEmpty ModelVariantConfig)
An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.
desiredState :: Maybe InferenceExperimentStopDesiredState
The desired state of the experiment after stopping. The possible states are the following:
- Completed: The experiment completed successfully
- Cancelled: The experiment was canceled
reason :: Maybe Text
The reason for stopping the experiment.
name :: Text
The name of the inference experiment to stop.
modelVariantActions :: HashMap Text ModelVariantAction
Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:
- Promote - Promote the shadow variant to a production variant
- Remove - Delete the variant
- Retain - Keep the variant as it is

Instances

Instances details

ToJSON StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods toJSON :: StopInferenceExperiment -> Value # toEncoding :: StopInferenceExperiment -> Encoding # toJSONList :: [StopInferenceExperiment] -> Value # toEncodingList :: [StopInferenceExperiment] -> Encoding #
ToHeaders StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods toHeaders :: StopInferenceExperiment -> [Header] #
ToPath StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods toPath :: StopInferenceExperiment -> ByteString #
ToQuery StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods toQuery :: StopInferenceExperiment -> QueryString #
AWSRequest StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Associated Types type AWSResponse StopInferenceExperiment # Methods request :: (Service -> Service) -> StopInferenceExperiment -> Request StopInferenceExperiment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopInferenceExperiment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopInferenceExperiment))) #
Generic StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Associated Types type Rep StopInferenceExperiment :: Type -> Type # Methods from :: StopInferenceExperiment -> Rep StopInferenceExperiment x # to :: Rep StopInferenceExperiment x -> StopInferenceExperiment #
Read StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods readsPrec :: Int -> ReadS StopInferenceExperiment # readList :: ReadS [StopInferenceExperiment] # readPrec :: ReadPrec StopInferenceExperiment # readListPrec :: ReadPrec [StopInferenceExperiment] #
Show StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods showsPrec :: Int -> StopInferenceExperiment -> ShowS # show :: StopInferenceExperiment -> String # showList :: [StopInferenceExperiment] -> ShowS #
NFData StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods rnf :: StopInferenceExperiment -> () #
Eq StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods (==) :: StopInferenceExperiment -> StopInferenceExperiment -> Bool # (/=) :: StopInferenceExperiment -> StopInferenceExperiment -> Bool #
Hashable StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods hashWithSalt :: Int -> StopInferenceExperiment -> Int # hash :: StopInferenceExperiment -> Int #
type AWSResponse StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment type AWSResponse StopInferenceExperiment = StopInferenceExperimentResponse
type Rep StopInferenceExperiment Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment type Rep StopInferenceExperiment = D1 ('MetaData "StopInferenceExperiment" "Amazonka.SageMaker.StopInferenceExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "StopInferenceExperiment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "desiredModelVariants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ModelVariantConfig))) :: S1 ('MetaSel ('Just "desiredState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceExperimentStopDesiredState))) :: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "modelVariantActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text ModelVariantAction))))))

newStopInferenceExperiment Source #

Arguments

:: Text	`StopInferenceExperiment`
-> StopInferenceExperiment

Create a value of StopInferenceExperiment 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:desiredModelVariants:StopInferenceExperiment', stopInferenceExperiment_desiredModelVariants - An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

$sel:desiredState:StopInferenceExperiment', stopInferenceExperiment_desiredState - The desired state of the experiment after stopping. The possible states are the following:

Completed: The experiment completed successfully
Cancelled: The experiment was canceled

$sel:reason:StopInferenceExperiment', stopInferenceExperiment_reason - The reason for stopping the experiment.

StopInferenceExperiment, stopInferenceExperiment_name - The name of the inference experiment to stop.

$sel:modelVariantActions:StopInferenceExperiment', stopInferenceExperiment_modelVariantActions - Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

Promote - Promote the shadow variant to a production variant
Remove - Delete the variant
Retain - Keep the variant as it is

Request Lenses

stopInferenceExperiment_desiredModelVariants :: Lens' StopInferenceExperiment (Maybe (NonEmpty ModelVariantConfig)) Source #

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

stopInferenceExperiment_desiredState :: Lens' StopInferenceExperiment (Maybe InferenceExperimentStopDesiredState) Source #

The desired state of the experiment after stopping. The possible states are the following:

Completed: The experiment completed successfully
Cancelled: The experiment was canceled

stopInferenceExperiment_reason :: Lens' StopInferenceExperiment (Maybe Text) Source #

The reason for stopping the experiment.

stopInferenceExperiment_name :: Lens' StopInferenceExperiment Text Source #

The name of the inference experiment to stop.

stopInferenceExperiment_modelVariantActions :: Lens' StopInferenceExperiment (HashMap Text ModelVariantAction) Source #

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

Promote - Promote the shadow variant to a production variant
Remove - Delete the variant
Retain - Keep the variant as it is

Destructuring the Response

data StopInferenceExperimentResponse Source #

See: newStopInferenceExperimentResponse smart constructor.

Constructors

StopInferenceExperimentResponse'
Fields httpStatus :: Int The response's http status code. inferenceExperimentArn :: Text The ARN of the stopped inference experiment.

Instances

Instances details

Generic StopInferenceExperimentResponse Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Associated Types type Rep StopInferenceExperimentResponse :: Type -> Type # Methods from :: StopInferenceExperimentResponse -> Rep StopInferenceExperimentResponse x # to :: Rep StopInferenceExperimentResponse x -> StopInferenceExperimentResponse #
Read StopInferenceExperimentResponse Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods readsPrec :: Int -> ReadS StopInferenceExperimentResponse # readList :: ReadS [StopInferenceExperimentResponse] # readPrec :: ReadPrec StopInferenceExperimentResponse # readListPrec :: ReadPrec [StopInferenceExperimentResponse] #
Show StopInferenceExperimentResponse Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods showsPrec :: Int -> StopInferenceExperimentResponse -> ShowS # show :: StopInferenceExperimentResponse -> String # showList :: [StopInferenceExperimentResponse] -> ShowS #
NFData StopInferenceExperimentResponse Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods rnf :: StopInferenceExperimentResponse -> () #
Eq StopInferenceExperimentResponse Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment Methods (==) :: StopInferenceExperimentResponse -> StopInferenceExperimentResponse -> Bool # (/=) :: StopInferenceExperimentResponse -> StopInferenceExperimentResponse -> Bool #
type Rep StopInferenceExperimentResponse Source #
Instance details Defined in Amazonka.SageMaker.StopInferenceExperiment type Rep StopInferenceExperimentResponse = D1 ('MetaData "StopInferenceExperimentResponse" "Amazonka.SageMaker.StopInferenceExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "StopInferenceExperimentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "inferenceExperimentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopInferenceExperimentResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopInferenceExperimentResponse'`
-> Text	`$sel:inferenceExperimentArn:StopInferenceExperimentResponse'`
-> StopInferenceExperimentResponse

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

$sel:inferenceExperimentArn:StopInferenceExperimentResponse', stopInferenceExperimentResponse_inferenceExperimentArn - The ARN of the stopped inference experiment.

Response Lenses

stopInferenceExperimentResponse_httpStatus :: Lens' StopInferenceExperimentResponse Int Source #

The response's http status code.

stopInferenceExperimentResponse_inferenceExperimentArn :: Lens' StopInferenceExperimentResponse Text Source #

The ARN of the stopped inference experiment.