Class: Aws::Rekognition::Types::CreateProjectVersionRequest

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#feature_config ⇒ Types::CustomizationFeatureConfig

Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.

Returns:



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1096

class CreateProjectVersionRequest < Struct.new(
  :project_arn,
  :version_name,
  :output_config,
  :training_data,
  :testing_data,
  :tags,
  :kms_key_id,
  :version_description,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

If you choose to use your own KMS key, you need the following permissions on the KMS key.

  • kms:CreateGrant

  • kms:DescribeKey

  • kms:GenerateDataKey

  • kms:Decrypt

If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

Returns:

  • (String) 


1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1096

class CreateProjectVersionRequest < Struct.new(
  :project_arn,
  :version_name,
  :output_config,
  :training_data,
  :testing_data,
  :tags,
  :kms_key_id,
  :version_description,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ Types::OutputConfig

The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject permission on the bucket.

Returns:



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1096

class CreateProjectVersionRequest < Struct.new(
  :project_arn,
  :version_name,
  :output_config,
  :training_data,
  :testing_data,
  :tags,
  :kms_key_id,
  :version_description,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#project_arn ⇒ String

The ARN of the Amazon Rekognition project that will manage the project version you want to train.

Returns:

  • (String) 


1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1096

class CreateProjectVersionRequest < Struct.new(
  :project_arn,
  :version_name,
  :output_config,
  :training_data,
  :testing_data,
  :tags,
  :kms_key_id,
  :version_description,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A set of tags (key-value pairs) that you want to attach to the project version.

Returns:

  • (Hash<String,String>) 


1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1096

class CreateProjectVersionRequest < Struct.new(
  :project_arn,
  :version_name,
  :output_config,
  :training_data,
  :testing_data,
  :tags,
  :kms_key_id,
  :version_description,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#testing_data ⇒ Types::TestingData

Specifies an external manifest that the service uses to test the project version. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.

Returns:



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1096

class CreateProjectVersionRequest < Struct.new(
  :project_arn,
  :version_name,
  :output_config,
  :training_data,
  :testing_data,
  :tags,
  :kms_key_id,
  :version_description,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#training_data ⇒ Types::TrainingData

Specifies an external manifest that the services uses to train the project version. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.

Returns:



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1096

class CreateProjectVersionRequest < Struct.new(
  :project_arn,
  :version_name,
  :output_config,
  :training_data,
  :testing_data,
  :tags,
  :kms_key_id,
  :version_description,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#version_description ⇒ String

A description applied to the project version being created.

Returns:

  • (String) 


1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1096

class CreateProjectVersionRequest < Struct.new(
  :project_arn,
  :version_name,
  :output_config,
  :training_data,
  :testing_data,
  :tags,
  :kms_key_id,
  :version_description,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end

#version_name ⇒ String

A name for the version of the project version. This value must be unique.

Returns:

  • (String) 


1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1096

class CreateProjectVersionRequest < Struct.new(
  :project_arn,
  :version_name,
  :output_config,
  :training_data,
  :testing_data,
  :tags,
  :kms_key_id,
  :version_description,
  :feature_config)
  SENSITIVE = []
  include Aws::Structure
end