Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.UpdateExperiment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

Creating a Request

data UpdateExperiment Source #

See: newUpdateExperiment smart constructor.

Constructors

UpdateExperiment'
Fields displayName :: Maybe Text The name of the experiment as displayed. The name doesn't need to be unique. If `DisplayName` isn't specified, `ExperimentName` is displayed. description :: Maybe Text The description of the experiment. experimentName :: Text The name of the experiment to update.

Instances

Instances details

Eq UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Methods (==) :: UpdateExperiment -> UpdateExperiment -> Bool # (/=) :: UpdateExperiment -> UpdateExperiment -> Bool #
Read UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Methods readsPrec :: Int -> ReadS UpdateExperiment # readList :: ReadS [UpdateExperiment] # readPrec :: ReadPrec UpdateExperiment # readListPrec :: ReadPrec [UpdateExperiment] #
Show UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Methods showsPrec :: Int -> UpdateExperiment -> ShowS # show :: UpdateExperiment -> String # showList :: [UpdateExperiment] -> ShowS #
Generic UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Associated Types type Rep UpdateExperiment :: Type -> Type # Methods from :: UpdateExperiment -> Rep UpdateExperiment x # to :: Rep UpdateExperiment x -> UpdateExperiment #
NFData UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Methods rnf :: UpdateExperiment -> () #
Hashable UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Methods hashWithSalt :: Int -> UpdateExperiment -> Int # hash :: UpdateExperiment -> Int #
ToJSON UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Methods toJSON :: UpdateExperiment -> Value # toEncoding :: UpdateExperiment -> Encoding # toJSONList :: [UpdateExperiment] -> Value # toEncodingList :: [UpdateExperiment] -> Encoding #
AWSRequest UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Associated Types type AWSResponse UpdateExperiment # Methods request :: UpdateExperiment -> Request UpdateExperiment # response :: MonadResource m => Logger -> Service -> Proxy UpdateExperiment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateExperiment))) #
ToHeaders UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Methods toHeaders :: UpdateExperiment -> [Header] #
ToPath UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Methods toPath :: UpdateExperiment -> ByteString #
ToQuery UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment Methods toQuery :: UpdateExperiment -> QueryString #
type Rep UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment type Rep UpdateExperiment = D1 ('MetaData "UpdateExperiment" "Amazonka.SageMaker.UpdateExperiment" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "UpdateExperiment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "experimentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateExperiment Source #
Instance details Defined in Amazonka.SageMaker.UpdateExperiment type AWSResponse UpdateExperiment = UpdateExperimentResponse

newUpdateExperiment Source #

Arguments

:: Text	`$sel:experimentName:UpdateExperiment'`
-> UpdateExperiment

Create a value of UpdateExperiment 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:displayName:UpdateExperiment', updateExperiment_displayName - The name of the experiment as displayed. The name doesn't need to be unique. If DisplayName isn't specified, ExperimentName is displayed.

$sel:description:UpdateExperiment', updateExperiment_description - The description of the experiment.

$sel:experimentName:UpdateExperiment', updateExperiment_experimentName - The name of the experiment to update.

Request Lenses

updateExperiment_displayName :: Lens' UpdateExperiment (Maybe Text) Source #

The name of the experiment as displayed. The name doesn't need to be unique. If DisplayName isn't specified, ExperimentName is displayed.

updateExperiment_description :: Lens' UpdateExperiment (Maybe Text) Source #

The description of the experiment.

updateExperiment_experimentName :: Lens' UpdateExperiment Text Source #

The name of the experiment to update.

Destructuring the Response

data UpdateExperimentResponse Source #

See: newUpdateExperimentResponse smart constructor.

Constructors

UpdateExperimentResponse'
Fields experimentArn :: Maybe Text The Amazon Resource Name (ARN) of the experiment. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateExperimentResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateExperimentResponse'`
-> UpdateExperimentResponse

Create a value of UpdateExperimentResponse 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:experimentArn:UpdateExperimentResponse', updateExperimentResponse_experimentArn - The Amazon Resource Name (ARN) of the experiment.

$sel:httpStatus:UpdateExperimentResponse', updateExperimentResponse_httpStatus - The response's http status code.

Response Lenses

updateExperimentResponse_experimentArn :: Lens' UpdateExperimentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the experiment.

updateExperimentResponse_httpStatus :: Lens' UpdateExperimentResponse Int Source #

The response's http status code.