Amazonka.SageMaker.Types.TrialComponent

Documentation

data TrialComponent

The properties of a trial component as returned by the Search API.

See: newTrialComponent smart constructor.

Constructors

TrialComponent'

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
• lastModifiedTime :: Maybe POSIX

  When the component was last modified.

• lineageGroupArn :: Maybe Text

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

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

• parents :: Maybe [Parent]

  An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

• runName :: Maybe Text

  The name of the experiment run.

• source :: Maybe TrialComponentSource

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

• sourceDetail :: Maybe TrialComponentSourceDetail

  Details of the source of the component.

• startTime :: Maybe POSIX

  When the component started.

• status :: Maybe TrialComponentStatus
• tags :: Maybe [Tag]

  The list of tags that are associated with the component. You can use Search API to search on the tags.

• trialComponentArn :: Maybe Text

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

• trialComponentName :: Maybe Text

  The name of the trial component.

Instances

FromJSON TrialComponent

Defined in Amazonka.SageMaker.Types.TrialComponent

Methods

parseJSON :: Value -> Parser TrialComponent

parseJSONList :: Value -> Parser [TrialComponent]

Generic TrialComponent

Defined in Amazonka.SageMaker.Types.TrialComponent

Associated Types

type Rep TrialComponent :: Type -> Type

Methods

from :: TrialComponent -> Rep TrialComponent x

to :: Rep TrialComponent x -> TrialComponent

Read TrialComponent

Defined in Amazonka.SageMaker.Types.TrialComponent

Methods

readsPrec :: Int -> ReadS TrialComponent

readList :: ReadS [TrialComponent]

readPrec :: ReadPrec TrialComponent

readListPrec :: ReadPrec [TrialComponent]

Show TrialComponent

Defined in Amazonka.SageMaker.Types.TrialComponent

Methods

showsPrec :: Int -> TrialComponent -> ShowS

show :: TrialComponent -> String

showList :: [TrialComponent] -> ShowS

NFData TrialComponent

Defined in Amazonka.SageMaker.Types.TrialComponent

Methods

rnf :: TrialComponent -> ()

Eq TrialComponent

Defined in Amazonka.SageMaker.Types.TrialComponent

Methods

(==) :: TrialComponent -> TrialComponent -> Bool

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

Hashable TrialComponent

Defined in Amazonka.SageMaker.Types.TrialComponent

Methods

hashWithSalt :: Int -> TrialComponent -> Int

hash :: TrialComponent -> Int

type Rep TrialComponent

Defined in Amazonka.SageMaker.Types.TrialComponent

type Rep TrialComponent = D1 ('MetaData "TrialComponent" "Amazonka.SageMaker.Types.TrialComponent" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "TrialComponent'" '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 "parents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parent])) :*: (S1 ('MetaSel ('Just "runName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrialComponentSource))))) :*: ((S1 ('MetaSel ('Just "sourceDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrialComponentSourceDetail)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrialComponentStatus)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "trialComponentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "trialComponentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newTrialComponent :: TrialComponent

Create a value of TrialComponent 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:createdBy:TrialComponent', trialComponent_createdBy - Who created the trial component.

$sel:creationTime:TrialComponent', trialComponent_creationTime - When the component was created.

$sel:displayName:TrialComponent', trialComponent_displayName - The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

$sel:endTime:TrialComponent', trialComponent_endTime - When the component ended.

$sel:inputArtifacts:TrialComponent', trialComponent_inputArtifacts - The input artifacts of the component.

$sel:lastModifiedBy:TrialComponent', trialComponent_lastModifiedBy - Undocumented member.

$sel:lastModifiedTime:TrialComponent', trialComponent_lastModifiedTime - When the component was last modified.

$sel:lineageGroupArn:TrialComponent', trialComponent_lineageGroupArn - The Amazon Resource Name (ARN) of the lineage group resource.

$sel:metadataProperties:TrialComponent', trialComponent_metadataProperties - Undocumented member.

$sel:metrics:TrialComponent', trialComponent_metrics - The metrics for the component.

$sel:outputArtifacts:TrialComponent', trialComponent_outputArtifacts - The output artifacts of the component.

$sel:parameters:TrialComponent', trialComponent_parameters - The hyperparameters of the component.

$sel:parents:TrialComponent', trialComponent_parents - An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

$sel:runName:TrialComponent', trialComponent_runName - The name of the experiment run.

$sel:source:TrialComponent', trialComponent_source - The Amazon Resource Name (ARN) and job type of the source of the component.

$sel:sourceDetail:TrialComponent', trialComponent_sourceDetail - Details of the source of the component.

$sel:startTime:TrialComponent', trialComponent_startTime - When the component started.

$sel:status:TrialComponent', trialComponent_status - Undocumented member.

$sel:tags:TrialComponent', trialComponent_tags - The list of tags that are associated with the component. You can use Search API to search on the tags.

$sel:trialComponentArn:TrialComponent', trialComponent_trialComponentArn - The Amazon Resource Name (ARN) of the trial component.

$sel:trialComponentName:TrialComponent', trialComponent_trialComponentName - The name of the trial component.

trialComponent_createdBy :: Lens' TrialComponent (Maybe UserContext)

Who created the trial component.

trialComponent_creationTime :: Lens' TrialComponent (Maybe UTCTime)

When the component was created.

trialComponent_displayName :: Lens' TrialComponent (Maybe Text)

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

trialComponent_endTime :: Lens' TrialComponent (Maybe UTCTime)

When the component ended.

trialComponent_inputArtifacts :: Lens' TrialComponent (Maybe (HashMap Text TrialComponentArtifact))

The input artifacts of the component.

trialComponent_lastModifiedBy :: Lens' TrialComponent (Maybe UserContext)

Undocumented member.

trialComponent_lastModifiedTime :: Lens' TrialComponent (Maybe UTCTime)

When the component was last modified.

trialComponent_lineageGroupArn :: Lens' TrialComponent (Maybe Text)

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

trialComponent_metadataProperties :: Lens' TrialComponent (Maybe MetadataProperties)

Undocumented member.

trialComponent_metrics :: Lens' TrialComponent (Maybe [TrialComponentMetricSummary])

The metrics for the component.

trialComponent_outputArtifacts :: Lens' TrialComponent (Maybe (HashMap Text TrialComponentArtifact))

The output artifacts of the component.

trialComponent_parameters :: Lens' TrialComponent (Maybe (HashMap Text TrialComponentParameterValue))

The hyperparameters of the component.

trialComponent_parents :: Lens' TrialComponent (Maybe [Parent])

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

trialComponent_runName :: Lens' TrialComponent (Maybe Text)

The name of the experiment run.

trialComponent_source :: Lens' TrialComponent (Maybe TrialComponentSource)

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

trialComponent_sourceDetail :: Lens' TrialComponent (Maybe TrialComponentSourceDetail)

Details of the source of the component.

trialComponent_startTime :: Lens' TrialComponent (Maybe UTCTime)

When the component started.

trialComponent_status :: Lens' TrialComponent (Maybe TrialComponentStatus)

Undocumented member.

trialComponent_tags :: Lens' TrialComponent (Maybe [Tag])

The list of tags that are associated with the component. You can use Search API to search on the tags.

trialComponent_trialComponentArn :: Lens' TrialComponent (Maybe Text)

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

trialComponent_trialComponentName :: Lens' TrialComponent (Maybe Text)

The name of the trial component.