Amazonka.SageMaker.DescribeExperiment

Provides a list of an experiment's properties.

Creating a Request

data DescribeExperiment

See: newDescribeExperiment smart constructor.

Constructors

DescribeExperiment'

Fields

• experimentName :: Text

  The name of the experiment to describe.

Instances

ToJSON DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

toJSON :: DescribeExperiment -> Value

toEncoding :: DescribeExperiment -> Encoding

toJSONList :: [DescribeExperiment] -> Value

toEncodingList :: [DescribeExperiment] -> Encoding

ToHeaders DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

toHeaders :: DescribeExperiment -> [Header]

ToPath DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

toPath :: DescribeExperiment -> ByteString

ToQuery DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

toQuery :: DescribeExperiment -> QueryString

AWSRequest DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Associated Types

type AWSResponse DescribeExperiment

Methods

request :: (Service -> Service) -> DescribeExperiment -> Request DescribeExperiment

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeExperiment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeExperiment)))

Generic DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Associated Types

type Rep DescribeExperiment :: Type -> Type

Methods

from :: DescribeExperiment -> Rep DescribeExperiment x

to :: Rep DescribeExperiment x -> DescribeExperiment

Read DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

readsPrec :: Int -> ReadS DescribeExperiment

readList :: ReadS [DescribeExperiment]

readPrec :: ReadPrec DescribeExperiment

readListPrec :: ReadPrec [DescribeExperiment]

Show DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

showsPrec :: Int -> DescribeExperiment -> ShowS

show :: DescribeExperiment -> String

showList :: [DescribeExperiment] -> ShowS

NFData DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

rnf :: DescribeExperiment -> ()

Eq DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

(==) :: DescribeExperiment -> DescribeExperiment -> Bool

(/=) :: DescribeExperiment -> DescribeExperiment -> Bool

Hashable DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

hashWithSalt :: Int -> DescribeExperiment -> Int

hash :: DescribeExperiment -> Int

type AWSResponse DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

type AWSResponse DescribeExperiment = DescribeExperimentResponse

type Rep DescribeExperiment

Defined in Amazonka.SageMaker.DescribeExperiment

type Rep DescribeExperiment = D1 ('MetaData "DescribeExperiment" "Amazonka.SageMaker.DescribeExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeExperiment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "experimentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeExperiment

Arguments

:: Text

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:

DescribeExperiment, describeExperiment_experimentName - The name of the experiment to describe.

Request Lenses

describeExperiment_experimentName :: Lens' DescribeExperiment Text

The name of the experiment to describe.

Destructuring the Response

data DescribeExperimentResponse

See: newDescribeExperimentResponse smart constructor.

Constructors

DescribeExperimentResponse'

Fields

• createdBy :: Maybe UserContext

  Who created the experiment.

• creationTime :: Maybe POSIX

  When the experiment was created.

• description :: Maybe Text

  The description of the experiment.

• displayName :: Maybe Text

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

• experimentArn :: Maybe Text

  The Amazon Resource Name (ARN) of the experiment.

• experimentName :: Maybe Text

  The name of the experiment.

• lastModifiedBy :: Maybe UserContext

  Who last modified the experiment.

• lastModifiedTime :: Maybe POSIX

  When the experiment was last modified.

• source :: Maybe ExperimentSource

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeExperimentResponse

Defined in Amazonka.SageMaker.DescribeExperiment

Associated Types

type Rep DescribeExperimentResponse :: Type -> Type

Methods

from :: DescribeExperimentResponse -> Rep DescribeExperimentResponse x

to :: Rep DescribeExperimentResponse x -> DescribeExperimentResponse

Read DescribeExperimentResponse

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

readsPrec :: Int -> ReadS DescribeExperimentResponse

readList :: ReadS [DescribeExperimentResponse]

readPrec :: ReadPrec DescribeExperimentResponse

readListPrec :: ReadPrec [DescribeExperimentResponse]

Show DescribeExperimentResponse

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

showsPrec :: Int -> DescribeExperimentResponse -> ShowS

show :: DescribeExperimentResponse -> String

showList :: [DescribeExperimentResponse] -> ShowS

NFData DescribeExperimentResponse

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

rnf :: DescribeExperimentResponse -> ()

Eq DescribeExperimentResponse

Defined in Amazonka.SageMaker.DescribeExperiment

Methods

(==) :: DescribeExperimentResponse -> DescribeExperimentResponse -> Bool

(/=) :: DescribeExperimentResponse -> DescribeExperimentResponse -> Bool

type Rep DescribeExperimentResponse

Defined in Amazonka.SageMaker.DescribeExperiment

type Rep DescribeExperimentResponse = D1 ('MetaData "DescribeExperimentResponse" "Amazonka.SageMaker.DescribeExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeExperimentResponse'" '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 "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "experimentArn") '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 "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperimentSource)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeExperimentResponse

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:

DescribeExperimentResponse, describeExperimentResponse_createdBy - Who created the experiment.

DescribeExperimentResponse, describeExperimentResponse_creationTime - When the experiment was created.

DescribeExperimentResponse, describeExperimentResponse_description - The description of the experiment.

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

DescribeExperimentResponse, describeExperimentResponse_experimentArn - The Amazon Resource Name (ARN) of the experiment.

DescribeExperiment, describeExperimentResponse_experimentName - The name of the experiment.

DescribeExperimentResponse, describeExperimentResponse_lastModifiedBy - Who last modified the experiment.

DescribeExperimentResponse, describeExperimentResponse_lastModifiedTime - When the experiment was last modified.

DescribeExperimentResponse, describeExperimentResponse_source - The Amazon Resource Name (ARN) of the source and, optionally, the type.

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

Response Lenses

describeExperimentResponse_createdBy :: Lens' DescribeExperimentResponse (Maybe UserContext)

Who created the experiment.

describeExperimentResponse_creationTime :: Lens' DescribeExperimentResponse (Maybe UTCTime)

When the experiment was created.

describeExperimentResponse_description :: Lens' DescribeExperimentResponse (Maybe Text)

The description of the experiment.

describeExperimentResponse_displayName :: Lens' DescribeExperimentResponse (Maybe Text)

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

describeExperimentResponse_experimentArn :: Lens' DescribeExperimentResponse (Maybe Text)

The Amazon Resource Name (ARN) of the experiment.

describeExperimentResponse_experimentName :: Lens' DescribeExperimentResponse (Maybe Text)

The name of the experiment.

describeExperimentResponse_lastModifiedBy :: Lens' DescribeExperimentResponse (Maybe UserContext)

Who last modified the experiment.

describeExperimentResponse_lastModifiedTime :: Lens' DescribeExperimentResponse (Maybe UTCTime)

When the experiment was last modified.

describeExperimentResponse_source :: Lens' DescribeExperimentResponse (Maybe ExperimentSource)

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

describeExperimentResponse_httpStatus :: Lens' DescribeExperimentResponse Int

The response's http status code.