Describe Project Versions

rekognition_describe_project_versions

R Documentation

Lists and describes the versions of an Amazon Rekognition project

Description

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

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

Usage

rekognition_describe_project_versions(ProjectArn, VersionNames,
  NextToken, MaxResults)

Arguments

ProjectArn

[required] The Amazon Resource Name (ARN) of the project that contains the model/adapter you want to describe.

VersionNames

A list of model or project version names that you want to describe. You can add up to 10 model or project version names to the list. If you don't specify a value, all project version descriptions are returned. A version name is part of a project version 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⁠.

NextToken

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

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.

Value

A list with the following syntax:

list(
  ProjectVersionDescriptions = list(
    list(
      ProjectVersionArn = "string",
      CreationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      MinInferenceUnits = 123,
      Status = "TRAINING_IN_PROGRESS"|"TRAINING_COMPLETED"|"TRAINING_FAILED"|"STARTING"|"RUNNING"|"FAILED"|"STOPPING"|"STOPPED"|"DELETING"|"COPYING_IN_PROGRESS"|"COPYING_COMPLETED"|"COPYING_FAILED"|"DEPRECATED"|"EXPIRED",
      StatusMessage = "string",
      BillableTrainingTimeInSeconds = 123,
      TrainingEndTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      OutputConfig = list(
        S3Bucket = "string",
        S3KeyPrefix = "string"
      ),
      TrainingDataResult = list(
        Input = list(
          Assets = list(
            list(
              GroundTruthManifest = list(
                S3Object = list(
                  Bucket = "string",
                  Name = "string",
                  Version = "string"
                )
              )
            )
          )
        ),
        Output = list(
          Assets = list(
            list(
              GroundTruthManifest = list(
                S3Object = list(
                  Bucket = "string",
                  Name = "string",
                  Version = "string"
                )
              )
            )
          )
        ),
        Validation = list(
          Assets = list(
            list(
              GroundTruthManifest = list(
                S3Object = list(
                  Bucket = "string",
                  Name = "string",
                  Version = "string"
                )
              )
            )
          )
        )
      ),
      TestingDataResult = list(
        Input = list(
          Assets = list(
            list(
              GroundTruthManifest = list(
                S3Object = list(
                  Bucket = "string",
                  Name = "string",
                  Version = "string"
                )
              )
            )
          ),
          AutoCreate = TRUE|FALSE
        ),
        Output = list(
          Assets = list(
            list(
              GroundTruthManifest = list(
                S3Object = list(
                  Bucket = "string",
                  Name = "string",
                  Version = "string"
                )
              )
            )
          ),
          AutoCreate = TRUE|FALSE
        ),
        Validation = list(
          Assets = list(
            list(
              GroundTruthManifest = list(
                S3Object = list(
                  Bucket = "string",
                  Name = "string",
                  Version = "string"
                )
              )
            )
          )
        )
      ),
      EvaluationResult = list(
        F1Score = 123.0,
        Summary = list(
          S3Object = list(
            Bucket = "string",
            Name = "string",
            Version = "string"
          )
        )
      ),
      ManifestSummary = list(
        S3Object = list(
          Bucket = "string",
          Name = "string",
          Version = "string"
        )
      ),
      KmsKeyId = "string",
      MaxInferenceUnits = 123,
      SourceProjectVersionArn = "string",
      VersionDescription = "string",
      Feature = "CONTENT_MODERATION"|"CUSTOM_LABELS",
      BaseModelVersion = "string",
      FeatureConfig = list(
        ContentModeration = list(
          ConfidenceThreshold = 123.0
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_project_versions(
  ProjectArn = "string",
  VersionNames = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# Describes a version of an Amazon Rekognition Custom Labels model.
svc$describe_project_versions(
  ProjectArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815",
  VersionNames = list(
    "1"
  )
)

## End(Not run)