Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Rekognition.Types.ProjectVersionDescription

Description

Synopsis

Documentation

data ProjectVersionDescription Source #

A description of a version of an Amazon Rekognition Custom Labels model.

See: newProjectVersionDescription smart constructor.

Constructors

ProjectVersionDescription'

Fields

billableTrainingTimeInSeconds :: Maybe Natural
The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.
creationTimestamp :: Maybe POSIX
The Unix datetime for the date and time that training started.
evaluationResult :: Maybe EvaluationResult
The training results. EvaluationResult is only returned if training is successful.
kmsKeyId :: Maybe Text
The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
manifestSummary :: Maybe GroundTruthManifest
The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.
maxInferenceUnits :: Maybe Natural
The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.
minInferenceUnits :: Maybe Natural
The minimum number of inference units used by the model. For more information, see StartProjectVersion.
outputConfig :: Maybe OutputConfig
The location where training results are saved.
projectVersionArn :: Maybe Text
The Amazon Resource Name (ARN) of the model version.
sourceProjectVersionArn :: Maybe Text
If the model version was copied from a different project, SourceProjectVersionArn contains the ARN of the source model version.
status :: Maybe ProjectVersionStatus
The current status of the model version.
statusMessage :: Maybe Text
A descriptive message for an error or warning that occurred.
testingDataResult :: Maybe TestingDataResult
Contains information about the testing results.
trainingDataResult :: Maybe TrainingDataResult
Contains information about the training results.
trainingEndTimestamp :: Maybe POSIX
The Unix date and time that training of the model ended.

Instances

Instances details

FromJSON ProjectVersionDescription Source #
Instance details Defined in Amazonka.Rekognition.Types.ProjectVersionDescription Methods parseJSON :: Value -> Parser ProjectVersionDescription # parseJSONList :: Value -> Parser [ProjectVersionDescription] #
Generic ProjectVersionDescription Source #
Instance details Defined in Amazonka.Rekognition.Types.ProjectVersionDescription Associated Types type Rep ProjectVersionDescription :: Type -> Type # Methods from :: ProjectVersionDescription -> Rep ProjectVersionDescription x # to :: Rep ProjectVersionDescription x -> ProjectVersionDescription #
Read ProjectVersionDescription Source #
Instance details Defined in Amazonka.Rekognition.Types.ProjectVersionDescription Methods readsPrec :: Int -> ReadS ProjectVersionDescription # readList :: ReadS [ProjectVersionDescription] # readPrec :: ReadPrec ProjectVersionDescription # readListPrec :: ReadPrec [ProjectVersionDescription] #
Show ProjectVersionDescription Source #
Instance details Defined in Amazonka.Rekognition.Types.ProjectVersionDescription Methods showsPrec :: Int -> ProjectVersionDescription -> ShowS # show :: ProjectVersionDescription -> String # showList :: [ProjectVersionDescription] -> ShowS #
NFData ProjectVersionDescription Source #
Instance details Defined in Amazonka.Rekognition.Types.ProjectVersionDescription Methods rnf :: ProjectVersionDescription -> () #
Eq ProjectVersionDescription Source #
Instance details Defined in Amazonka.Rekognition.Types.ProjectVersionDescription Methods (==) :: ProjectVersionDescription -> ProjectVersionDescription -> Bool # (/=) :: ProjectVersionDescription -> ProjectVersionDescription -> Bool #
Hashable ProjectVersionDescription Source #
Instance details Defined in Amazonka.Rekognition.Types.ProjectVersionDescription Methods hashWithSalt :: Int -> ProjectVersionDescription -> Int # hash :: ProjectVersionDescription -> Int #
type Rep ProjectVersionDescription Source #
Instance details Defined in Amazonka.Rekognition.Types.ProjectVersionDescription type Rep ProjectVersionDescription = D1 ('MetaData "ProjectVersionDescription" "Amazonka.Rekognition.Types.ProjectVersionDescription" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "ProjectVersionDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "billableTrainingTimeInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "evaluationResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationResult)))) :: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "manifestSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GroundTruthManifest))) :: (S1 ('MetaSel ('Just "maxInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "minInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: (((S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputConfig)) :: S1 ('MetaSel ('Just "projectVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sourceProjectVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectVersionStatus)))) :: ((S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "testingDataResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TestingDataResult))) :: (S1 ('MetaSel ('Just "trainingDataResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrainingDataResult)) :: S1 ('MetaSel ('Just "trainingEndTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newProjectVersionDescription :: ProjectVersionDescription Source #

Create a value of ProjectVersionDescription 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:billableTrainingTimeInSeconds:ProjectVersionDescription', projectVersionDescription_billableTrainingTimeInSeconds - The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.

$sel:creationTimestamp:ProjectVersionDescription', projectVersionDescription_creationTimestamp - The Unix datetime for the date and time that training started.

$sel:evaluationResult:ProjectVersionDescription', projectVersionDescription_evaluationResult - The training results. EvaluationResult is only returned if training is successful.

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

$sel:manifestSummary:ProjectVersionDescription', projectVersionDescription_manifestSummary - The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.

$sel:maxInferenceUnits:ProjectVersionDescription', projectVersionDescription_maxInferenceUnits - The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.

$sel:minInferenceUnits:ProjectVersionDescription', projectVersionDescription_minInferenceUnits - The minimum number of inference units used by the model. For more information, see StartProjectVersion.

$sel:outputConfig:ProjectVersionDescription', projectVersionDescription_outputConfig - The location where training results are saved.

$sel:projectVersionArn:ProjectVersionDescription', projectVersionDescription_projectVersionArn - The Amazon Resource Name (ARN) of the model version.

$sel:sourceProjectVersionArn:ProjectVersionDescription', projectVersionDescription_sourceProjectVersionArn - If the model version was copied from a different project, SourceProjectVersionArn contains the ARN of the source model version.

$sel:status:ProjectVersionDescription', projectVersionDescription_status - The current status of the model version.

$sel:statusMessage:ProjectVersionDescription', projectVersionDescription_statusMessage - A descriptive message for an error or warning that occurred.

$sel:testingDataResult:ProjectVersionDescription', projectVersionDescription_testingDataResult - Contains information about the testing results.

$sel:trainingDataResult:ProjectVersionDescription', projectVersionDescription_trainingDataResult - Contains information about the training results.

$sel:trainingEndTimestamp:ProjectVersionDescription', projectVersionDescription_trainingEndTimestamp - The Unix date and time that training of the model ended.

projectVersionDescription_billableTrainingTimeInSeconds :: Lens' ProjectVersionDescription (Maybe Natural) Source #

The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.

projectVersionDescription_creationTimestamp :: Lens' ProjectVersionDescription (Maybe UTCTime) Source #

The Unix datetime for the date and time that training started.

projectVersionDescription_evaluationResult :: Lens' ProjectVersionDescription (Maybe EvaluationResult) Source #

The training results. EvaluationResult is only returned if training is successful.

projectVersionDescription_kmsKeyId :: Lens' ProjectVersionDescription (Maybe Text) Source #

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

projectVersionDescription_manifestSummary :: Lens' ProjectVersionDescription (Maybe GroundTruthManifest) Source #

The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.

projectVersionDescription_maxInferenceUnits :: Lens' ProjectVersionDescription (Maybe Natural) Source #

The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.

projectVersionDescription_minInferenceUnits :: Lens' ProjectVersionDescription (Maybe Natural) Source #

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

projectVersionDescription_outputConfig :: Lens' ProjectVersionDescription (Maybe OutputConfig) Source #

The location where training results are saved.

projectVersionDescription_projectVersionArn :: Lens' ProjectVersionDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model version.

projectVersionDescription_sourceProjectVersionArn :: Lens' ProjectVersionDescription (Maybe Text) Source #

If the model version was copied from a different project, SourceProjectVersionArn contains the ARN of the source model version.

projectVersionDescription_status :: Lens' ProjectVersionDescription (Maybe ProjectVersionStatus) Source #

The current status of the model version.

projectVersionDescription_statusMessage :: Lens' ProjectVersionDescription (Maybe Text) Source #

A descriptive message for an error or warning that occurred.

projectVersionDescription_testingDataResult :: Lens' ProjectVersionDescription (Maybe TestingDataResult) Source #

Contains information about the testing results.

projectVersionDescription_trainingDataResult :: Lens' ProjectVersionDescription (Maybe TrainingDataResult) Source #

Contains information about the training results.

projectVersionDescription_trainingEndTimestamp :: Lens' ProjectVersionDescription (Maybe UTCTime) Source #

The Unix date and time that training of the model ended.