Skip to content

ProjectVersionDescription

Source code in docs_src/capo_rekognition/types/project_version_description.py
class ProjectVersionDescription(TypedDict, closed=True):
    project_version_arn: NotRequired[
        "capo_rekognition.types.project_version_arn.ProjectVersionArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the project version. </p>"""
    creation_timestamp: NotRequired["capo_rekognition.types.date_time.DateTime"]
    """<p>The Unix datetime for the date and time that training started.</p>"""
    min_inference_units: NotRequired[
        "capo_rekognition.types.inference_units.InferenceUnits"
    ]
    """<p>The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see <a>StartProjectVersion</a>.</p>"""
    status: NotRequired[
        "capo_rekognition.types.project_version_status.ProjectVersionStatus"
    ]
    """<p>The current status of the model version.</p>"""
    status_message: NotRequired["capo_rekognition.types.status_message.StatusMessage"]
    """<p>A descriptive message for an error or warning that occurred.</p>"""
    billable_training_time_in_seconds: NotRequired[
        "capo_rekognition.types.u_long.ULong"
    ]
    """<p>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.</p>"""
    training_end_timestamp: NotRequired["capo_rekognition.types.date_time.DateTime"]
    """<p>The Unix date and time that training of the model ended.</p>"""
    output_config: NotRequired["capo_rekognition.types.output_config.OutputConfig"]
    """<p>The location where training results are saved.</p>"""
    training_data_result: NotRequired[
        "capo_rekognition.types.training_data_result.TrainingDataResult"
    ]
    """<p>Contains information about the training results.</p>"""
    testing_data_result: NotRequired[
        "capo_rekognition.types.testing_data_result.TestingDataResult"
    ]
    """<p>Contains information about the testing results.</p>"""
    evaluation_result: NotRequired[
        "capo_rekognition.types.evaluation_result.EvaluationResult"
    ]
    """<p>The training results. <code>EvaluationResult</code> is only returned if training is successful.</p>"""
    manifest_summary: NotRequired[
        "capo_rekognition.types.ground_truth_manifest.GroundTruthManifest"
    ]
    """<p>The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.</p>"""
    kms_key_id: NotRequired["capo_rekognition.types.kms_key_id.KmsKeyId"]
    """<p>The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training. </p>"""
    max_inference_units: NotRequired[
        "capo_rekognition.types.inference_units.InferenceUnits"
    ]
    """<p>The maximum number of inference units Amazon Rekognition uses to auto-scale the model. Applies only to Custom Labels projects. For more information, see <a>StartProjectVersion</a>.</p>"""
    source_project_version_arn: NotRequired[
        "capo_rekognition.types.project_version_arn.ProjectVersionArn"
    ]
    """<p>If the model version was copied from a different project, <code>SourceProjectVersionArn</code> contains the ARN of the source model version. </p>"""
    version_description: NotRequired[
        "capo_rekognition.types.version_description.VersionDescription"
    ]
    """<p>A user-provided description of the project version.</p>"""
    feature: NotRequired[
        "capo_rekognition.types.customization_feature.CustomizationFeature"
    ]
    """<p>The feature that was customized.</p>"""
    base_model_version: NotRequired["capo_rekognition.types.string.String"]
    """<p>The base detection model version used to create the project version.</p>"""
    feature_config: NotRequired[
        "capo_rekognition.types.customization_feature_config.CustomizationFeatureConfig"
    ]
    """<p>Feature specific configuration that was applied during training.</p>"""

base_model_version instance-attribute

base_model_version: NotRequired[String]

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

billable_training_time_in_seconds instance-attribute

billable_training_time_in_seconds: NotRequired[ULong]

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.

creation_timestamp instance-attribute

creation_timestamp: NotRequired[DateTime]

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

evaluation_result instance-attribute

evaluation_result: NotRequired[EvaluationResult]

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

feature instance-attribute

feature: NotRequired[CustomizationFeature]

The feature that was customized.

feature_config instance-attribute

feature_config: NotRequired[CustomizationFeatureConfig]

Feature specific configuration that was applied during training.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

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

manifest_summary instance-attribute

manifest_summary: NotRequired[GroundTruthManifest]

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

max_inference_units instance-attribute

max_inference_units: NotRequired[InferenceUnits]

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.

min_inference_units instance-attribute

min_inference_units: NotRequired[InferenceUnits]

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

output_config instance-attribute

output_config: NotRequired[OutputConfig]

The location where training results are saved.

project_version_arn instance-attribute

project_version_arn: NotRequired[ProjectVersionArn]

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

source_project_version_arn instance-attribute

source_project_version_arn: NotRequired[ProjectVersionArn]

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

status instance-attribute

status: NotRequired[ProjectVersionStatus]

The current status of the model version.

status_message instance-attribute

status_message: NotRequired[StatusMessage]

A descriptive message for an error or warning that occurred.

testing_data_result instance-attribute

testing_data_result: NotRequired[TestingDataResult]

Contains information about the testing results.

training_data_result instance-attribute

training_data_result: NotRequired[TrainingDataResult]

Contains information about the training results.

training_end_timestamp instance-attribute

training_end_timestamp: NotRequired[DateTime]

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

version_description instance-attribute

version_description: NotRequired[VersionDescription]

A user-provided description of the project version.