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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

Synopsis

Creating a Request

data CreateTrialComponent Source #

See: newCreateTrialComponent smart constructor.

Constructors

CreateTrialComponent'

Fields

metadataProperties :: Maybe MetadataProperties
status :: Maybe TrialComponentStatus
The status of the component. States include:
- InProgress
- Completed
- Failed
outputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)
The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
startTime :: Maybe POSIX
When the component started.
endTime :: Maybe POSIX
When the component ended.
parameters :: Maybe (HashMap Text TrialComponentParameterValue)
The hyperparameters for the component.
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.
inputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)
The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
tags :: Maybe [Tag]
A list of tags to associate with the component. You can use Search API to search on the tags.
trialComponentName :: Text
The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Instances

Instances details

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

newCreateTrialComponent Source #

Arguments

:: Text	`$sel:trialComponentName:CreateTrialComponent'`
-> CreateTrialComponent

Create a value of CreateTrialComponent 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:metadataProperties:CreateTrialComponent', createTrialComponent_metadataProperties - Undocumented member.

$sel:status:CreateTrialComponent', createTrialComponent_status - The status of the component. States include:

InProgress
Completed
Failed

$sel:outputArtifacts:CreateTrialComponent', createTrialComponent_outputArtifacts - The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

$sel:startTime:CreateTrialComponent', createTrialComponent_startTime - When the component started.

$sel:endTime:CreateTrialComponent', createTrialComponent_endTime - When the component ended.

$sel:parameters:CreateTrialComponent', createTrialComponent_parameters - The hyperparameters for the component.

$sel:displayName:CreateTrialComponent', createTrialComponent_displayName - The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

$sel:inputArtifacts:CreateTrialComponent', createTrialComponent_inputArtifacts - The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

$sel:tags:CreateTrialComponent', createTrialComponent_tags - A list of tags to associate with the component. You can use Search API to search on the tags.

$sel:trialComponentName:CreateTrialComponent', createTrialComponent_trialComponentName - The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Request Lenses

createTrialComponent_metadataProperties :: Lens' CreateTrialComponent (Maybe MetadataProperties) Source #

Undocumented member.

createTrialComponent_status :: Lens' CreateTrialComponent (Maybe TrialComponentStatus) Source #

The status of the component. States include:

InProgress
Completed
Failed

createTrialComponent_outputArtifacts :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

createTrialComponent_startTime :: Lens' CreateTrialComponent (Maybe UTCTime) Source #

When the component started.

createTrialComponent_endTime :: Lens' CreateTrialComponent (Maybe UTCTime) Source #

When the component ended.

createTrialComponent_parameters :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentParameterValue)) Source #

The hyperparameters for the component.

createTrialComponent_displayName :: Lens' CreateTrialComponent (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.

createTrialComponent_inputArtifacts :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

createTrialComponent_tags :: Lens' CreateTrialComponent (Maybe [Tag]) Source #

A list of tags to associate with the component. You can use Search API to search on the tags.

createTrialComponent_trialComponentName :: Lens' CreateTrialComponent Text Source #

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Destructuring the Response

data CreateTrialComponentResponse Source #

See: newCreateTrialComponentResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateTrialComponentResponse Source #

Arguments

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

Create a value of CreateTrialComponentResponse 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:trialComponentArn:CreateTrialComponentResponse', createTrialComponentResponse_trialComponentArn - The Amazon Resource Name (ARN) of the trial component.

$sel:httpStatus:CreateTrialComponentResponse', createTrialComponentResponse_httpStatus - The response's http status code.

Response Lenses

createTrialComponentResponse_trialComponentArn :: Lens' CreateTrialComponentResponse (Maybe Text) Source #

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

createTrialComponentResponse_httpStatus :: Lens' CreateTrialComponentResponse Int Source #

The response's http status code.