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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#base_model_versionString

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

Returns:

  • (String)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_secondsInteger

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)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_timestampTime

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

Returns:

  • (Time)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_resultTypes::EvaluationResult

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



5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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

#featureString

The feature that was customized.

Returns:

  • (String)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_configTypes::CustomizationFeatureConfig

Feature specific configuration that was applied during training.



5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_idString

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

Returns:

  • (String)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_summaryTypes::GroundTruthManifest

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



5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_unitsInteger

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)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_unitsInteger

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

Returns:

  • (Integer)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_configTypes::OutputConfig

The location where training results are saved.

Returns:



5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_arnString

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

Returns:

  • (String)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_arnString

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

Returns:

  • (String)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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

#statusString

The current status of the model version.

Returns:

  • (String)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_messageString

A descriptive message for an error or warning that occurred.

Returns:

  • (String)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_resultTypes::TestingDataResult

Contains information about the testing results.



5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_resultTypes::TrainingDataResult

Contains information about the training results.



5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_timestampTime

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

Returns:

  • (Time)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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_descriptionString

A user-provided description of the project version.

Returns:

  • (String)


5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5866

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