AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as part of a Rekognition project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the project version.

The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

The following applies only to projects with Amazon Rekognition Custom Labels as the chosen feature:

You can train a model in a project that doesn't have associated datasets by specifying manifest files in the TrainingData and TestingData fields.

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files.

Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateProjectVersionAsync.

Namespace: Amazon.Rekognition
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

C#
public virtual CreateProjectVersionResponse CreateProjectVersion(
         CreateProjectVersionRequest request
)

Parameters

request
Type: Amazon.Rekognition.Model.CreateProjectVersionRequest

Container for the necessary parameters to execute the CreateProjectVersion service method.

Return Value


The response from the CreateProjectVersion service method, as returned by Rekognition.

Exceptions

ExceptionCondition
AccessDeniedException You are not authorized to perform the action.
InternalServerErrorException Amazon Rekognition experienced a service issue. Try your call again.
InvalidParameterException Input parameter violated a constraint. Validate your parameter before calling the API operation again.
LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.
ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
ResourceInUseException The specified resource is already being used.
ResourceNotFoundException The resource specified in the request cannot be found.
ServiceQuotaExceededException The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
ThrottlingException Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

Trains a version of an Amazon Rekognition Custom Labels model.

To train an Amazon Rekognition Custom Labels model


var client = new AmazonRekognitionClient();
var response = client.CreateProjectVersion(new CreateProjectVersionRequest 
{
    OutputConfig = new OutputConfig {
        S3Bucket = "output_bucket",
        S3KeyPrefix = "output_folder"
    },
    ProjectArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815",
    VersionName = "1"
});

string projectVersionArn = response.ProjectVersionArn;

            

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also