DescribeProjectVersions - Amazon Rekognition

DescribeProjectVersions

Lists and describes the models in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all models are returned.

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

Request Syntax

{ "MaxResults": number, "NextToken": "string", "ProjectArn": "string", "VersionNames": [ "string" ] }

Request Parameters

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

ProjectArn

The Amazon Resource Name (ARN) of the project that contains the models you want to describe.

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

VersionNames

A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a model (ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.\-]+

Required: No

Response Syntax

{ "NextToken": "string", "ProjectVersionDescriptions": [ { "BillableTrainingTimeInSeconds": number, "CreationTimestamp": number, "EvaluationResult": { "F1Score": number, "Summary": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } }, "ManifestSummary": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "MinInferenceUnits": number, "OutputConfig": { "S3Bucket": "string", "S3KeyPrefix": "string" }, "ProjectVersionArn": "string", "Status": "string", "StatusMessage": "string", "TestingDataResult": { "Input": { "Assets": [ { "GroundTruthManifest": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ], "AutoCreate": boolean }, "Output": { "Assets": [ { "GroundTruthManifest": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ], "AutoCreate": boolean }, "Validation": { "Assets": [ { "GroundTruthManifest": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ] } }, "TrainingDataResult": { "Input": { "Assets": [ { "GroundTruthManifest": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ] }, "Output": { "Assets": [ { "GroundTruthManifest": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ] }, "Validation": { "Assets": [ { "GroundTruthManifest": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ] } }, "TrainingEndTimestamp": number } ] }

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.

NextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Type: String

Length Constraints: Maximum length of 1024.

ProjectVersionDescriptions

A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest.

Type: Array of ProjectVersionDescription objects

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

InvalidPaginationTokenException

Pagination token in the request is not valid.

HTTP Status Code: 400

InvalidParameterException

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

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

ResourceNotFoundException

The collection specified in the request cannot be found.

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: