Amazon Rekognition Rekognition Stream Processor API

openapi: 3.1.0
info:
  title: Amazon Rekognition Stream Processor API
  version: '2016-06-27'
  description: Generated from AWS's published Smithy model for Amazon Rekognition. 7 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:
  /#CreateStreamProcessor:
    post:
      operationId: CreateStreamProcessor
      summary: Create Stream Processor
      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. Creates an Amazon Rekognition stream processor that you can use to detect and recognize
        faces or to detect labels in a streaming video. Amazon Rekognition Video is a consumer of live video from Amazon Kinesis
        Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting
        labels. If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (Input)
        and a Kinesis data stream (Output) stream for receiving the output. You must use the FaceSearch option in Settings,
        specifying the collection that contains the faces you want to recognize. After you have finished analyzing a streaming
        video, use StopStreamProcessor to stop processing. If you are creating a stream processor to detect labels, you provide
        as input a Kinesis video stream (Input), Amazon S3 bucket information (Output), and an Amazon SNS topic ARN (NotificationChannel).
        Y'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateStreamProcessorResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; LimitExceededException; ProvisionedThroughputExceededException;
            ResourceInUseException; 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.CreateStreamProcessor
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateStreamProcessorRequest'
      tags:
      - Stream Processor
  /#DeleteStreamProcessor:
    post:
      operationId: DeleteStreamProcessor
      summary: Delete Stream Processor
      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. Deletes the stream processor identified by Name. You assign the value for Name
        when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a
        stream processor for a few seconds after calling DeleteStreamProcessor.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteStreamProcessorResponse'
        '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.DeleteStreamProcessor
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteStreamProcessorRequest'
      tags:
      - Stream Processor
  /#DescribeStreamProcessor:
    post:
      operationId: DescribeStreamProcessor
      summary: Describe Stream Processor
      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. Provides information about a stream processor created by CreateStreamProcessor.
        You can get information about the input and output streams, the input parameters for the face recognition being performed,
        and the current status of the stream processor.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeStreamProcessorResponse'
        '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.DescribeStreamProcessor
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeStreamProcessorRequest'
      tags:
      - Stream Processor
  /#ListStreamProcessors:
    post:
      operationId: ListStreamProcessors
      summary: List Stream Processors
      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. Gets a list of stream processors that you have created with CreateStreamProcessor.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListStreamProcessorsResponse'
        '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.ListStreamProcessors
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListStreamProcessorsRequest'
      tags:
      - Stream Processor
  /#StartStreamProcessor:
    post:
      operationId: StartStreamProcessor
      summary: Start Stream Processor
      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. Starts processing a stream processor. You create a stream processor by calling
        CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field
        specified in the call to CreateStreamProcessor. If you are using a label detection stream processor to detect labels,
        you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartStreamProcessorResponse'
        '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.StartStreamProcessor
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartStreamProcessorRequest'
      tags:
      - Stream Processor
  /#StopStreamProcessor:
    post:
      operationId: StopStreamProcessor
      summary: Stop Stream Processor
      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. Stops a running stream processor that was created by CreateStreamProcessor.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopStreamProcessorResponse'
        '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.StopStreamProcessor
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopStreamProcessorRequest'
      tags:
      - Stream Processor
  /#UpdateStreamProcessor:
    post:
      operationId: UpdateStreamProcessor
      summary: Update Stream Processor
      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. Allows you to update a stream processor. You can change some settings and regions
        of interest and delete certain parameters.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateStreamProcessorResponse'
        '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.UpdateStreamProcessor
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateStreamProcessorRequest'
      tags:
      - Stream Processor
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.
    BoundingBox:
      type: object
      properties:
        Width:
          type: number
          description: Width of the bounding box as a ratio of the overall image width.
        Height:
          type: number
          description: Height of the bounding box as a ratio of the overall image height.
        Left:
          type: number
          description: Left coordinate of the bounding box as a ratio of overall image width.
        Top:
          type: number
          description: Top coordinate of the bounding box as a ratio of overall image height.
    ConnectedHomeSettings:
      type: object
      properties:
        Labels:
          type: array
          items:
            type: string
          description: 'Specifies what you want to detect in the video, such as people, packages, or pets. The current valid
            labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".'
        MinConfidence:
          type: number
          description: The minimum confidence required to label an object in the video.
      required:
      - Labels
    ConnectedHomeSettingsForUpdate:
      type: object
      properties:
        Labels:
          type: array
          items:
            type: string
          description: 'Specifies what you want to detect in the video, such as people, packages, or pets. The current valid
            labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".'
        MinConfidence:
          type: number
          description: The minimum confidence required to label an object in the video.
    CreateStreamProcessorRequest:
      type: object
      properties:
        Input:
          $ref: '#/components/schemas/StreamProcessorInput'
        Output:
          $ref: '#/components/schemas/StreamProcessorOutput'
        Name:
          type: string
          description: An identifier you assign to the stream processor. You can use Name to manage the stream processor.
            For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name is
            idempotent. This is required for both face search and label detection stream processors.
        Settings:
          $ref: '#/components/schemas/StreamProcessorSettings'
        RoleArn:
          type: string
          description: The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM
            role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon
            S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required
            for both face search and label detection stream processors.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A set of tags (key-value pairs) that you want to attach to the stream processor.
        NotificationChannel:
          $ref: '#/components/schemas/StreamProcessorNotificationChannel'
        KmsKeyId:
          type: string
          description: The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter
            for label detection stream processors and should not be used to create a face search stream processor. 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 results and data published to your Amazon S3 bucket, which includes image
            frames and hero images. Your source images are unaffected.
        RegionsOfInterest:
          type: array
          items:
            $ref: '#/components/schemas/RegionOfInterest'
          description: Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify
            up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter
            for label detection stream processors and should not be used to create a face search stream processor.
        DataSharingPreference:
          $ref: '#/components/schemas/StreamProcessorDataSharingPreference'
      required:
      - Input
      - Output
      - Name
      - Settings
      - RoleArn
    CreateStreamProcessorResponse:
      type: object
      properties:
        StreamProcessorArn:
          type: string
          description: Amazon Resource Number for the newly created stream processor.
    DeleteStreamProcessorRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the stream processor you want to delete.
      required:
      - Name
    DeleteStreamProcessorResponse:
      type: object
      properties: {}
    DescribeStreamProcessorRequest:
      type: object
      properties:
        Name:
          type: string
          description: Name of the stream processor for which you want information.
      required:
      - Name
    DescribeStreamProcessorResponse:
      type: object
      properties:
        Name:
          type: string
          description: Name of the stream processor.
        StreamProcessorArn:
          type: string
          description: ARN of the stream processor.
        Status:
          type: string
          enum:
          - STOPPED
          - STARTING
          - RUNNING
          - FAILED
          - STOPPING
          - UPDATING
          description: Current status of the stream processor.
        StatusMessage:
          type: string
          description: Detailed status message about the stream processor.
        CreationTimestamp:
          type: string
          format: date-time
          description: Date and time the stream processor was created
        LastUpdateTimestamp:
          type: string
          format: date-time
          description: The time, in Unix format, the stream processor was last updated. For example, when the stream processor
            moves from a running state to a failed state, or when the user starts or stops the stream processor.
        Input:
          $ref: '#/components/schemas/StreamProcessorInput'
        Output:
          $ref: '#/components/schemas/StreamProcessorOutput'
        RoleArn:
          type: string
          description: ARN of the IAM role that allows access to the stream processor.
        Settings:
          $ref: '#/components/schemas/StreamProcessorSettings'
        NotificationChannel:
          $ref: '#/components/schemas/StreamProcessorNotificationChannel'
        KmsKeyId:
          type: string
          description: The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter
            for label detection stream processors.
        RegionsOfInterest:
          type: array
          items:
            $ref: '#/components/schemas/RegionOfInterest'
          description: Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an
            optional parameter for label detection stream processors.
        DataSharingPreference:
          $ref: '#/components/schemas/StreamProcessorDataSharingPreference'
    FaceSearchSettings:
      type: object
      properties:
        CollectionId:
          type: string
          description: The ID of a collection that contains faces that you want to search for.
        FaceMatchThreshold:
          type: number
          description: Minimum face match confidence score that must be met to return a result for a recognized face. The
            default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted,
            and values lower than 80 are set to 80.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
        Logref:
          type: string
          description: A universally unique identifier (UUID) for the request.
    KinesisDataStream:
      type: object
      properties:
        Arn:
          type: string
          description: ARN of the output Amazon Kinesis Data Streams stream.
    KinesisVideoStream:
      type: object
      properties:
        Arn:
          type: string
          description: ARN of the Kinesis video stream stream that streams the source video.
    KinesisVideoStreamStartSelector:
      type: object
      properties:
        ProducerTimestamp:
          type: integer
          description: The timestamp from the producer corresponding to the fragment, in milliseconds, expressed in unix time
            format.
        FragmentNumber:
          type: string
          description: The unique identifier of the fragment. This value monotonically increases based on the ingestion order.
    ListStreamProcessorsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: If the previous response was incomplete (because there are more stream processors to retrieve), Amazon
            Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the
            next set of stream processors.
        MaxResults:
          type: integer
          description: Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The
            default is 1000.
    ListStreamProcessorsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
            request to retrieve the next set of stream processors.
        StreamProcessors:
          type: array
          items:
            $ref: '#/components/schemas/StreamProcessor'
          description: List of stream processors that you have created.
    Point:
      type: object
      properties:
        X:
          type: number
          description: The value of the X coordinate for a point on a Polygon.
        Y:
          type: number
          description: The value of the Y coordinate for a point on a Polygon.
    RegionOfInterest:
      type: object
      properties:
        BoundingBox:
          $ref: '#/components/schemas/BoundingBox'
        Polygon:
          type: array
          items:
            $ref: '#/components/schemas/Point'
          description: Specifies a shape made up of up to 10 Point objects to define a region of interest.
    S3Destination:
      type: object
      properties:
        Bucket:
          type: string
          description: The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be
            the owner of the Amazon S3 bucket.
        KeyPrefix:
          type: string
          description: The prefix value of the location within the bucket that you want the information to be published to.
            For more information, see Using prefixes.
    StartStreamProcessorRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the stream processor to start processing.
        StartSelector:
          $ref: '#/components/schemas/StreamProcessingStartSelector'
        StopSelector:
          $ref: '#/components/schemas/StreamProcessingStopSelector'
      required:
      - Name
    StartStreamProcessorResponse:
      type: object
      properties:
        SessionId:
          type: string
          description: A unique identifier for the stream processing session.
    StopStreamProcessorRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of a stream processor created by CreateStreamProcessor.
      required:
      - Name
    StopStreamProcessorResponse:
      type: object
      properties: {}
    StreamProcessingStartSelector:
      type: object
      properties:
        KVSStreamStartSelector:
          $ref: '#/components/schemas/KinesisVideoStreamStartSelector'
    StreamProcessingStopSelector:
      type: object
      properties:
        MaxDurationInSeconds:
          type: integer
          description: Specifies the maximum amount of time in seconds that you want the stream to be processed. The largest
            amount of time is 2 minutes. The default is 10 seconds.
    StreamProcessor:
      type: object
      properties:
        Name:
          type: string
          description: Name of the Amazon Rekognition stream processor.
        Status:
          type: string
          enum:
          - STOPPED
          - STARTING
          - RUNNING
          - FAILED
          - STOPPING
          - UPDATING
          description: Current status of the Amazon Rekognition stream processor.
    StreamProcessorDataSharingPreference:
      type: object
      properties:
        OptIn:
          type: boolean
          description: If this option is set to true, you choose to share data with Rekognition to improve model performance.
      required:
      - OptIn
    StreamProcessorInput:
      type: object
      properties:
        KinesisVideoStream:
          $ref: '#/components/schemas/KinesisVideoStream'
    StreamProcessorNotificationChannel:
      type: object
      properties:
        SNSTopicArn:
          type: string
          description: The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon
            Rekognition posts the completion status.
      required:
      - SNSTopicArn
    StreamProcessorOutput:
      type: object
      properties:
        KinesisDataStream:
          $ref: '#/components/schemas/KinesisDataStream'
        S3Destination:
          $ref: '#/components/schemas/S3Destination'
    StreamProcessorSettings:
      type: object
      properties:
        FaceSearch:
          $ref: '#/components/schemas/FaceSearchSettings'
        ConnectedHome:
          $ref: '#/components/schemas/ConnectedHomeSettings'
    StreamProcessorSettingsForUpdate:
      type: object
      properties:
        ConnectedHomeForUpdate:
          $ref: '#/components/schemas/ConnectedHomeSettingsForUpdate'
    UpdateStreamProcessorRequest:
      type: object
      properties:
        Name:
          type: string
          description: Name of the stream processor that you want to update.
        SettingsForUpdate:
          $ref: '#/components/schemas/StreamProcessorSettingsForUpdate'
        RegionsOfInterestForUpdate:
          type: array
          items:
            $ref: '#/components/schemas/RegionOfInterest'
          description: Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an
            optional parameter for label detection stream processors.
        DataSharingPreferenceForUpdate:
          $ref: '#/components/schemas/StreamProcessorDataSharingPreference'
        ParametersToDelete:
          type: array
          items:
            type: string
            enum:
            - ConnectedHomeMinConfidence
            - RegionsOfInterest
          description: A list of parameters you want to delete from the stream processor.
      required:
      - Name
    UpdateStreamProcessorResponse:
      type: object
      properties: {}
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)