Amazonka.LookoutVision.Types.ModelDescription

Documentation

data ModelDescription

Describes an Amazon Lookout for Vision model.

See: newModelDescription smart constructor.

Constructors

ModelDescription'

Fields

• creationTimestamp :: Maybe POSIX

  The unix timestamp for the date and time that the model was created.

• description :: Maybe Text

  The description for the model.

• evaluationEndTimestamp :: Maybe POSIX

  The unix timestamp for the date and time that the evaluation ended.

• evaluationManifest :: Maybe OutputS3Object

  The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

• evaluationResult :: Maybe OutputS3Object

  The S3 location where Amazon Lookout for Vision saves the performance metrics.

• kmsKeyId :: Maybe Text

  The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

• maxInferenceUnits :: Maybe Natural

  The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.

• minInferenceUnits :: Maybe Natural

  The minimum number of inference units used by the model. For more information, see StartModel

• modelArn :: Maybe Text

  The Amazon Resource Name (ARN) of the model.

• modelVersion :: Maybe Text

  The version of the model

• outputConfig :: Maybe OutputConfig

  The S3 location where Amazon Lookout for Vision saves model training files.

• performance :: Maybe ModelPerformance

  Performance metrics for the model. Created during training.

• status :: Maybe ModelStatus

  The status of the model.

• statusMessage :: Maybe Text

  The status message for the model.

Instances

FromJSON ModelDescription

Defined in Amazonka.LookoutVision.Types.ModelDescription

Methods

parseJSON :: Value -> Parser ModelDescription

parseJSONList :: Value -> Parser [ModelDescription]

Generic ModelDescription

Defined in Amazonka.LookoutVision.Types.ModelDescription

Associated Types

type Rep ModelDescription :: Type -> Type

Methods

from :: ModelDescription -> Rep ModelDescription x

to :: Rep ModelDescription x -> ModelDescription

Read ModelDescription

Defined in Amazonka.LookoutVision.Types.ModelDescription

Methods

readsPrec :: Int -> ReadS ModelDescription

readList :: ReadS [ModelDescription]

readPrec :: ReadPrec ModelDescription

readListPrec :: ReadPrec [ModelDescription]

Show ModelDescription

Defined in Amazonka.LookoutVision.Types.ModelDescription

Methods

showsPrec :: Int -> ModelDescription -> ShowS

show :: ModelDescription -> String

showList :: [ModelDescription] -> ShowS

NFData ModelDescription

Defined in Amazonka.LookoutVision.Types.ModelDescription

Methods

rnf :: ModelDescription -> ()

Eq ModelDescription

Defined in Amazonka.LookoutVision.Types.ModelDescription

Methods

(==) :: ModelDescription -> ModelDescription -> Bool

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

Hashable ModelDescription

Defined in Amazonka.LookoutVision.Types.ModelDescription

Methods

hashWithSalt :: Int -> ModelDescription -> Int

hash :: ModelDescription -> Int

type Rep ModelDescription

Defined in Amazonka.LookoutVision.Types.ModelDescription

type Rep ModelDescription = D1 ('MetaData "ModelDescription" "Amazonka.LookoutVision.Types.ModelDescription" "amazonka-lookoutvision-2.0-3cIJAF9xWxx8xGDY24BOkS" 'False) (C1 ('MetaCons "ModelDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "evaluationEndTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "evaluationManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputS3Object)) :*: S1 ('MetaSel ('Just "evaluationResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputS3Object))) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :*: ((S1 ('MetaSel ('Just "minInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "modelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "modelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputConfig)) :*: S1 ('MetaSel ('Just "performance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelPerformance))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :*: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newModelDescription :: ModelDescription

Create a value of ModelDescription 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:creationTimestamp:ModelDescription', modelDescription_creationTimestamp - The unix timestamp for the date and time that the model was created.

$sel:description:ModelDescription', modelDescription_description - The description for the model.

$sel:evaluationEndTimestamp:ModelDescription', modelDescription_evaluationEndTimestamp - The unix timestamp for the date and time that the evaluation ended.

$sel:evaluationManifest:ModelDescription', modelDescription_evaluationManifest - The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

$sel:evaluationResult:ModelDescription', modelDescription_evaluationResult - The S3 location where Amazon Lookout for Vision saves the performance metrics.

$sel:kmsKeyId:ModelDescription', modelDescription_kmsKeyId - The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

$sel:maxInferenceUnits:ModelDescription', modelDescription_maxInferenceUnits - The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.

$sel:minInferenceUnits:ModelDescription', modelDescription_minInferenceUnits - The minimum number of inference units used by the model. For more information, see StartModel

$sel:modelArn:ModelDescription', modelDescription_modelArn - The Amazon Resource Name (ARN) of the model.

$sel:modelVersion:ModelDescription', modelDescription_modelVersion - The version of the model

$sel:outputConfig:ModelDescription', modelDescription_outputConfig - The S3 location where Amazon Lookout for Vision saves model training files.

$sel:performance:ModelDescription', modelDescription_performance - Performance metrics for the model. Created during training.

$sel:status:ModelDescription', modelDescription_status - The status of the model.

$sel:statusMessage:ModelDescription', modelDescription_statusMessage - The status message for the model.

modelDescription_creationTimestamp :: Lens' ModelDescription (Maybe UTCTime)

The unix timestamp for the date and time that the model was created.

modelDescription_description :: Lens' ModelDescription (Maybe Text)

The description for the model.

modelDescription_evaluationEndTimestamp :: Lens' ModelDescription (Maybe UTCTime)

The unix timestamp for the date and time that the evaluation ended.

modelDescription_evaluationManifest :: Lens' ModelDescription (Maybe OutputS3Object)

The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

modelDescription_evaluationResult :: Lens' ModelDescription (Maybe OutputS3Object)

The S3 location where Amazon Lookout for Vision saves the performance metrics.

modelDescription_kmsKeyId :: Lens' ModelDescription (Maybe Text)

The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

modelDescription_maxInferenceUnits :: Lens' ModelDescription (Maybe Natural)

The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.

modelDescription_minInferenceUnits :: Lens' ModelDescription (Maybe Natural)

The minimum number of inference units used by the model. For more information, see StartModel

modelDescription_modelArn :: Lens' ModelDescription (Maybe Text)

The Amazon Resource Name (ARN) of the model.

modelDescription_modelVersion :: Lens' ModelDescription (Maybe Text)

The version of the model

modelDescription_outputConfig :: Lens' ModelDescription (Maybe OutputConfig)

The S3 location where Amazon Lookout for Vision saves model training files.

modelDescription_performance :: Lens' ModelDescription (Maybe ModelPerformance)

Performance metrics for the model. Created during training.

modelDescription_status :: Lens' ModelDescription (Maybe ModelStatus)

The status of the model.

modelDescription_statusMessage :: Lens' ModelDescription (Maybe Text)

The status message for the model.