Amazon SageMaker Sagemaker Human Task Ui API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Human Task Ui API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 4 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://api.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateHumanTaskUi:
    post:
      operationId: CreateHumanTaskUi
      summary: Create Human Task Ui
      description: Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel
        interface with an instruction area, the item to review, and an input area.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateHumanTaskUiResponse'
        '400':
          description: ResourceInUse; ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateHumanTaskUi
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateHumanTaskUiRequest'
      tags:
      - Human Task Ui
  /#DeleteHumanTaskUi:
    post:
      operationId: DeleteHumanTaskUi
      summary: Delete Human Task Ui
      description: Use this operation to delete a human task user interface (worker task template). To see a list of human
        task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template,
        it no longer appears when you call ListHumanTaskUis.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteHumanTaskUiResponse'
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteHumanTaskUi
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteHumanTaskUiRequest'
      tags:
      - Human Task Ui
  /#DescribeHumanTaskUi:
    post:
      operationId: DescribeHumanTaskUi
      summary: Describe Human Task Ui
      description: Returns information about the requested human task user interface (worker task template).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeHumanTaskUiResponse'
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribeHumanTaskUi
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeHumanTaskUiRequest'
      tags:
      - Human Task Ui
  /#ListHumanTaskUis:
    post:
      operationId: ListHumanTaskUis
      summary: List Human Task Uis
      description: Returns information about the human task user interfaces in your account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListHumanTaskUisResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListHumanTaskUis
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListHumanTaskUisRequest'
      tags:
      - Human Task Ui
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: sagemaker
  schemas:
    CreateHumanTaskUiRequest:
      type: object
      properties:
        HumanTaskUiName:
          type: string
          description: The name of the user interface you are creating.
        UiTemplate:
          $ref: '#/components/schemas/UiTemplate'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of key-value pairs that contain metadata to help you categorize and organize a human review
            workflow user interface. Each tag consists of a key and a value, both of which you define.
      required:
      - HumanTaskUiName
      - UiTemplate
    CreateHumanTaskUiResponse:
      type: object
      properties:
        HumanTaskUiArn:
          type: string
          description: The Amazon Resource Name (ARN) of the human review workflow user interface you create.
      required:
      - HumanTaskUiArn
    DeleteHumanTaskUiRequest:
      type: object
      properties:
        HumanTaskUiName:
          type: string
          description: The name of the human task user interface (work task template) you want to delete.
      required:
      - HumanTaskUiName
    DeleteHumanTaskUiResponse:
      type: object
      properties: {}
    DescribeHumanTaskUiRequest:
      type: object
      properties:
        HumanTaskUiName:
          type: string
          description: The name of the human task user interface (worker task template) you want information about.
      required:
      - HumanTaskUiName
    DescribeHumanTaskUiResponse:
      type: object
      properties:
        HumanTaskUiArn:
          type: string
          description: The Amazon Resource Name (ARN) of the human task user interface (worker task template).
        HumanTaskUiName:
          type: string
          description: The name of the human task user interface (worker task template).
        HumanTaskUiStatus:
          type: string
          enum:
          - Active
          - Deleting
          description: The status of the human task user interface (worker task template). Valid values are listed below.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp when the human task user interface was created.
        UiTemplate:
          $ref: '#/components/schemas/UiTemplateInfo'
      required:
      - HumanTaskUiArn
      - HumanTaskUiName
      - CreationTime
      - UiTemplate
    HumanTaskUiSummary:
      type: object
      properties:
        HumanTaskUiName:
          type: string
          description: The name of the human task user interface.
        HumanTaskUiArn:
          type: string
          description: The Amazon Resource Name (ARN) of the human task user interface.
        CreationTime:
          type: string
          format: date-time
          description: A timestamp when SageMaker created the human task user interface.
      required:
      - HumanTaskUiName
      - HumanTaskUiArn
      - CreationTime
    ListHumanTaskUisRequest:
      type: object
      properties:
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only human task user interfaces with a creation time greater than or equal to
            the specified timestamp.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only human task user interfaces that were created before the specified timestamp.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: An optional value that specifies whether you want the results sorted in Ascending or Descending order.
        NextToken:
          type: string
          description: A token to resume pagination.
        MaxResults:
          type: integer
          description: The total number of items to return. If the total number of available items is more than the value
            specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
    ListHumanTaskUisResponse:
      type: object
      properties:
        HumanTaskUiSummaries:
          type: array
          items:
            $ref: '#/components/schemas/HumanTaskUiSummary'
          description: An array of objects describing the human task user interfaces.
        NextToken:
          type: string
          description: A token to resume pagination.
      required:
      - HumanTaskUiSummaries
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key. Tag keys must be unique per resource.
        Value:
          type: string
          description: The tag value.
      required:
      - Key
      - Value
    UiTemplate:
      type: object
      properties:
        Content:
          type: string
          description: The content of the Liquid template for the worker user interface.
      required:
      - Content
    UiTemplateInfo:
      type: object
      properties:
        Url:
          type: string
          description: The URL for the user interface template.
        ContentSha256:
          type: string
          description: The SHA-256 digest of the contents of the template.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)