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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an SageMaker trial. A trial is a set of steps called /trial components/ that produce a machine learning model. A trial is part of a single SageMaker experiment.

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 and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

Synopsis

Creating a Request

data CreateTrial Source #

See: newCreateTrial smart constructor.

Constructors

CreateTrial'

Fields

metadataProperties :: Maybe MetadataProperties
displayName :: Maybe Text
The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
tags :: Maybe [Tag]
A list of tags to associate with the trial. You can use Search API to search on the tags.
trialName :: Text
The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.
experimentName :: Text
The name of the experiment to associate the trial with.

Instances

Instances details

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

newCreateTrial Source #

Arguments

:: Text	`$sel:trialName:CreateTrial'`
-> Text	`$sel:experimentName:CreateTrial'`
-> CreateTrial

Create a value of CreateTrial 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:CreateTrial', createTrial_metadataProperties - Undocumented member.

$sel:displayName:CreateTrial', createTrial_displayName - The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

$sel:tags:CreateTrial', createTrial_tags - A list of tags to associate with the trial. You can use Search API to search on the tags.

$sel:trialName:CreateTrial', createTrial_trialName - The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

$sel:experimentName:CreateTrial', createTrial_experimentName - The name of the experiment to associate the trial with.

Request Lenses

createTrial_metadataProperties :: Lens' CreateTrial (Maybe MetadataProperties) Source #

Undocumented member.

createTrial_displayName :: Lens' CreateTrial (Maybe Text) Source #

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

createTrial_tags :: Lens' CreateTrial (Maybe [Tag]) Source #

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

createTrial_trialName :: Lens' CreateTrial Text Source #

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

createTrial_experimentName :: Lens' CreateTrial Text Source #

The name of the experiment to associate the trial with.

Destructuring the Response

data CreateTrialResponse Source #

See: newCreateTrialResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateTrialResponse Source #

Arguments

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

Create a value of CreateTrialResponse 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:trialArn:CreateTrialResponse', createTrialResponse_trialArn - The Amazon Resource Name (ARN) of the trial.

$sel:httpStatus:CreateTrialResponse', createTrialResponse_httpStatus - The response's http status code.

Response Lenses

createTrialResponse_trialArn :: Lens' CreateTrialResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial.

createTrialResponse_httpStatus :: Lens' CreateTrialResponse Int Source #

The response's http status code.