Amazon Rekognition Rekognition Project API

openapi: 3.1.0
info:
  title: Amazon Rekognition Project API
  version: '2016-06-27'
  description: Generated from AWS's published Smithy model for Amazon Rekognition. 3 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:
  /#CreateProject:
    post:
      operationId: CreateProject
      summary: Create Project
      description: Creates a new Amazon Rekognition project. A project is a group of resources (datasets, model versions)
        that you use to create and manage a Amazon Rekognition Custom Labels Model or custom adapter. You can specify a feature
        to create the project with, if no feature is specified then Custom Labels is used by default. For adapters, you can
        also choose whether or not to have the project auto update by using the AutoUpdate argument. This operation requires
        permissions to perform the rekognition:CreateProject action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateProjectResponse'
              example:
                ProjectArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285
        '400':
          description: AccessDeniedException; InvalidParameterException; LimitExceededException; ProvisionedThroughputExceededException;
            ResourceInUseException
          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.CreateProject
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateProjectRequest'
            example:
              ProjectName: my-project
      tags:
      - Project
  /#DeleteProject:
    post:
      operationId: DeleteProject
      summary: Delete Project
      description: Deletes a Amazon Rekognition project. To delete a project you must first delete all models or adapters
        associated with the project. To delete a model or adapter, see DeleteProjectVersion. DeleteProject is an asynchronous
        operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer
        appears in the response. Be aware that deleting a given project will also delete any ProjectPolicies associated with
        that project. This operation requires permissions to perform the rekognition:DeleteProject action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteProjectResponse'
              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.DeleteProject
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteProjectRequest'
            example:
              ProjectArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285
      tags:
      - Project
  /#DescribeProjects:
    post:
      operationId: DescribeProjects
      summary: Describe Projects
      description: Gets information about your Rekognition projects. This operation requires permissions to perform the rekognition:DescribeProjects
        action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeProjectsResponse'
        '400':
          description: AccessDeniedException; InvalidPaginationTokenException; InvalidParameterException; ProvisionedThroughputExceededException
          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.DescribeProjects
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeProjectsRequest'
      tags:
      - Project
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.
    CreateProjectRequest:
      type: object
      properties:
        ProjectName:
          type: string
          description: The name of the project to create.
        Feature:
          type: string
          enum:
          - CONTENT_MODERATION
          - CUSTOM_LABELS
          description: Specifies feature that is being customized. If no value is provided CUSTOM_LABELS is used as a default.
        AutoUpdate:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether automatic retraining should be attempted for the versions of the project. Automatic
            retraining is done as a best effort. Required argument for Content Moderation. Applicable only to adapters.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A set of tags (key-value pairs) that you want to attach to the project.
      required:
      - ProjectName
    CreateProjectResponse:
      type: object
      properties:
        ProjectArn:
          type: string
          description: The Amazon Resource Name (ARN) of the new project. You can use the ARN to configure IAM access to the
            project.
    DatasetMetadata:
      type: object
      properties:
        CreationTimestamp:
          type: string
          format: date-time
          description: The Unix timestamp for the date and time that the dataset was created.
        DatasetType:
          type: string
          enum:
          - TRAIN
          - TEST
          description: The type of the dataset.
        DatasetArn:
          type: string
          description: The Amazon Resource Name (ARN) for the dataset.
        Status:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_COMPLETE
          - CREATE_FAILED
          - UPDATE_IN_PROGRESS
          - UPDATE_COMPLETE
          - UPDATE_FAILED
          - DELETE_IN_PROGRESS
          description: The status for the dataset.
        StatusMessage:
          type: string
          description: The status message for the dataset.
        StatusMessageCode:
          type: string
          enum:
          - SUCCESS
          - SERVICE_ERROR
          - CLIENT_ERROR
          description: The status message code for the dataset operation. If a service error occurs, try the API call again
            later. If a client error occurs, check the input parameters to the dataset API call that failed.
    DeleteProjectRequest:
      type: object
      properties:
        ProjectArn:
          type: string
          description: The Amazon Resource Name (ARN) of the project that you want to delete.
      required:
      - ProjectArn
    DeleteProjectResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - CREATING
          - CREATED
          - DELETING
          description: The current status of the delete project operation.
    DescribeProjectsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: If the previous response was incomplete (because there is more results to retrieve), 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.
        ProjectNames:
          type: array
          items:
            type: string
          description: A list of the projects that you want Rekognition to describe. If you don't specify a value, the response
            includes descriptions for all the projects in your AWS account.
        Features:
          type: array
          items:
            type: string
            enum:
            - CONTENT_MODERATION
            - CUSTOM_LABELS
          description: Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS
            is used as a default.
    DescribeProjectsResponse:
      type: object
      properties:
        ProjectDescriptions:
          type: array
          items:
            $ref: '#/components/schemas/ProjectDescription'
          description: A list of project descriptions. The list is sorted by the date and time the projects are created.
        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.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
        Logref:
          type: string
          description: A universally unique identifier (UUID) for the request.
    ProjectDescription:
      type: object
      properties:
        ProjectArn:
          type: string
          description: The Amazon Resource Name (ARN) of the project.
        CreationTimestamp:
          type: string
          format: date-time
          description: The Unix timestamp for the date and time that the project was created.
        Status:
          type: string
          enum:
          - CREATING
          - CREATED
          - DELETING
          description: The current status of the project.
        Datasets:
          type: array
          items:
            $ref: '#/components/schemas/DatasetMetadata'
          description: Information about the training and test datasets in the project.
        Feature:
          type: string
          enum:
          - CONTENT_MODERATION
          - CUSTOM_LABELS
          description: Specifies the project that is being customized.
        AutoUpdate:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Indicates whether automatic retraining will be attempted for the versions of the project. Applies only
            to adapters.
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)