find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-rekognition:amazon-rekognition-dataset-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon Rekognition Dataset 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:
  /#CreateDataset:
    post:
      operationId: CreateDataset
      summary: Create Dataset
      description: This operation applies only to Amazon Rekognition Custom Labels. Creates a new Amazon Rekognition Custom
        Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing
        Amazon Rekognition Custom Labels dataset. To create a training dataset for a project, specify TRAIN for the value
        of DatasetType. To create the test dataset for a project, specify TEST for the value of DatasetType. The response
        from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete.
        Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE.
        To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors lists in
        the JSON Lines. Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). Currently, you can't access
        the terminal error information. For more information, see Creating dataset in the Amazon Rekognition Custom Labels
        Developer Guide. This operation requires permissions to perform the rekognition:CreateDataset action. If you want
        to copy an existing dataset, you also requir
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDatasetResponse'
              example:
                DatasetArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535
        '400':
          description: AccessDeniedException; InvalidParameterException; InvalidS3ObjectException; LimitExceededException;
            ProvisionedThroughputExceededException; ResourceAlreadyExistsException; 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.CreateDataset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDatasetRequest'
            example:
              DatasetSource:
                GroundTruthManifest:
                  S3Object:
                    Bucket: my-bucket
                    Name: datasets/flowers_training/manifests/output/output.manifest
              DatasetType: TRAIN
              ProjectArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815
      tags:
      - Dataset
  /#DeleteDataset:
    post:
      operationId: DeleteDataset
      summary: Delete Dataset
      description: This operation applies only to Amazon Rekognition Custom Labels. Deletes an existing Amazon Rekognition
        Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset
        is still deleting if the value of Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted,
        you get a ResourceNotFoundException exception. You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS)
        or if the dataset is updating (Status = UPDATE_IN_PROGRESS). This operation requires permissions to perform the rekognition:DeleteDataset
        action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteDatasetResponse'
              example: {}
        '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.DeleteDataset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDatasetRequest'
            example:
              DatasetArn: arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1690556733321
      tags:
      - Dataset
  /#DescribeDataset:
    post:
      operationId: DescribeDataset
      summary: Describe Dataset
      description: This operation applies only to Amazon Rekognition Custom Labels. Describes an Amazon Rekognition Custom
        Labels dataset. You can get information such as the current status of a dataset and statistics about the images and
        labels in a dataset. This operation requires permissions to perform the rekognition:DescribeDataset action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDatasetResponse'
        '400':
          description: AccessDeniedException; 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.DescribeDataset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDatasetRequest'
      tags:
      - Dataset
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.
    CreateDatasetRequest:
      type: object
      properties:
        DatasetSource:
          $ref: '#/components/schemas/DatasetSource'
        DatasetType:
          type: string
          enum:
          - TRAIN
          - TEST
          description: The type of the dataset. Specify TRAIN to create a training dataset. Specify TEST to create a test
            dataset.
        ProjectArn:
          type: string
          description: The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A set of tags (key-value pairs) that you want to attach to the dataset.
      required:
      - DatasetType
      - ProjectArn
    CreateDatasetResponse:
      type: object
      properties:
        DatasetArn:
          type: string
          description: The ARN of the created Amazon Rekognition Custom Labels dataset.
    DatasetDescription:
      type: object
      properties:
        CreationTimestamp:
          type: string
          format: date-time
          description: The Unix timestamp for the time and date that the dataset was created.
        LastUpdatedTimestamp:
          type: string
          format: date-time
          description: The Unix timestamp for the date and time that the dataset was last updated.
        Status:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_COMPLETE
          - CREATE_FAILED
          - UPDATE_IN_PROGRESS
          - UPDATE_COMPLETE
          - UPDATE_FAILED
          - DELETE_IN_PROGRESS
          description: The status of 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.
        DatasetStats:
          $ref: '#/components/schemas/DatasetStats'
    DatasetSource:
      type: object
      properties:
        GroundTruthManifest:
          $ref: '#/components/schemas/GroundTruthManifest'
        DatasetArn:
          type: string
          description: The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy.
    DatasetStats:
      type: object
      properties:
        LabeledEntries:
          type: integer
          description: The total number of images in the dataset that have labels.
        TotalEntries:
          type: integer
          description: The total number of images in the dataset.
        TotalLabels:
          type: integer
          description: The total number of labels declared in the dataset.
        ErrorEntries:
          type: integer
          description: The total number of entries that contain at least one error.
    DeleteDatasetRequest:
      type: object
      properties:
        DatasetArn:
          type: string
          description: The ARN of the Amazon Rekognition Custom Labels dataset that you want to delete.
      required:
      - DatasetArn
    DeleteDatasetResponse:
      type: object
      properties: {}
    DescribeDatasetRequest:
      type: object
      properties:
        DatasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset that you want to describe.
      required:
      - DatasetArn
    DescribeDatasetResponse:
      type: object
      properties:
        DatasetDescription:
          $ref: '#/components/schemas/DatasetDescription'
    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.
    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.
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)