CreateProjectVersion
Creates a new version of a model and begins training.
Models are managed as part of an Amazon Rekognition Custom Labels project.
The response from CreateProjectVersion
is an Amazon Resource Name (ARN) for the version of the model.
Training uses the training and test datasets associated with the project. For more information, see Creating training and test datasets.
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.
Training takes 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
.
If training fails, see Debugging a failed model training.
Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model.
After evaluating the model, you start the model by calling StartProjectVersion.
This operation requires permissions to perform the rekognition:CreateProjectVersion
action.
Request Syntax
{
"KmsKeyId": "string
",
"OutputConfig": {
"S3Bucket": "string
",
"S3KeyPrefix": "string
"
},
"ProjectArn": "string
",
"Tags": {
"string
" : "string
"
},
"TestingData": {
"Assets": [
{
"GroundTruthManifest": {
"S3Object": {
"Bucket": "string
",
"Name": "string
",
"Version": "string
"
}
}
}
],
"AutoCreate": boolean
},
"TrainingData": {
"Assets": [
{
"GroundTruthManifest": {
"S3Object": {
"Bucket": "string
",
"Name": "string
",
"Version": "string
"
}
}
}
]
},
"VersionName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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 and test images copied into the service for model training. 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
Required: No
-
- OutputConfig
-
The Amazon S3 bucket location to store the results of training. The S3 bucket can be in any AWS account as long as the caller has
s3:PutObject
permissions on the S3 bucket.Type: OutputConfig object
Required: Yes
- ProjectArn
-
The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)
Required: Yes
- Tags
-
A set of tags (key-value pairs) that you want to attach to the model.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Required: No
- TestingData
-
Specifies an external manifest that the service uses to test the model. If you specify
TestingData
you must also specifyTrainingData
. The project must not have any associated datasets.Type: TestingData object
Required: No
- TrainingData
-
Specifies an external manifest that the services uses to train the model. If you specify
TrainingData
you must also specifyTestingData
. The project must not have any associated datasets.Type: TrainingData object
Required: No
- VersionName
-
A name for the version of the model. This value must be unique.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.\-]+
Required: Yes
Response Syntax
{
"ProjectVersionArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ProjectVersionArn
-
The ARN of the model version that was created. Use
DescribeProjectVersion
to get the current status of the training operation.Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- LimitExceededException
-
An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations (
StartLabelDetection
, for example) will raise aLimitExceededException
exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
HTTP Status Code: 400
- ResourceInUseException
-
The specified resource is already being used.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource specified in the request cannot be found.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
The size of the resource exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: