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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of a trial's properties.

Synopsis

data DescribeTrial = DescribeTrial' {
- trialName :: Text
}
newDescribeTrial :: Text -> DescribeTrial
describeTrial_trialName :: Lens' DescribeTrial Text
data DescribeTrialResponse = DescribeTrialResponse' {
- createdBy :: Maybe UserContext
- creationTime :: Maybe POSIX
- displayName :: Maybe Text
- experimentName :: Maybe Text
- lastModifiedBy :: Maybe UserContext
- lastModifiedTime :: Maybe POSIX
- metadataProperties :: Maybe MetadataProperties
- source :: Maybe TrialSource
- trialArn :: Maybe Text
- trialName :: Maybe Text
- httpStatus :: Int
}
newDescribeTrialResponse :: Int -> DescribeTrialResponse
describeTrialResponse_createdBy :: Lens' DescribeTrialResponse (Maybe UserContext)
describeTrialResponse_creationTime :: Lens' DescribeTrialResponse (Maybe UTCTime)
describeTrialResponse_displayName :: Lens' DescribeTrialResponse (Maybe Text)
describeTrialResponse_experimentName :: Lens' DescribeTrialResponse (Maybe Text)
describeTrialResponse_lastModifiedBy :: Lens' DescribeTrialResponse (Maybe UserContext)
describeTrialResponse_lastModifiedTime :: Lens' DescribeTrialResponse (Maybe UTCTime)
describeTrialResponse_metadataProperties :: Lens' DescribeTrialResponse (Maybe MetadataProperties)
describeTrialResponse_source :: Lens' DescribeTrialResponse (Maybe TrialSource)
describeTrialResponse_trialArn :: Lens' DescribeTrialResponse (Maybe Text)
describeTrialResponse_trialName :: Lens' DescribeTrialResponse (Maybe Text)
describeTrialResponse_httpStatus :: Lens' DescribeTrialResponse Int

Creating a Request

data DescribeTrial Source #

See: newDescribeTrial smart constructor.

Constructors

DescribeTrial'
Fields trialName :: Text The name of the trial to describe.

Instances

Instances details

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

newDescribeTrial Source #

Arguments

:: Text	`DescribeTrial`
-> DescribeTrial

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

DescribeTrial, describeTrial_trialName - The name of the trial to describe.

Request Lenses

describeTrial_trialName :: Lens' DescribeTrial Text Source #

The name of the trial to describe.

Destructuring the Response

data DescribeTrialResponse Source #

See: newDescribeTrialResponse smart constructor.

Constructors

DescribeTrialResponse'

Fields

createdBy :: Maybe UserContext
Who created the trial.
creationTime :: Maybe POSIX
When the trial was created.
displayName :: Maybe Text
The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
experimentName :: Maybe Text
The name of the experiment the trial is part of.
lastModifiedBy :: Maybe UserContext
Who last modified the trial.
lastModifiedTime :: Maybe POSIX
When the trial was last modified.
metadataProperties :: Maybe MetadataProperties
source :: Maybe TrialSource
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
trialArn :: Maybe Text
The Amazon Resource Name (ARN) of the trial.
trialName :: Maybe Text
The name of the trial.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeTrialResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeTrial Associated Types type Rep DescribeTrialResponse :: Type -> Type # Methods from :: DescribeTrialResponse -> Rep DescribeTrialResponse x # to :: Rep DescribeTrialResponse x -> DescribeTrialResponse #
Read DescribeTrialResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeTrial Methods readsPrec :: Int -> ReadS DescribeTrialResponse # readList :: ReadS [DescribeTrialResponse] # readPrec :: ReadPrec DescribeTrialResponse # readListPrec :: ReadPrec [DescribeTrialResponse] #
Show DescribeTrialResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeTrial Methods showsPrec :: Int -> DescribeTrialResponse -> ShowS # show :: DescribeTrialResponse -> String # showList :: [DescribeTrialResponse] -> ShowS #
NFData DescribeTrialResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeTrial Methods rnf :: DescribeTrialResponse -> () #
Eq DescribeTrialResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeTrial Methods (==) :: DescribeTrialResponse -> DescribeTrialResponse -> Bool # (/=) :: DescribeTrialResponse -> DescribeTrialResponse -> Bool #
type Rep DescribeTrialResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeTrial type Rep DescribeTrialResponse = D1 ('MetaData "DescribeTrialResponse" "Amazonka.SageMaker.DescribeTrial" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeTrialResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext)) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "experimentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext))))) :: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "metadataProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetadataProperties)) :: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrialSource)))) :: (S1 ('MetaSel ('Just "trialArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "trialName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeTrialResponse Source #

Arguments

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

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

DescribeTrialResponse, describeTrialResponse_createdBy - Who created the trial.

DescribeTrialResponse, describeTrialResponse_creationTime - When the trial was created.

DescribeTrialResponse, describeTrialResponse_displayName - The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

DescribeTrialResponse, describeTrialResponse_experimentName - The name of the experiment the trial is part of.

DescribeTrialResponse, describeTrialResponse_lastModifiedBy - Who last modified the trial.

DescribeTrialResponse, describeTrialResponse_lastModifiedTime - When the trial was last modified.

DescribeTrialResponse, describeTrialResponse_metadataProperties - Undocumented member.

DescribeTrialResponse, describeTrialResponse_source - The Amazon Resource Name (ARN) of the source and, optionally, the job type.

DescribeTrialResponse, describeTrialResponse_trialArn - The Amazon Resource Name (ARN) of the trial.

DescribeTrial, describeTrialResponse_trialName - The name of the trial.

$sel:httpStatus:DescribeTrialResponse', describeTrialResponse_httpStatus - The response's http status code.

Response Lenses

describeTrialResponse_createdBy :: Lens' DescribeTrialResponse (Maybe UserContext) Source #

Who created the trial.

describeTrialResponse_creationTime :: Lens' DescribeTrialResponse (Maybe UTCTime) Source #

When the trial was created.

describeTrialResponse_displayName :: Lens' DescribeTrialResponse (Maybe Text) Source #

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

describeTrialResponse_experimentName :: Lens' DescribeTrialResponse (Maybe Text) Source #

The name of the experiment the trial is part of.

describeTrialResponse_lastModifiedBy :: Lens' DescribeTrialResponse (Maybe UserContext) Source #

Who last modified the trial.

describeTrialResponse_lastModifiedTime :: Lens' DescribeTrialResponse (Maybe UTCTime) Source #

When the trial was last modified.

describeTrialResponse_metadataProperties :: Lens' DescribeTrialResponse (Maybe MetadataProperties) Source #

Undocumented member.

describeTrialResponse_source :: Lens' DescribeTrialResponse (Maybe TrialSource) Source #

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

describeTrialResponse_trialArn :: Lens' DescribeTrialResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial.

describeTrialResponse_trialName :: Lens' DescribeTrialResponse (Maybe Text) Source #

The name of the trial.

describeTrialResponse_httpStatus :: Lens' DescribeTrialResponse Int Source #

The response's http status code.