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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of an experiment's properties.

Synopsis

data DescribeExperiment = DescribeExperiment' {
- experimentName :: Text
}
newDescribeExperiment :: Text -> DescribeExperiment
describeExperiment_experimentName :: Lens' DescribeExperiment Text
data DescribeExperimentResponse = DescribeExperimentResponse' {
- creationTime :: Maybe POSIX
- createdBy :: Maybe UserContext
- lastModifiedTime :: Maybe POSIX
- experimentName :: Maybe Text
- experimentArn :: Maybe Text
- source :: Maybe ExperimentSource
- displayName :: Maybe Text
- lastModifiedBy :: Maybe UserContext
- description :: Maybe Text
- httpStatus :: Int
}
newDescribeExperimentResponse :: Int -> DescribeExperimentResponse
describeExperimentResponse_creationTime :: Lens' DescribeExperimentResponse (Maybe UTCTime)
describeExperimentResponse_createdBy :: Lens' DescribeExperimentResponse (Maybe UserContext)
describeExperimentResponse_lastModifiedTime :: Lens' DescribeExperimentResponse (Maybe UTCTime)
describeExperimentResponse_experimentName :: Lens' DescribeExperimentResponse (Maybe Text)
describeExperimentResponse_experimentArn :: Lens' DescribeExperimentResponse (Maybe Text)
describeExperimentResponse_source :: Lens' DescribeExperimentResponse (Maybe ExperimentSource)
describeExperimentResponse_displayName :: Lens' DescribeExperimentResponse (Maybe Text)
describeExperimentResponse_lastModifiedBy :: Lens' DescribeExperimentResponse (Maybe UserContext)
describeExperimentResponse_description :: Lens' DescribeExperimentResponse (Maybe Text)
describeExperimentResponse_httpStatus :: Lens' DescribeExperimentResponse Int

Creating a Request

data DescribeExperiment Source #

See: newDescribeExperiment smart constructor.

Constructors

DescribeExperiment'
Fields experimentName :: Text The name of the experiment to describe.

Instances

Instances details

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

newDescribeExperiment Source #

Arguments

:: Text	`$sel:experimentName:DescribeExperiment'`
-> DescribeExperiment

Create a value of DescribeExperiment 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:experimentName:DescribeExperiment', describeExperiment_experimentName - The name of the experiment to describe.

Request Lenses

describeExperiment_experimentName :: Lens' DescribeExperiment Text Source #

The name of the experiment to describe.

Destructuring the Response

data DescribeExperimentResponse Source #

See: newDescribeExperimentResponse smart constructor.

Constructors

DescribeExperimentResponse'

Fields

creationTime :: Maybe POSIX
When the experiment was created.
createdBy :: Maybe UserContext
Who created the experiment.
lastModifiedTime :: Maybe POSIX
When the experiment was last modified.
experimentName :: Maybe Text
The name of the experiment.
experimentArn :: Maybe Text
The Amazon Resource Name (ARN) of the experiment.
source :: Maybe ExperimentSource
The ARN of the source and, optionally, the type.
displayName :: Maybe Text
The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
lastModifiedBy :: Maybe UserContext
Who last modified the experiment.
description :: Maybe Text
The description of the experiment.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeExperimentResponse Source #

Arguments

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

Create a value of DescribeExperimentResponse 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:creationTime:DescribeExperimentResponse', describeExperimentResponse_creationTime - When the experiment was created.

$sel:createdBy:DescribeExperimentResponse', describeExperimentResponse_createdBy - Who created the experiment.

$sel:lastModifiedTime:DescribeExperimentResponse', describeExperimentResponse_lastModifiedTime - When the experiment was last modified.

$sel:experimentName:DescribeExperiment', describeExperimentResponse_experimentName - The name of the experiment.

$sel:experimentArn:DescribeExperimentResponse', describeExperimentResponse_experimentArn - The Amazon Resource Name (ARN) of the experiment.

$sel:source:DescribeExperimentResponse', describeExperimentResponse_source - The ARN of the source and, optionally, the type.

$sel:displayName:DescribeExperimentResponse', describeExperimentResponse_displayName - The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

$sel:lastModifiedBy:DescribeExperimentResponse', describeExperimentResponse_lastModifiedBy - Who last modified the experiment.

$sel:description:DescribeExperimentResponse', describeExperimentResponse_description - The description of the experiment.

$sel:httpStatus:DescribeExperimentResponse', describeExperimentResponse_httpStatus - The response's http status code.

Response Lenses

describeExperimentResponse_creationTime :: Lens' DescribeExperimentResponse (Maybe UTCTime) Source #

When the experiment was created.

describeExperimentResponse_createdBy :: Lens' DescribeExperimentResponse (Maybe UserContext) Source #

Who created the experiment.

describeExperimentResponse_lastModifiedTime :: Lens' DescribeExperimentResponse (Maybe UTCTime) Source #

When the experiment was last modified.

describeExperimentResponse_experimentName :: Lens' DescribeExperimentResponse (Maybe Text) Source #

The name of the experiment.

describeExperimentResponse_experimentArn :: Lens' DescribeExperimentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the experiment.

describeExperimentResponse_source :: Lens' DescribeExperimentResponse (Maybe ExperimentSource) Source #

The ARN of the source and, optionally, the type.

describeExperimentResponse_displayName :: Lens' DescribeExperimentResponse (Maybe Text) Source #

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

describeExperimentResponse_lastModifiedBy :: Lens' DescribeExperimentResponse (Maybe UserContext) Source #

Who last modified the experiment.

describeExperimentResponse_description :: Lens' DescribeExperimentResponse (Maybe Text) Source #

The description of the experiment.

describeExperimentResponse_httpStatus :: Lens' DescribeExperimentResponse Int Source #

The response's http status code.