Class: Aws::Rekognition::Types::ProjectVersionDescription

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::ProjectVersionDescription

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Overview

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #base_model_version ⇒ String

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

• #billable_training_time_in_seconds ⇒ Integer

  The duration, in seconds, that you were billed for a successful training of the model version.

• #creation_timestamp ⇒ Time

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

• #evaluation_result ⇒ Types::EvaluationResult

  The training results.

• #feature ⇒ String

  The feature that was customized.

• #feature_config ⇒ Types::CustomizationFeatureConfig

  Feature specific configuration that was applied during training.

• #kms_key_id ⇒ String

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

• #manifest_summary ⇒ Types::GroundTruthManifest

  The location of the summary manifest.

• #max_inference_units ⇒ Integer

  The maximum number of inference units Amazon Rekognition uses to auto-scale the model.

• #min_inference_units ⇒ Integer

  The minimum number of inference units used by the model.

• #output_config ⇒ Types::OutputConfig

  The location where training results are saved.

• #project_version_arn ⇒ String

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

• #source_project_version_arn ⇒ String

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

• #status ⇒ String

  The current status of the model version.

• #status_message ⇒ String

  A descriptive message for an error or warning that occurred.

• #testing_data_result ⇒ Types::TestingDataResult

  Contains information about the testing results.

• #training_data_result ⇒ Types::TrainingDataResult

  Contains information about the training results.

• #training_end_timestamp ⇒ Time

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

• #version_description ⇒ String

  A user-provided description of the project version.

Instance Attribute Details

#base_model_version ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#billable_training_time_in_seconds ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_result ⇒ Types::EvaluationResult

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

Returns:

• (Types::EvaluationResult)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#feature ⇒ String

The feature that was customized.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#feature_config ⇒ Types::CustomizationFeatureConfig

Feature specific configuration that was applied during training.

Returns:

• (Types::CustomizationFeatureConfig)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_summary ⇒ Types::GroundTruthManifest

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

Returns:

• (Types::GroundTruthManifest)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#max_inference_units ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#min_inference_units ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ Types::OutputConfig

The location where training results are saved.

Returns:

• (Types::OutputConfig)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#project_version_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#source_project_version_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the model version.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A descriptive message for an error or warning that occurred.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#testing_data_result ⇒ Types::TestingDataResult

Contains information about the testing results.

Returns:

• (Types::TestingDataResult)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#training_data_result ⇒ Types::TrainingDataResult

Contains information about the training results.

Returns:

• (Types::TrainingDataResult)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#training_end_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#version_description ⇒ String

A user-provided description of the project version.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 5941

class ProjectVersionDescription < Struct.new(
  :project_version_arn,
  :creation_timestamp,
  :min_inference_units,
  :status,
  :status_message,
  :billable_training_time_in_seconds,
  :training_end_timestamp,
  :output_config,
  :training_data_result,
  :testing_data_result,
  :evaluation_result,
  :manifest_summary,
  :kms_key_id,
  :max_inference_units,
  :source_project_version_arn,
  :version_description,
  :feature,
  :base_model_version,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end