ProjectVersionDescription - Amazon Rekognition

ProjectVersionDescription

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

Contents

BaseModelVersion

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

Type: String

Required: No

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.

Type: Long

Valid Range: Minimum value of 0.

Required: No

CreationTimestamp

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

Type: Timestamp

Required: No

EvaluationResult

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

Type: EvaluationResult object

Required: No

Feature

The feature that was customized.

Type: String

Valid Values: CONTENT_MODERATION | CUSTOM_LABELS

Required: No

FeatureConfig

Feature specific configuration that was applied during training.

Type: CustomizationFeatureConfig object

Required: No

KmsKeyId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

Required: No

ManifestSummary

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

Type: GroundTruthManifest object

Required: No

MaxInferenceUnits

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

MinInferenceUnits

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

OutputConfig

The location where training results are saved.

Type: OutputConfig object

Required: No

ProjectVersionArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

Required: No

SourceProjectVersionArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

Required: No

Status

The current status of the model version.

Type: String

Valid Values: TRAINING_IN_PROGRESS | TRAINING_COMPLETED | TRAINING_FAILED | STARTING | RUNNING | FAILED | STOPPING | STOPPED | DELETING | COPYING_IN_PROGRESS | COPYING_COMPLETED | COPYING_FAILED | DEPRECATED | EXPIRED

Required: No

StatusMessage

A descriptive message for an error or warning that occurred.

Type: String

Required: No

TestingDataResult

Contains information about the testing results.

Type: TestingDataResult object

Required: No

TrainingDataResult

Contains information about the training results.

Type: TrainingDataResult object

Required: No

TrainingEndTimestamp

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

Type: Timestamp

Required: No

VersionDescription

A user-provided description of the project version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9-_. ()':,;?]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: