Skip to content

CreateProjectVersionRequest

Source code in docs_src/capo_rekognition/types/create_project_version_request.py
class CreateProjectVersionRequest(TypedDict, closed=True):
    project_arn: "capo_rekognition.types.project_arn.ProjectArn"
    """<p>The ARN of the Amazon Rekognition project that will manage the project version you want to train.</p>"""
    version_name: "capo_rekognition.types.version_name.VersionName"
    """<p>A name for the version of the project version. This value must be unique.</p>"""
    output_config: "capo_rekognition.types.output_config.OutputConfig"
    """<p>The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need <code>s3:PutObject</code> permission on the bucket. </p>"""
    training_data: NotRequired["capo_rekognition.types.training_data.TrainingData"]
    """<p>Specifies an external manifest that the services uses to train the project version. If you specify <code>TrainingData</code> you must also specify <code>TestingData</code>. The project must not have any associated datasets. </p>"""
    testing_data: NotRequired["capo_rekognition.types.testing_data.TestingData"]
    """<p>Specifies an external manifest that the service uses to test the project version. If you specify <code>TestingData</code> you must also specify <code>TrainingData</code>. The project must not have any associated datasets.</p>"""
    tags: NotRequired["capo_rekognition.types.tag_map.TagMap"]
    """<p> A set of tags (key-value pairs) that you want to attach to the project version. </p>"""
    kms_key_id: NotRequired["capo_rekognition.types.kms_key_id.KmsKeyId"]
    """<p>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 (<code>OutputConfig</code>).</p> <p>If you choose to use your own KMS key, you need the following permissions on the KMS key.</p> <ul> <li> <p>kms:CreateGrant</p> </li> <li> <p>kms:DescribeKey</p> </li> <li> <p>kms:GenerateDataKey</p> </li> <li> <p>kms:Decrypt</p> </li> </ul> <p>If you don't specify a value for <code>KmsKeyId</code>, images copied into the service are encrypted using a key that AWS owns and manages.</p>"""
    version_description: NotRequired[
        "capo_rekognition.types.version_description.VersionDescription"
    ]
    """<p>A description applied to the project version being created.</p>"""
    feature_config: NotRequired[
        "capo_rekognition.types.customization_feature_config.CustomizationFeatureConfig"
    ]
    """<p>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.</p>"""

feature_config instance-attribute

feature_config: NotRequired[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.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

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.

output_config instance-attribute

output_config: 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.

project_arn instance-attribute

project_arn: ProjectArn

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

tags instance-attribute

tags: NotRequired[TagMap]

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

testing_data instance-attribute

testing_data: NotRequired[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.

training_data instance-attribute

training_data: NotRequired[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.

version_description instance-attribute

version_description: NotRequired[VersionDescription]

A description applied to the project version being created.

version_name instance-attribute

version_name: VersionName

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