Amazon Rekognition Rekognition Project Version API

openapi: 3.1.0
info:
  title: Amazon Rekognition Project Version API
  version: '2016-06-27'
  description: Generated from AWS's published Smithy model for Amazon Rekognition. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://rekognition.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateProjectVersion:
    post:
      operationId: CreateProjectVersion
      summary: Create Project Version
      description: 'Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and
        begins training. Models and adapters are managed as part of a Rekognition project. The response from CreateProjectVersion
        is an Amazon Resource Name (ARN) for the project version. The FeatureConfig operation argument allows you to configure
        specific model or adapter settings. You can provide a description to the project version by using the VersionDescription
        argment. Training can take 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. Once training has successfully
        completed, call DescribeProjectVersions to get the training results and evaluate the model. This operation requires
        permissions to perform the rekognition:CreateProjectVersion action. The following applies only to projects with Amazon
        Rekognition Custom Labels as the chosen feature: 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, A'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateProjectVersionResponse'
              example:
                ProjectVersionArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958
        '400':
          description: AccessDeniedException; InvalidParameterException; LimitExceededException; ProvisionedThroughputExceededException;
            ResourceInUseException; ResourceNotFoundException; ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RekognitionService.CreateProjectVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateProjectVersionRequest'
            example:
              ProjectArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815
              VersionName: '1'
              OutputConfig:
                S3Bucket: output_bucket
                S3KeyPrefix: output_folder
      tags:
      - Project Version
  /#DeleteProjectVersion:
    post:
      operationId: DeleteProjectVersion
      summary: Delete Project Version
      description: Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or
        a custom adapter. You can't delete a project version if it is running or if it is training. To check the status of
        a project version, use the Status field returned from DescribeProjectVersions. To stop a project version call StopProjectVersion.
        If the project version is training, wait until it finishes. This operation requires permissions to perform the rekognition:DeleteProjectVersion
        action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteProjectVersionResponse'
              example:
                Status: DELETING
        '400':
          description: AccessDeniedException; InvalidParameterException; ProvisionedThroughputExceededException; ResourceInUseException;
            ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RekognitionService.DeleteProjectVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteProjectVersionRequest'
            example:
              ProjectVersionArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958
      tags:
      - Project Version
  /#DescribeProjectVersions:
    post:
      operationId: DescribeProjectVersions
      summary: Describe Project Versions
      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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeProjectVersionsResponse'
        '400':
          description: AccessDeniedException; InvalidPaginationTokenException; InvalidParameterException; ProvisionedThroughputExceededException;
            ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RekognitionService.DescribeProjectVersions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeProjectVersionsRequest'
      tags:
      - Project Version
  /#StartProjectVersion:
    post:
      operationId: StartProjectVersion
      summary: Start Project Version
      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 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartProjectVersionResponse'
              example:
                Status: STARTING
        '400':
          description: AccessDeniedException; InvalidParameterException; LimitExceededException; ProvisionedThroughputExceededException;
            ResourceInUseException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RekognitionService.StartProjectVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartProjectVersionRequest'
            example:
              ProjectVersionArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958
              MinInferenceUnits: 1
              MaxInferenceUnits: 1
      tags:
      - Project Version
  /#StopProjectVersion:
    post:
      operationId: StopProjectVersion
      summary: Stop Project Version
      description: This operation applies only to Amazon Rekognition Custom Labels. Stops a running model. The operation might
        take a while to complete. To check the current status, call DescribeProjectVersions. Only applies to Custom Labels
        projects. This operation requires permissions to perform the rekognition:StopProjectVersion action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopProjectVersionResponse'
              example:
                Status: STOPPING
        '400':
          description: AccessDeniedException; InvalidParameterException; ProvisionedThroughputExceededException; ResourceInUseException;
            ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RekognitionService.StopProjectVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopProjectVersionRequest'
            example:
              ProjectVersionArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958
      tags:
      - Project Version
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: rekognition
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
        Logref:
          type: string
          description: A universally unique identifier (UUID) for the request.
    Asset:
      type: object
      properties:
        GroundTruthManifest:
          $ref: '#/components/schemas/GroundTruthManifest'
    CreateProjectVersionRequest:
      type: object
      properties:
        ProjectArn:
          type: string
          description: The ARN of the Amazon Rekognition project that will manage the project version you want to train.
        VersionName:
          type: string
          description: A name for the version of the project version. This value must be unique.
        OutputConfig:
          $ref: '#/components/schemas/OutputConfig'
        TrainingData:
          $ref: '#/components/schemas/TrainingData'
        TestingData:
          $ref: '#/components/schemas/TestingData'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A set of tags (key-value pairs) that you want to attach to the project version.
        KmsKeyId:
          type: string
          description: 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 images, test images, and manifest files copied into the service for the project version. 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:Descri
        VersionDescription:
          type: string
          description: A description applied to the project version being created.
        FeatureConfig:
          $ref: '#/components/schemas/CustomizationFeatureConfig'
      required:
      - ProjectArn
      - VersionName
      - OutputConfig
    CreateProjectVersionResponse:
      type: object
      properties:
        ProjectVersionArn:
          type: string
          description: The ARN of the model or the project version that was created. Use DescribeProjectVersion to get the
            current status of the training operation.
    CustomizationFeatureConfig:
      type: object
      properties:
        ContentModeration:
          $ref: '#/components/schemas/CustomizationFeatureContentModerationConfig'
    CustomizationFeatureContentModerationConfig:
      type: object
      properties:
        ConfidenceThreshold:
          type: number
          description: The confidence level you plan to use to identify if unsafe content is present during inference.
    DeleteProjectVersionRequest:
      type: object
      properties:
        ProjectVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the project version that you want to delete.
      required:
      - ProjectVersionArn
    DeleteProjectVersionResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - TRAINING_IN_PROGRESS
          - TRAINING_COMPLETED
          - TRAINING_FAILED
          - STARTING
          - RUNNING
          - FAILED
          - STOPPING
          - STOPPED
          - DELETING
          - COPYING_IN_PROGRESS
          - COPYING_COMPLETED
          - COPYING_FAILED
          - DEPRECATED
          - EXPIRED
          description: The status of the deletion operation.
    DescribeProjectVersionsRequest:
      type: object
      properties:
        ProjectArn:
          type: string
          description: The Amazon Resource Name (ARN) of the project that contains the model/adapter you want to describe.
        VersionNames:
          type: array
          items:
            type: string
          description: 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:
          type: string
          description: 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:
          type: integer
          description: 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.
      required:
      - ProjectArn
    DescribeProjectVersionsResponse:
      type: object
      properties:
        ProjectVersionDescriptions:
          type: array
          items:
            $ref: '#/components/schemas/ProjectVersionDescription'
          description: A list of project version descriptions. The list is sorted by the creation date and time of the project
            versions, latest to earliest.
        NextToken:
          type: string
          description: 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.
    EvaluationResult:
      type: object
      properties:
        F1Score:
          type: number
          description: The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision
            and recall performance of the model as a single value. A higher value indicates better precision and recall performance.
            A lower score indicates that precision, recall, or both are performing poorly.
        Summary:
          $ref: '#/components/schemas/Summary'
    GroundTruthManifest:
      type: object
      properties:
        S3Object:
          $ref: '#/components/schemas/S3Object'
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
        Logref:
          type: string
          description: A universally unique identifier (UUID) for the request.
    OutputConfig:
      type: object
      properties:
        S3Bucket:
          type: string
          description: The S3 bucket where training output is placed.
        S3KeyPrefix:
          type: string
          description: The prefix applied to the training output files.
    ProjectVersionDescription:
      type: object
      properties:
        ProjectVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the project version.
        CreationTimestamp:
          type: string
          format: date-time
          description: The Unix datetime for the date and time that training started.
        MinInferenceUnits:
          type: integer
          description: The minimum number of inference units used by the model. Applies only to Custom Labels projects. For
            more information, see StartProjectVersion.
        Status:
          type: string
          enum:
          - TRAINING_IN_PROGRESS
          - TRAINING_COMPLETED
          - TRAINING_FAILED
          - STARTING
          - RUNNING
          - FAILED
          - STOPPING
          - STOPPED
          - DELETING
          - COPYING_IN_PROGRESS
          - COPYING_COMPLETED
          - COPYING_FAILED
          - DEPRECATED
          - EXPIRED
          description: The current status of the model version.
        StatusMessage:
          type: string
          description: A descriptive message for an error or warning that occurred.
        BillableTrainingTimeInSeconds:
          type: integer
          description: The duration, in seconds, that you were billed for a successful training of the model version. This
            value is only returned if the model version has been successfully trained.
        TrainingEndTimestamp:
          type: string
          format: date-time
          description: The Unix date and time that training of the model ended.
        OutputConfig:
          $ref: '#/components/schemas/OutputConfig'
        TrainingDataResult:
          $ref: '#/components/schemas/TrainingDataResult'
        TestingDataResult:
          $ref: '#/components/schemas/TestingDataResult'
        EvaluationResult:
          $ref: '#/components/schemas/EvaluationResult'
        ManifestSummary:
          $ref: '#/components/schemas/GroundTruthManifest'
        KmsKeyId:
          type: string
          description: The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model
            during training.
        MaxInferenceUnits:
          type: integer
          description: The maximum number of inference units Amazon Rekognition uses to auto-scale the model. Applies only
            to Custom Labels projects. For more information, see StartProjectVersion.
        SourceProjectVersionArn:
          type: string
          description: If the model version was copied from a different project, SourceProjectVersionArn contains the ARN
            of the source model version.
        VersionDescription:
          type: string
          description: A user-provided description of the project version.
        Feature:
          type: string
          enum:
          - CONTENT_MODERATION
          - CUSTOM_LABELS
          description: The feature that was customized.
        BaseModelVersion:
          type: string
          description: The base detection model version used to create the project version.
        FeatureConfig:
          $ref: '#/components/schemas/CustomizationFeatureConfig'
    S3Object:
      type: object
      properties:
        Bucket:
          type: string
          description: Name of the S3 bucket.
        Name:
          type: string
          description: S3 object key name.
        Version:
          type: string
          description: If the bucket is versioning enabled, you can specify the object version.
    StartProjectVersionRequest:
      type: object
      properties:
        ProjectVersionArn:
          type: string
          description: The Amazon Resource Name(ARN) of the model version that you want to start.
        MinInferenceUnits:
          type: integer
          description: 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:
          type: integer
          description: 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.
      required:
      - ProjectVersionArn
      - MinInferenceUnits
    StartProjectVersionResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - TRAINING_IN_PROGRESS
          - TRAINING_COMPLETED
          - TRAINING_FAILED
          - STARTING
          - RUNNING
          - FAILED
          - STOPPING
          - STOPPED
          - DELETING
          - COPYING_IN_PROGRESS
          - COPYING_COMPLETED
          - COPYING_FAILED
          - DEPRECATED
          - EXPIRED
          description: The current running status of the model.
    StopProjectVersionRequest:
      type: object
      properties:
        ProjectVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model version that you want to stop. This operation requires
            permissions to perform the rekognition:StopProjectVersion action.
      required:
      - ProjectVersionArn
    StopProjectVersionResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - TRAINING_IN_PROGRESS
          - TRAINING_COMPLETED
          - TRAINING_FAILED
          - STARTING
          - RUNNING
          - FAILED
          - STOPPING
          - STOPPED
          - DELETING
          - COPYING_IN_PROGRESS
          - COPYING_COMPLETED
          - COPYING_FAILED
          - DEPRECATED
          - EXPIRED
          description: The current status of the stop operation.
    Summary:
      type: object
      properties:
        S3Object:
          $ref: '#/components/schemas/S3Object'
    TestingData:
      type: object
      properties:
        Assets:
          type: array
          items:
            $ref: '#/components/schemas/Asset'
          description: The assets used for testing.
        AutoCreate:
          type: boolean
          description: If specified, Rekognition splits training dataset to create a test dataset for the training job.
    TestingDataResult:
      type: object
      properties:
        Input:
          $ref: '#/components/schemas/TestingData'
        Output:
          $ref: '#/components/schemas/TestingData'
        Validation:
          $ref: '#/components/schemas/ValidationData'
    TrainingData:
      type: object
      properties:
        Assets:
          type: array
          items:
            $ref: '#/components/schemas/Asset'
          description: A manifest file that contains references to the training images and ground-truth annotations.
    TrainingDataResult:
      type: object
      properties:
        Input:
          $ref: '#/components/schemas/TrainingData'
        Output:
          $ref: '#/components/schemas/TrainingData'
        Validation:
          $ref: '#/components/schemas/ValidationData'
    ValidationData:
      type: object
      properties:
        Assets:
          type: array
          items:
            $ref: '#/components/schemas/Asset'
          description: The assets that comprise the validation data.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/rekognition/service/2016-06-27/rekognition-2016-06-27.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)