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.

Container for the parameters to the StartProjectVersion operation.

This operation applies only to Amazon Rekognition Custom Labels.

Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.

Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.

You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.StartProjectVersionRequest

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

Syntax

C#
public class StartProjectVersionRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The StartProjectVersionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property MaxInferenceUnits System.Int32

Gets and sets the property MaxInferenceUnits.

The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.

Public Property MinInferenceUnits System.Int32

Gets and sets the property MinInferenceUnits.

The minimum number of inference units to use. A single inference unit represents 1 hour of processing.

Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

Public Property ProjectVersionArn System.String

Gets and sets the property ProjectVersionArn.

The Amazon Resource Name(ARN) of the model version that you want to start.

Examples

Starts a version of an Amazon Rekognition Custom Labels model.

To start an Amazon Rekognition Custom Labels model


var client = new AmazonRekognitionClient();
var response = client.StartProjectVersion(new StartProjectVersionRequest 
{
    MaxInferenceUnits = 1,
    MinInferenceUnits = 1,
    ProjectVersionArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
});

string status = response.Status;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

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