Interface ProjectVersionDescription

A description of a version of a Amazon Rekognition project version.

interface ProjectVersionDescription {
    BaseModelVersion?: string;
    BillableTrainingTimeInSeconds?: number;
    CreationTimestamp?: Date;
    EvaluationResult?: EvaluationResult;
    Feature?: CustomizationFeature;
    FeatureConfig?: CustomizationFeatureConfig;
    KmsKeyId?: string;
    ManifestSummary?: GroundTruthManifest;
    MaxInferenceUnits?: number;
    MinInferenceUnits?: number;
    OutputConfig?: OutputConfig;
    ProjectVersionArn?: string;
    SourceProjectVersionArn?: string;
    Status?: ProjectVersionStatus;
    StatusMessage?: string;
    TestingDataResult?: TestingDataResult;
    TrainingDataResult?: TrainingDataResult;
    TrainingEndTimestamp?: Date;
    VersionDescription?: string;
}

Properties

BaseModelVersion? BillableTrainingTimeInSeconds? CreationTimestamp? EvaluationResult? Feature? FeatureConfig? KmsKeyId? ManifestSummary? MaxInferenceUnits? MinInferenceUnits? OutputConfig? ProjectVersionArn? SourceProjectVersionArn? Status? StatusMessage? TestingDataResult? TrainingDataResult? TrainingEndTimestamp? VersionDescription?

Properties

Optional BaseModelVersion

BaseModelVersion?: string

The base detection model version used to create the project version.

Optional BillableTrainingTimeInSeconds

BillableTrainingTimeInSeconds?: number

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.

Optional CreationTimestamp

CreationTimestamp?: Date

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

Optional EvaluationResult

EvaluationResult?: EvaluationResult

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

Optional Feature

Feature?: CustomizationFeature

The feature that was customized.

Optional FeatureConfig

FeatureConfig?: CustomizationFeatureConfig

Feature specific configuration that was applied during training.

Optional KmsKeyId

KmsKeyId?: string

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

Optional ManifestSummary

ManifestSummary?: GroundTruthManifest

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

Optional MaxInferenceUnits

MaxInferenceUnits?: number

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

Optional MinInferenceUnits

MinInferenceUnits?: number

The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.

Optional OutputConfig

OutputConfig?: OutputConfig

The location where training results are saved.

Optional ProjectVersionArn

ProjectVersionArn?: string

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

Optional SourceProjectVersionArn

SourceProjectVersionArn?: string

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

Optional Status

Status?: ProjectVersionStatus

The current status of the model version.

Optional StatusMessage

StatusMessage?: string

A descriptive message for an error or warning that occurred.

Optional TestingDataResult

TestingDataResult?: TestingDataResult

Contains information about the testing results.

Optional TrainingDataResult

TrainingDataResult?: TrainingDataResult

Contains information about the training results.

Optional TrainingEndTimestamp

TrainingEndTimestamp?: Date

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

Optional VersionDescription

VersionDescription?: string

A user-provided description of the project version.

Settings

Member Visibility

Theme

On This Page