Amazon SageMaker Sagemaker Flow Definition API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Flow Definition 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:
  /#CreateFlowDefinition:
    post:
      operationId: CreateFlowDefinition
      summary: Create Flow Definition
      description: Creates a flow definition.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateFlowDefinitionResponse'
        '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.CreateFlowDefinition
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateFlowDefinitionRequest'
      tags:
      - Flow Definition
  /#DeleteFlowDefinition:
    post:
      operationId: DeleteFlowDefinition
      summary: Delete Flow Definition
      description: Deletes the specified flow definition.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteFlowDefinitionResponse'
        '400':
          description: ResourceInUse; ResourceNotFound
          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.DeleteFlowDefinition
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteFlowDefinitionRequest'
      tags:
      - Flow Definition
  /#DescribeFlowDefinition:
    post:
      operationId: DescribeFlowDefinition
      summary: Describe Flow Definition
      description: Returns information about the specified flow definition.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeFlowDefinitionResponse'
        '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.DescribeFlowDefinition
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeFlowDefinitionRequest'
      tags:
      - Flow Definition
  /#ListFlowDefinitions:
    post:
      operationId: ListFlowDefinitions
      summary: List Flow Definitions
      description: Returns information about the flow definitions in your account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListFlowDefinitionsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListFlowDefinitions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListFlowDefinitionsRequest'
      tags:
      - Flow Definition
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:
    CreateFlowDefinitionRequest:
      type: object
      properties:
        FlowDefinitionName:
          type: string
          description: The name of your flow definition.
        HumanLoopRequestSource:
          $ref: '#/components/schemas/HumanLoopRequestSource'
        HumanLoopActivationConfig:
          $ref: '#/components/schemas/HumanLoopActivationConfig'
        HumanLoopConfig:
          $ref: '#/components/schemas/HumanLoopConfig'
        OutputConfig:
          $ref: '#/components/schemas/FlowDefinitionOutputConfig'
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example,
            arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
        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 flow definition.
            Each tag consists of a key and a value, both of which you define.
      required:
      - FlowDefinitionName
      - OutputConfig
      - RoleArn
    CreateFlowDefinitionResponse:
      type: object
      properties:
        FlowDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow definition you create.
      required:
      - FlowDefinitionArn
    DeleteFlowDefinitionRequest:
      type: object
      properties:
        FlowDefinitionName:
          type: string
          description: The name of the flow definition you are deleting.
      required:
      - FlowDefinitionName
    DeleteFlowDefinitionResponse:
      type: object
      properties: {}
    DescribeFlowDefinitionRequest:
      type: object
      properties:
        FlowDefinitionName:
          type: string
          description: The name of the flow definition.
      required:
      - FlowDefinitionName
    DescribeFlowDefinitionResponse:
      type: object
      properties:
        FlowDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow defintion.
        FlowDefinitionName:
          type: string
          description: The Amazon Resource Name (ARN) of the flow definition.
        FlowDefinitionStatus:
          type: string
          enum:
          - Initializing
          - Active
          - Failed
          - Deleting
          description: The status of the flow definition. Valid values are listed below.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp when the flow definition was created.
        HumanLoopRequestSource:
          $ref: '#/components/schemas/HumanLoopRequestSource'
        HumanLoopActivationConfig:
          $ref: '#/components/schemas/HumanLoopActivationConfig'
        HumanLoopConfig:
          $ref: '#/components/schemas/HumanLoopConfig'
        OutputConfig:
          $ref: '#/components/schemas/FlowDefinitionOutputConfig'
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution
            role for the flow definition.
        FailureReason:
          type: string
          description: The reason your flow definition failed.
      required:
      - FlowDefinitionArn
      - FlowDefinitionName
      - FlowDefinitionStatus
      - CreationTime
      - OutputConfig
      - RoleArn
    FlowDefinitionOutputConfig:
      type: object
      properties:
        S3OutputPath:
          type: string
          description: The Amazon S3 path where the object containing human output will be made available. To learn more about
            the format of Amazon A2I output data, see Amazon A2I Output Data.
        KmsKeyId:
          type: string
          description: The Amazon Key Management Service (KMS) key ID for server-side encryption.
      required:
      - S3OutputPath
    FlowDefinitionSummary:
      type: object
      properties:
        FlowDefinitionName:
          type: string
          description: The name of the flow definition.
        FlowDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow definition.
        FlowDefinitionStatus:
          type: string
          enum:
          - Initializing
          - Active
          - Failed
          - Deleting
          description: 'The status of the flow definition. Valid values:'
        CreationTime:
          type: string
          format: date-time
          description: The timestamp when SageMaker created the flow definition.
        FailureReason:
          type: string
          description: The reason why the flow definition creation failed. A failure reason is returned only when the flow
            definition status is Failed.
      required:
      - FlowDefinitionName
      - FlowDefinitionArn
      - FlowDefinitionStatus
      - CreationTime
    HumanLoopActivationConditionsConfig:
      type: object
      properties:
        HumanLoopActivationConditions:
          type: string
          description: JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks
            are created against the configured work team. The set of conditions is different for Rekognition and Textract.
            For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in
            Amazon Augmented AI in the Amazon SageMaker Developer Guide.
      required:
      - HumanLoopActivationConditions
    HumanLoopActivationConfig:
      type: object
      properties:
        HumanLoopActivationConditionsConfig:
          $ref: '#/components/schemas/HumanLoopActivationConditionsConfig'
      required:
      - HumanLoopActivationConditionsConfig
    HumanLoopConfig:
      type: object
      properties:
        WorkteamArn:
          type: string
          description: Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work
            teams you can create and use with Amazon A2I, see Create and Manage Workforces.
        HumanTaskUiArn:
          type: string
          description: The Amazon Resource Name (ARN) of the human task user interface. You can use standard HTML and Crowd
            HTML Elements to create a custom worker task template. You use this template to create a human task UI. To learn
            how to create a custom HTML template, see Create Custom Worker Task Template. To learn how to create a human task
            UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task
            Templates.
        TaskTitle:
          type: string
          description: A title for the human worker task.
        TaskDescription:
          type: string
          description: A description for the human worker task.
        TaskCount:
          type: integer
          description: The number of distinct workers who will perform the same task on each object. For example, if TaskCount
            is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing
            TaskCount can improve label accuracy.
        TaskAvailabilityLifetimeInSeconds:
          type: integer
          description: The length of time that a task remains available for review by human workers.
        TaskTimeLimitInSeconds:
          type: integer
          description: The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
        TaskKeywords:
          type: array
          items:
            type: string
          description: Keywords used to describe the task so that workers can discover the task.
        PublicWorkforceTaskPrice:
          $ref: '#/components/schemas/PublicWorkforceTaskPrice'
      required:
      - WorkteamArn
      - HumanTaskUiArn
      - TaskTitle
      - TaskDescription
      - TaskCount
    HumanLoopRequestSource:
      type: object
      properties:
        AwsManagedHumanLoopRequestSource:
          type: string
          enum:
          - AWS/Rekognition/DetectModerationLabels/Image/V3
          - AWS/Textract/AnalyzeDocument/Forms/V1
          description: 'Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default
            field settings and JSON parsing rules are different based on the integration source. Valid values:'
      required:
      - AwsManagedHumanLoopRequestSource
    ListFlowDefinitionsRequest:
      type: object
      properties:
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only flow definitions with a creation time greater than or equal to the specified
            timestamp.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only flow definitions 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.
    ListFlowDefinitionsResponse:
      type: object
      properties:
        FlowDefinitionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/FlowDefinitionSummary'
          description: An array of objects describing the flow definitions.
        NextToken:
          type: string
          description: A token to resume pagination.
      required:
      - FlowDefinitionSummaries
    PublicWorkforceTaskPrice:
      type: object
      properties:
        AmountInUsd:
          $ref: '#/components/schemas/USD'
    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
    USD:
      type: object
      properties:
        Dollars:
          type: integer
          description: The whole number of dollars in the amount.
        Cents:
          type: integer
          description: The fractional portion, in cents, of the amount.
        TenthFractionsOfACent:
          type: integer
          description: Fractions of a cent, in tenths.
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)