Start Project Version

rekognition_start_project_version

R Documentation

This operation applies only to Amazon Rekognition Custom Labels¶

Description¶

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 describe_project_versions.

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

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

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

Usage¶

rekognition_start_project_version(ProjectVersionArn, MinInferenceUnits,
  MaxInferenceUnits)

Arguments¶

ProjectVersionArn

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

MinInferenceUnits

[required] 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.

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.

Value¶

A list with the following syntax:

list(
  Status = "TRAINING_IN_PROGRESS"|"TRAINING_COMPLETED"|"TRAINING_FAILED"|"STARTING"|"RUNNING"|"FAILED"|"STOPPING"|"STOPPED"|"DELETING"|"COPYING_IN_PROGRESS"|"COPYING_COMPLETED"|"COPYING_FAILED"|"DEPRECATED"|"EXPIRED"
)

Request syntax¶

svc$start_project_version(
  ProjectVersionArn = "string",
  MinInferenceUnits = 123,
  MaxInferenceUnits = 123
)

Examples¶

## Not run: 
# Starts a version of an Amazon Rekognition Custom Labels model.
svc$start_project_version(
  MaxInferenceUnits = 1L,
  MinInferenceUnits = 1L,
  ProjectVersionArn = "arn:aws:rekognition:us-east-1:111122223333:project/m..."
)

## End(Not run)