Amazon Rekognition Rekognition Media Analysis Job API

openapi: 3.1.0
info:
  title: Amazon Rekognition Media Analysis Job 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:
  /#GetMediaAnalysisJob:
    post:
      operationId: GetMediaAnalysisJob
      summary: Get Media Analysis Job
      description: 'Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers.
        For more information, see Rekognition feature availability changes. This change does not impact the availability of
        other Amazon Rekognition features. Retrieves the results for a given media analysis job. Takes a JobId returned by
        StartMediaAnalysisJob.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetMediaAnalysisJobResponse'
        '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.GetMediaAnalysisJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetMediaAnalysisJobRequest'
      tags:
      - Media Analysis Job
  /#ListMediaAnalysisJobs:
    post:
      operationId: ListMediaAnalysisJobs
      summary: List Media Analysis Jobs
      description: 'Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers.
        For more information, see Rekognition feature availability changes. This change does not impact the availability of
        other Amazon Rekognition features. Returns a list of media analysis jobs. Results are sorted by CreationTimestamp
        in descending order.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListMediaAnalysisJobsResponse'
        '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.ListMediaAnalysisJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListMediaAnalysisJobsRequest'
      tags:
      - Media Analysis Job
  /#StartMediaAnalysisJob:
    post:
      operationId: StartMediaAnalysisJob
      summary: Start Media Analysis Job
      description: 'Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers.
        For more information, see Rekognition feature availability changes. This change does not impact the availability of
        other Amazon Rekognition features. Initiates a new media analysis job. Accepts a manifest file in an Amazon S3 bucket.
        The output is a manifest file and a summary of the manifest stored in the Amazon S3 bucket.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartMediaAnalysisJobResponse'
              example:
                JobId: 861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537
        '400':
          description: AccessDeniedException; IdempotentParameterMismatchException; InvalidManifestException; InvalidParameterException;
            InvalidS3ObjectException; LimitExceededException; ProvisionedThroughputExceededException; ResourceNotFoundException;
            ResourceNotReadyException
          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.StartMediaAnalysisJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartMediaAnalysisJobRequest'
            example:
              JobName: job-name
              OperationsConfig:
                DetectModerationLabels:
                  MinConfidence: 50
                  ProjectVersion: arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958
              Input:
                S3Object:
                  Bucket: input-bucket
                  Name: input-manifest.json
              OutputConfig:
                S3Bucket: output-bucket
                S3KeyPrefix: output-location
      tags:
      - Media Analysis Job
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.
    GetMediaAnalysisJobRequest:
      type: object
      properties:
        JobId:
          type: string
          description: Unique identifier for the media analysis job for which you want to retrieve results.
      required:
      - JobId
    GetMediaAnalysisJobResponse:
      type: object
      properties:
        JobId:
          type: string
          description: The identifier for the media analysis job.
        JobName:
          type: string
          description: The name of the media analysis job.
        OperationsConfig:
          $ref: '#/components/schemas/MediaAnalysisOperationsConfig'
        Status:
          type: string
          enum:
          - CREATED
          - QUEUED
          - IN_PROGRESS
          - SUCCEEDED
          - FAILED
          description: The current status of the media analysis job.
        FailureDetails:
          $ref: '#/components/schemas/MediaAnalysisJobFailureDetails'
        CreationTimestamp:
          type: string
          format: date-time
          description: The Unix date and time when the job was started.
        CompletionTimestamp:
          type: string
          format: date-time
          description: The Unix date and time when the job finished.
        Input:
          $ref: '#/components/schemas/MediaAnalysisInput'
        OutputConfig:
          $ref: '#/components/schemas/MediaAnalysisOutputConfig'
        KmsKeyId:
          type: string
          description: KMS Key that was provided in the creation request.
        Results:
          $ref: '#/components/schemas/MediaAnalysisResults'
        ManifestSummary:
          $ref: '#/components/schemas/MediaAnalysisManifestSummary'
      required:
      - JobId
      - OperationsConfig
      - Status
      - CreationTimestamp
      - Input
      - OutputConfig
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
        Logref:
          type: string
          description: A universally unique identifier (UUID) for the request.
    ListMediaAnalysisJobsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: Pagination token, if the previous response was incomplete.
        MaxResults:
          type: integer
          description: The maximum number of results to return per paginated call. The largest value user can specify is 100.
            If user specifies a value greater than 100, an InvalidParameterException error occurs. The default value is 100.
    ListMediaAnalysisJobsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: Pagination token, if the previous response was incomplete.
        MediaAnalysisJobs:
          type: array
          items:
            $ref: '#/components/schemas/MediaAnalysisJobDescription'
          description: Contains a list of all media analysis jobs.
      required:
      - MediaAnalysisJobs
    MediaAnalysisDetectModerationLabelsConfig:
      type: object
      properties:
        MinConfidence:
          type: number
          description: Specifies the minimum confidence level for the moderation labels to return. Amazon Rekognition doesn't
            return any labels with a confidence level lower than this specified value.
        ProjectVersion:
          type: string
          description: Specifies the custom moderation model to be used during the label detection job. If not provided the
            pre-trained model is used.
    MediaAnalysisInput:
      type: object
      properties:
        S3Object:
          $ref: '#/components/schemas/S3Object'
      required:
      - S3Object
    MediaAnalysisJobDescription:
      type: object
      properties:
        JobId:
          type: string
          description: The identifier for a media analysis job.
        JobName:
          type: string
          description: The name of a media analysis job.
        OperationsConfig:
          $ref: '#/components/schemas/MediaAnalysisOperationsConfig'
        Status:
          type: string
          enum:
          - CREATED
          - QUEUED
          - IN_PROGRESS
          - SUCCEEDED
          - FAILED
          description: The status of the media analysis job being retrieved.
        FailureDetails:
          $ref: '#/components/schemas/MediaAnalysisJobFailureDetails'
        CreationTimestamp:
          type: string
          format: date-time
          description: The Unix date and time when the job was started.
        CompletionTimestamp:
          type: string
          format: date-time
          description: The Unix date and time when the job finished.
        Input:
          $ref: '#/components/schemas/MediaAnalysisInput'
        OutputConfig:
          $ref: '#/components/schemas/MediaAnalysisOutputConfig'
        KmsKeyId:
          type: string
          description: KMS Key that was provided in the creation request.
        Results:
          $ref: '#/components/schemas/MediaAnalysisResults'
        ManifestSummary:
          $ref: '#/components/schemas/MediaAnalysisManifestSummary'
      required:
      - JobId
      - OperationsConfig
      - Status
      - CreationTimestamp
      - Input
      - OutputConfig
    MediaAnalysisJobFailureDetails:
      type: object
      properties:
        Code:
          type: string
          enum:
          - INTERNAL_ERROR
          - INVALID_S3_OBJECT
          - INVALID_MANIFEST
          - INVALID_OUTPUT_CONFIG
          - INVALID_KMS_KEY
          - ACCESS_DENIED
          - RESOURCE_NOT_FOUND
          - RESOURCE_NOT_READY
          - THROTTLED
          description: Error code for the failed job.
        Message:
          type: string
          description: Human readable error message.
    MediaAnalysisManifestSummary:
      type: object
      properties:
        S3Object:
          $ref: '#/components/schemas/S3Object'
    MediaAnalysisModelVersions:
      type: object
      properties:
        Moderation:
          type: string
          description: The Moderation base model version.
    MediaAnalysisOperationsConfig:
      type: object
      properties:
        DetectModerationLabels:
          $ref: '#/components/schemas/MediaAnalysisDetectModerationLabelsConfig'
    MediaAnalysisOutputConfig:
      type: object
      properties:
        S3Bucket:
          type: string
          description: Specifies the Amazon S3 bucket to contain the output of the media analysis job.
        S3KeyPrefix:
          type: string
          description: Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for
            storage.
      required:
      - S3Bucket
    MediaAnalysisResults:
      type: object
      properties:
        S3Object:
          $ref: '#/components/schemas/S3Object'
        ModelVersions:
          $ref: '#/components/schemas/MediaAnalysisModelVersions'
    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.
    StartMediaAnalysisJobRequest:
      type: object
      properties:
        ClientRequestToken:
          type: string
          description: Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same
            token with multiple StartMediaAnalysisJobRequest requests, the same response is returned. Use ClientRequestToken
            to prevent the same request from being processed more than once.
        JobName:
          type: string
          description: The name of the job. Does not have to be unique.
        OperationsConfig:
          $ref: '#/components/schemas/MediaAnalysisOperationsConfig'
        Input:
          $ref: '#/components/schemas/MediaAnalysisInput'
        OutputConfig:
          $ref: '#/components/schemas/MediaAnalysisOutputConfig'
        KmsKeyId:
          type: string
          description: The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied
            into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.
      required:
      - OperationsConfig
      - Input
      - OutputConfig
    StartMediaAnalysisJobResponse:
      type: object
      properties:
        JobId:
          type: string
          description: Identifier for the created job.
      required:
      - JobId
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)