Amazonka.SageMaker.DescribeTrialComponent

Provides a list of a trials component's properties.

Creating a Request

data DescribeTrialComponent

See: newDescribeTrialComponent smart constructor.

Constructors

DescribeTrialComponent'

Fields

• trialComponentName :: Text

  The name of the trial component to describe.

Instances

ToJSON DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

toJSON :: DescribeTrialComponent -> Value

toEncoding :: DescribeTrialComponent -> Encoding

toJSONList :: [DescribeTrialComponent] -> Value

toEncodingList :: [DescribeTrialComponent] -> Encoding

ToHeaders DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

toHeaders :: DescribeTrialComponent -> [Header]

ToPath DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

toPath :: DescribeTrialComponent -> ByteString

ToQuery DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

toQuery :: DescribeTrialComponent -> QueryString

AWSRequest DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Associated Types

type AWSResponse DescribeTrialComponent

Methods

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

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

Generic DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Associated Types

type Rep DescribeTrialComponent :: Type -> Type

Methods

from :: DescribeTrialComponent -> Rep DescribeTrialComponent x

to :: Rep DescribeTrialComponent x -> DescribeTrialComponent

Read DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

readsPrec :: Int -> ReadS DescribeTrialComponent

readList :: ReadS [DescribeTrialComponent]

readPrec :: ReadPrec DescribeTrialComponent

readListPrec :: ReadPrec [DescribeTrialComponent]

Show DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

showsPrec :: Int -> DescribeTrialComponent -> ShowS

show :: DescribeTrialComponent -> String

showList :: [DescribeTrialComponent] -> ShowS

NFData DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

rnf :: DescribeTrialComponent -> ()

Eq DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

(==) :: DescribeTrialComponent -> DescribeTrialComponent -> Bool

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

Hashable DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

hashWithSalt :: Int -> DescribeTrialComponent -> Int

hash :: DescribeTrialComponent -> Int

type AWSResponse DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

type AWSResponse DescribeTrialComponent = DescribeTrialComponentResponse

type Rep DescribeTrialComponent

Defined in Amazonka.SageMaker.DescribeTrialComponent

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

newDescribeTrialComponent

Arguments

:: Text

DescribeTrialComponent

-> DescribeTrialComponent

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

DescribeTrialComponent, describeTrialComponent_trialComponentName - The name of the trial component to describe.

Request Lenses

describeTrialComponent_trialComponentName :: Lens' DescribeTrialComponent Text

The name of the trial component to describe.

Destructuring the Response

data DescribeTrialComponentResponse

See: newDescribeTrialComponentResponse smart constructor.

Constructors

DescribeTrialComponentResponse'

Fields

• createdBy :: Maybe UserContext

  Who created the trial component.

• creationTime :: Maybe POSIX

  When the component was created.

• displayName :: Maybe Text

  The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

• endTime :: Maybe POSIX

  When the component ended.

• inputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)

  The input artifacts of the component.

• lastModifiedBy :: Maybe UserContext

  Who last modified the component.

• lastModifiedTime :: Maybe POSIX

  When the component was last modified.

• lineageGroupArn :: Maybe Text

  The Amazon Resource Name (ARN) of the lineage group.

• metadataProperties :: Maybe MetadataProperties
• metrics :: Maybe [TrialComponentMetricSummary]

  The metrics for the component.

• outputArtifacts :: Maybe (HashMap Text TrialComponentArtifact)

  The output artifacts of the component.

• parameters :: Maybe (HashMap Text TrialComponentParameterValue)

  The hyperparameters of the component.

• source :: Maybe TrialComponentSource

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

• sources :: Maybe [TrialComponentSource]

  A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

• startTime :: Maybe POSIX

  When the component started.

• status :: Maybe TrialComponentStatus

  The status of the component. States include:

  • InProgress
  • Completed
  • Failed
• trialComponentArn :: Maybe Text

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

• trialComponentName :: Maybe Text

  The name of the trial component.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeTrialComponentResponse

Defined in Amazonka.SageMaker.DescribeTrialComponent

Associated Types

type Rep DescribeTrialComponentResponse :: Type -> Type

Methods

from :: DescribeTrialComponentResponse -> Rep DescribeTrialComponentResponse x

to :: Rep DescribeTrialComponentResponse x -> DescribeTrialComponentResponse

Read DescribeTrialComponentResponse

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

readsPrec :: Int -> ReadS DescribeTrialComponentResponse

readList :: ReadS [DescribeTrialComponentResponse]

readPrec :: ReadPrec DescribeTrialComponentResponse

readListPrec :: ReadPrec [DescribeTrialComponentResponse]

Show DescribeTrialComponentResponse

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

showsPrec :: Int -> DescribeTrialComponentResponse -> ShowS

show :: DescribeTrialComponentResponse -> String

showList :: [DescribeTrialComponentResponse] -> ShowS

NFData DescribeTrialComponentResponse

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

rnf :: DescribeTrialComponentResponse -> ()

Eq DescribeTrialComponentResponse

Defined in Amazonka.SageMaker.DescribeTrialComponent

Methods

(==) :: DescribeTrialComponentResponse -> DescribeTrialComponentResponse -> Bool

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

type Rep DescribeTrialComponentResponse

Defined in Amazonka.SageMaker.DescribeTrialComponent

type Rep DescribeTrialComponentResponse = D1 ('MetaData "DescribeTrialComponentResponse" "Amazonka.SageMaker.DescribeTrialComponent" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeTrialComponentResponse'" '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 "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "inputArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text TrialComponentArtifact))) :*: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext))) :*: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "lineageGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metadataProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetadataProperties)))))) :*: (((S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TrialComponentMetricSummary])) :*: S1 ('MetaSel ('Just "outputArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text TrialComponentArtifact)))) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text TrialComponentParameterValue))) :*: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrialComponentSource)) :*: S1 ('MetaSel ('Just "sources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TrialComponentSource]))))) :*: ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrialComponentStatus))) :*: (S1 ('MetaSel ('Just "trialComponentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "trialComponentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeTrialComponentResponse

Arguments

:: Int

$sel:httpStatus:DescribeTrialComponentResponse'

-> DescribeTrialComponentResponse

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

DescribeTrialComponentResponse, describeTrialComponentResponse_createdBy - Who created the trial component.

DescribeTrialComponentResponse, describeTrialComponentResponse_creationTime - When the component was created.

DescribeTrialComponentResponse, describeTrialComponentResponse_displayName - The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

DescribeTrialComponentResponse, describeTrialComponentResponse_endTime - When the component ended.

DescribeTrialComponentResponse, describeTrialComponentResponse_inputArtifacts - The input artifacts of the component.

DescribeTrialComponentResponse, describeTrialComponentResponse_lastModifiedBy - Who last modified the component.

DescribeTrialComponentResponse, describeTrialComponentResponse_lastModifiedTime - When the component was last modified.

DescribeTrialComponentResponse, describeTrialComponentResponse_lineageGroupArn - The Amazon Resource Name (ARN) of the lineage group.

DescribeTrialComponentResponse, describeTrialComponentResponse_metadataProperties - Undocumented member.

DescribeTrialComponentResponse, describeTrialComponentResponse_metrics - The metrics for the component.

DescribeTrialComponentResponse, describeTrialComponentResponse_outputArtifacts - The output artifacts of the component.

DescribeTrialComponentResponse, describeTrialComponentResponse_parameters - The hyperparameters of the component.

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

$sel:sources:DescribeTrialComponentResponse', describeTrialComponentResponse_sources - A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

DescribeTrialComponentResponse, describeTrialComponentResponse_startTime - When the component started.

DescribeTrialComponentResponse, describeTrialComponentResponse_status - The status of the component. States include:

• InProgress
• Completed
• Failed

DescribeTrialComponentResponse, describeTrialComponentResponse_trialComponentArn - The Amazon Resource Name (ARN) of the trial component.

DescribeTrialComponent, describeTrialComponentResponse_trialComponentName - The name of the trial component.

$sel:httpStatus:DescribeTrialComponentResponse', describeTrialComponentResponse_httpStatus - The response's http status code.

Response Lenses

describeTrialComponentResponse_createdBy :: Lens' DescribeTrialComponentResponse (Maybe UserContext)

Who created the trial component.

describeTrialComponentResponse_creationTime :: Lens' DescribeTrialComponentResponse (Maybe UTCTime)

When the component was created.

describeTrialComponentResponse_displayName :: Lens' DescribeTrialComponentResponse (Maybe Text)

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

describeTrialComponentResponse_endTime :: Lens' DescribeTrialComponentResponse (Maybe UTCTime)

When the component ended.

describeTrialComponentResponse_inputArtifacts :: Lens' DescribeTrialComponentResponse (Maybe (HashMap Text TrialComponentArtifact))

The input artifacts of the component.

describeTrialComponentResponse_lastModifiedBy :: Lens' DescribeTrialComponentResponse (Maybe UserContext)

Who last modified the component.

describeTrialComponentResponse_lastModifiedTime :: Lens' DescribeTrialComponentResponse (Maybe UTCTime)

When the component was last modified.

describeTrialComponentResponse_lineageGroupArn :: Lens' DescribeTrialComponentResponse (Maybe Text)

The Amazon Resource Name (ARN) of the lineage group.

describeTrialComponentResponse_metadataProperties :: Lens' DescribeTrialComponentResponse (Maybe MetadataProperties)

Undocumented member.

describeTrialComponentResponse_metrics :: Lens' DescribeTrialComponentResponse (Maybe [TrialComponentMetricSummary])

The metrics for the component.

describeTrialComponentResponse_outputArtifacts :: Lens' DescribeTrialComponentResponse (Maybe (HashMap Text TrialComponentArtifact))

The output artifacts of the component.

describeTrialComponentResponse_parameters :: Lens' DescribeTrialComponentResponse (Maybe (HashMap Text TrialComponentParameterValue))

The hyperparameters of the component.

describeTrialComponentResponse_source :: Lens' DescribeTrialComponentResponse (Maybe TrialComponentSource)

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

describeTrialComponentResponse_sources :: Lens' DescribeTrialComponentResponse (Maybe [TrialComponentSource])

A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

describeTrialComponentResponse_startTime :: Lens' DescribeTrialComponentResponse (Maybe UTCTime)

When the component started.

describeTrialComponentResponse_status :: Lens' DescribeTrialComponentResponse (Maybe TrialComponentStatus)

The status of the component. States include:

• InProgress
• Completed
• Failed

describeTrialComponentResponse_trialComponentArn :: Lens' DescribeTrialComponentResponse (Maybe Text)

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

describeTrialComponentResponse_trialComponentName :: Lens' DescribeTrialComponentResponse (Maybe Text)

The name of the trial component.

describeTrialComponentResponse_httpStatus :: Lens' DescribeTrialComponentResponse Int

The response's http status code.