Amazonka.SageMaker.UpdateExperiment

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

Creating a Request

data UpdateExperiment

See: newUpdateExperiment smart constructor.

Constructors

UpdateExperiment'

Fields

• description :: Maybe Text

  The description of the experiment.

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

• experimentName :: Text

  The name of the experiment to update.

Instances

ToJSON UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

toJSON :: UpdateExperiment -> Value

toEncoding :: UpdateExperiment -> Encoding

toJSONList :: [UpdateExperiment] -> Value

toEncodingList :: [UpdateExperiment] -> Encoding

ToHeaders UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

toHeaders :: UpdateExperiment -> [Header]

ToPath UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

toPath :: UpdateExperiment -> ByteString

ToQuery UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

toQuery :: UpdateExperiment -> QueryString

AWSRequest UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Associated Types

type AWSResponse UpdateExperiment

Methods

request :: (Service -> Service) -> UpdateExperiment -> Request UpdateExperiment

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateExperiment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateExperiment)))

Generic UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Associated Types

type Rep UpdateExperiment :: Type -> Type

Methods

from :: UpdateExperiment -> Rep UpdateExperiment x

to :: Rep UpdateExperiment x -> UpdateExperiment

Read UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

readsPrec :: Int -> ReadS UpdateExperiment

readList :: ReadS [UpdateExperiment]

readPrec :: ReadPrec UpdateExperiment

readListPrec :: ReadPrec [UpdateExperiment]

Show UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

showsPrec :: Int -> UpdateExperiment -> ShowS

show :: UpdateExperiment -> String

showList :: [UpdateExperiment] -> ShowS

NFData UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

rnf :: UpdateExperiment -> ()

Eq UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

(==) :: UpdateExperiment -> UpdateExperiment -> Bool

(/=) :: UpdateExperiment -> UpdateExperiment -> Bool

Hashable UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

hashWithSalt :: Int -> UpdateExperiment -> Int

hash :: UpdateExperiment -> Int

type AWSResponse UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

type AWSResponse UpdateExperiment = UpdateExperimentResponse

type Rep UpdateExperiment

Defined in Amazonka.SageMaker.UpdateExperiment

type Rep UpdateExperiment = D1 ('MetaData "UpdateExperiment" "Amazonka.SageMaker.UpdateExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UpdateExperiment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "experimentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateExperiment

Arguments

:: Text

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:

UpdateExperiment, updateExperiment_description - The description of the experiment.

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.

UpdateExperiment, updateExperiment_experimentName - The name of the experiment to update.

Request Lenses

updateExperiment_description :: Lens' UpdateExperiment (Maybe Text)

The description of the experiment.

updateExperiment_displayName :: Lens' UpdateExperiment (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.

updateExperiment_experimentName :: Lens' UpdateExperiment Text

The name of the experiment to update.

Destructuring the Response

data UpdateExperimentResponse

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

Generic UpdateExperimentResponse

Defined in Amazonka.SageMaker.UpdateExperiment

Associated Types

type Rep UpdateExperimentResponse :: Type -> Type

Methods

from :: UpdateExperimentResponse -> Rep UpdateExperimentResponse x

to :: Rep UpdateExperimentResponse x -> UpdateExperimentResponse

Read UpdateExperimentResponse

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

readsPrec :: Int -> ReadS UpdateExperimentResponse

readList :: ReadS [UpdateExperimentResponse]

readPrec :: ReadPrec UpdateExperimentResponse

readListPrec :: ReadPrec [UpdateExperimentResponse]

Show UpdateExperimentResponse

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

showsPrec :: Int -> UpdateExperimentResponse -> ShowS

show :: UpdateExperimentResponse -> String

showList :: [UpdateExperimentResponse] -> ShowS

NFData UpdateExperimentResponse

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

rnf :: UpdateExperimentResponse -> ()

Eq UpdateExperimentResponse

Defined in Amazonka.SageMaker.UpdateExperiment

Methods

(==) :: UpdateExperimentResponse -> UpdateExperimentResponse -> Bool

(/=) :: UpdateExperimentResponse -> UpdateExperimentResponse -> Bool

type Rep UpdateExperimentResponse

Defined in Amazonka.SageMaker.UpdateExperiment

type Rep UpdateExperimentResponse = D1 ('MetaData "UpdateExperimentResponse" "Amazonka.SageMaker.UpdateExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" '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

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:

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)

The Amazon Resource Name (ARN) of the experiment.

updateExperimentResponse_httpStatus :: Lens' UpdateExperimentResponse Int

The response's http status code.