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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates one or more properties of a trial component.

Synopsis

data UpdateTrialComponent = UpdateTrialComponent' {
- displayName :: Maybe Text
- endTime :: Maybe POSIX
- inputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)
- inputArtifactsToRemove :: Maybe [Text]
- outputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)
- outputArtifactsToRemove :: Maybe [Text]
- parameters :: Maybe (HashMap Text TrialComponentParameterValue)
- parametersToRemove :: Maybe [Text]
- startTime :: Maybe POSIX
- status :: Maybe TrialComponentStatus
- trialComponentName :: Text
}
newUpdateTrialComponent :: Text -> UpdateTrialComponent
updateTrialComponent_displayName :: Lens' UpdateTrialComponent (Maybe Text)
updateTrialComponent_endTime :: Lens' UpdateTrialComponent (Maybe UTCTime)
updateTrialComponent_inputArtifacts :: Lens' UpdateTrialComponent (Maybe (HashMap Text TrialComponentArtifact))
updateTrialComponent_inputArtifactsToRemove :: Lens' UpdateTrialComponent (Maybe [Text])
updateTrialComponent_outputArtifacts :: Lens' UpdateTrialComponent (Maybe (HashMap Text TrialComponentArtifact))
updateTrialComponent_outputArtifactsToRemove :: Lens' UpdateTrialComponent (Maybe [Text])
updateTrialComponent_parameters :: Lens' UpdateTrialComponent (Maybe (HashMap Text TrialComponentParameterValue))
updateTrialComponent_parametersToRemove :: Lens' UpdateTrialComponent (Maybe [Text])
updateTrialComponent_startTime :: Lens' UpdateTrialComponent (Maybe UTCTime)
updateTrialComponent_status :: Lens' UpdateTrialComponent (Maybe TrialComponentStatus)
updateTrialComponent_trialComponentName :: Lens' UpdateTrialComponent Text
data UpdateTrialComponentResponse = UpdateTrialComponentResponse' {
- trialComponentArn :: Maybe Text
- httpStatus :: Int
}
newUpdateTrialComponentResponse :: Int -> UpdateTrialComponentResponse
updateTrialComponentResponse_trialComponentArn :: Lens' UpdateTrialComponentResponse (Maybe Text)
updateTrialComponentResponse_httpStatus :: Lens' UpdateTrialComponentResponse Int

Creating a Request

data UpdateTrialComponent Source #

See: newUpdateTrialComponent smart constructor.

Constructors

UpdateTrialComponent'

Fields

displayName :: Maybe Text
The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
endTime :: Maybe POSIX
When the component ended.
inputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)
Replaces all of the component's input artifacts with the specified artifacts.
inputArtifactsToRemove :: Maybe [Text]
The input artifacts to remove from the component.
outputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)
Replaces all of the component's output artifacts with the specified artifacts.
outputArtifactsToRemove :: Maybe [Text]
The output artifacts to remove from the component.
parameters :: Maybe (HashMap Text TrialComponentParameterValue)
Replaces all of the component's hyperparameters with the specified hyperparameters.
parametersToRemove :: Maybe [Text]
The hyperparameters to remove from the component.
startTime :: Maybe POSIX
When the component started.
status :: Maybe TrialComponentStatus
The new status of the component.
trialComponentName :: Text
The name of the component to update.

Instances

Instances details

ToJSON UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Methods toJSON :: UpdateTrialComponent -> Value # toEncoding :: UpdateTrialComponent -> Encoding # toJSONList :: [UpdateTrialComponent] -> Value # toEncodingList :: [UpdateTrialComponent] -> Encoding #
ToHeaders UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Methods toHeaders :: UpdateTrialComponent -> [Header] #
ToPath UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Methods toPath :: UpdateTrialComponent -> ByteString #
ToQuery UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Methods toQuery :: UpdateTrialComponent -> QueryString #
AWSRequest UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Associated Types type AWSResponse UpdateTrialComponent # Methods request :: (Service -> Service) -> UpdateTrialComponent -> Request UpdateTrialComponent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateTrialComponent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateTrialComponent))) #
Generic UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Associated Types type Rep UpdateTrialComponent :: Type -> Type # Methods from :: UpdateTrialComponent -> Rep UpdateTrialComponent x # to :: Rep UpdateTrialComponent x -> UpdateTrialComponent #
Read UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Methods readsPrec :: Int -> ReadS UpdateTrialComponent # readList :: ReadS [UpdateTrialComponent] # readPrec :: ReadPrec UpdateTrialComponent # readListPrec :: ReadPrec [UpdateTrialComponent] #
Show UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Methods showsPrec :: Int -> UpdateTrialComponent -> ShowS # show :: UpdateTrialComponent -> String # showList :: [UpdateTrialComponent] -> ShowS #
NFData UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Methods rnf :: UpdateTrialComponent -> () #
Eq UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Methods (==) :: UpdateTrialComponent -> UpdateTrialComponent -> Bool # (/=) :: UpdateTrialComponent -> UpdateTrialComponent -> Bool #
Hashable UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent Methods hashWithSalt :: Int -> UpdateTrialComponent -> Int # hash :: UpdateTrialComponent -> Int #
type AWSResponse UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent type AWSResponse UpdateTrialComponent = UpdateTrialComponentResponse
type Rep UpdateTrialComponent Source #
Instance details Defined in Amazonka.SageMaker.UpdateTrialComponent type Rep UpdateTrialComponent = D1 ('MetaData "UpdateTrialComponent" "Amazonka.SageMaker.UpdateTrialComponent" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UpdateTrialComponent'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "inputArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text TrialComponentArtifact))) :: (S1 ('MetaSel ('Just "inputArtifactsToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "outputArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text TrialComponentArtifact)))))) :: ((S1 ('MetaSel ('Just "outputArtifactsToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text TrialComponentParameterValue))) :: S1 ('MetaSel ('Just "parametersToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrialComponentStatus)) :: S1 ('MetaSel ('Just "trialComponentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateTrialComponent Source #

Arguments

:: Text	`UpdateTrialComponent`
-> UpdateTrialComponent

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

UpdateTrialComponent, updateTrialComponent_displayName - The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

UpdateTrialComponent, updateTrialComponent_endTime - When the component ended.

UpdateTrialComponent, updateTrialComponent_inputArtifacts - Replaces all of the component's input artifacts with the specified artifacts.

$sel:inputArtifactsToRemove:UpdateTrialComponent', updateTrialComponent_inputArtifactsToRemove - The input artifacts to remove from the component.

UpdateTrialComponent, updateTrialComponent_outputArtifacts - Replaces all of the component's output artifacts with the specified artifacts.

$sel:outputArtifactsToRemove:UpdateTrialComponent', updateTrialComponent_outputArtifactsToRemove - The output artifacts to remove from the component.

UpdateTrialComponent, updateTrialComponent_parameters - Replaces all of the component's hyperparameters with the specified hyperparameters.

$sel:parametersToRemove:UpdateTrialComponent', updateTrialComponent_parametersToRemove - The hyperparameters to remove from the component.

UpdateTrialComponent, updateTrialComponent_startTime - When the component started.

UpdateTrialComponent, updateTrialComponent_status - The new status of the component.

UpdateTrialComponent, updateTrialComponent_trialComponentName - The name of the component to update.

Request Lenses

updateTrialComponent_displayName :: Lens' UpdateTrialComponent (Maybe Text) Source #

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

updateTrialComponent_endTime :: Lens' UpdateTrialComponent (Maybe UTCTime) Source #

When the component ended.

updateTrialComponent_inputArtifacts :: Lens' UpdateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

Replaces all of the component's input artifacts with the specified artifacts.

updateTrialComponent_inputArtifactsToRemove :: Lens' UpdateTrialComponent (Maybe [Text]) Source #

The input artifacts to remove from the component.

updateTrialComponent_outputArtifacts :: Lens' UpdateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

Replaces all of the component's output artifacts with the specified artifacts.

updateTrialComponent_outputArtifactsToRemove :: Lens' UpdateTrialComponent (Maybe [Text]) Source #

The output artifacts to remove from the component.

updateTrialComponent_parameters :: Lens' UpdateTrialComponent (Maybe (HashMap Text TrialComponentParameterValue)) Source #

Replaces all of the component's hyperparameters with the specified hyperparameters.

updateTrialComponent_parametersToRemove :: Lens' UpdateTrialComponent (Maybe [Text]) Source #

The hyperparameters to remove from the component.

updateTrialComponent_startTime :: Lens' UpdateTrialComponent (Maybe UTCTime) Source #

When the component started.

updateTrialComponent_status :: Lens' UpdateTrialComponent (Maybe TrialComponentStatus) Source #

The new status of the component.

updateTrialComponent_trialComponentName :: Lens' UpdateTrialComponent Text Source #

The name of the component to update.

Destructuring the Response

data UpdateTrialComponentResponse Source #

See: newUpdateTrialComponentResponse smart constructor.

Constructors

UpdateTrialComponentResponse'
Fields trialComponentArn :: Maybe Text The Amazon Resource Name (ARN) of the trial component. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateTrialComponentResponse Source #

Arguments

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

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

UpdateTrialComponentResponse, updateTrialComponentResponse_trialComponentArn - The Amazon Resource Name (ARN) of the trial component.

$sel:httpStatus:UpdateTrialComponentResponse', updateTrialComponentResponse_httpStatus - The response's http status code.

Response Lenses

updateTrialComponentResponse_trialComponentArn :: Lens' UpdateTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial component.

updateTrialComponentResponse_httpStatus :: Lens' UpdateTrialComponentResponse Int Source #

The response's http status code.