AWS Glue AWS Glue #X Amz Target=AWSGlue.GetMLTaskRuns API

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.GetMLTaskRuns API'
  version: '2017-03-31'
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  description: 'Operations tagged AWS Glue #X Amz Target=AWSGlue.GetMLTaskRuns API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-getmltaskruns-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-getmltaskruns-api-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://glue.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Glue multi-region endpoint
- url: https://glue.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Glue multi-region endpoint
- url: http://glue.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
- url: https://glue.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
tags:
- name: 'AWS Glue #X Amz Target=AWSGlue.GetMLTaskRuns API'
paths:
  /#X-Amz-Target=AWSGlue.GetMLTaskRuns:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: GetMLTaskRuns
      description: 'Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform''s TransformID and other optional parameters as documented in this section.


        This operation returns a list of historic runs and must be paginated.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMLTaskRunsResponse'
              examples:
                GetMLTaskRuns200Example:
                  summary: Default GetMLTaskRuns 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: EntityNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
              examples:
                GetMLTaskRuns480Example:
                  summary: Default GetMLTaskRuns 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                GetMLTaskRuns481Example:
                  summary: Default GetMLTaskRuns 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                GetMLTaskRuns482Example:
                  summary: Default GetMLTaskRuns 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                GetMLTaskRuns483Example:
                  summary: Default GetMLTaskRuns 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetMLTaskRunsRequest'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetMLTaskRuns
      summary: Amazon Glue Get M L Task Runs
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetMLTaskRuns API'
      security:
      - hmac: []
    servers:
    - url: http://glue.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The AWS Glue multi-region endpoint
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The AWS Glue multi-region endpoint
    - url: http://glue.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
    - url: https://glue.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
  /#GetMLTaskRuns:
    post:
      operationId: post#GetMLTaskRuns
      summary: Get MLTask Runs
      description: Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform's TransformID and other optional parameters as documented in this section. This operation returns a list of historic runs and must be paginated.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetMLTaskRunsResponse_2'
        '400':
          description: EntityNotFoundException; InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException_2'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetMLTaskRuns
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetMLTaskRunsRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetMLTaskRuns API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: GetMLTaskRuns
    servers:
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    InvalidInputException: {}
    SortDirectionType:
      type: string
      enum:
      - DESCENDING
      - ASCENDING
    TaskRunSortCriteria:
      type: object
      required:
      - Column
      - SortDirection
      properties:
        Column:
          allOf:
          - $ref: '#/components/schemas/TaskRunSortColumnType'
          - description: The column to be used to sort the list of task runs for the machine learning transform.
        SortDirection:
          allOf:
          - $ref: '#/components/schemas/SortDirectionType'
          - description: The sort direction to be used to sort the list of task runs for the machine learning transform.
      description: The sorting criteria that are used to sort the list of task runs for the machine learning transform.
    PageSize:
      type: integer
      minimum: 1
      maximum: 1000
    HashString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    EntityNotFoundException: {}
    LabelingSetGenerationTaskRunProperties:
      type: object
      properties:
        OutputS3Path:
          allOf:
          - $ref: '#/components/schemas/UriString'
          - description: The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
      description: Specifies configuration properties for a labeling set generation task run.
    ExportLabelsTaskRunProperties:
      type: object
      properties:
        OutputS3Path:
          allOf:
          - $ref: '#/components/schemas/UriString'
          - description: The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
      description: Specifies configuration properties for an exporting labels task run.
    TaskRun:
      type: object
      properties:
        TransformId:
          allOf:
          - $ref: '#/components/schemas/HashString'
          - description: The unique identifier for the transform.
        TaskRunId:
          allOf:
          - $ref: '#/components/schemas/HashString'
          - description: The unique identifier for this task run.
        Status:
          allOf:
          - $ref: '#/components/schemas/TaskStatusType'
          - description: The current status of the requested task run.
        LogGroupName:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The names of the log group for secure logging, associated with this task run.
        Properties:
          allOf:
          - $ref: '#/components/schemas/TaskRunProperties'
          - description: Specifies configuration properties associated with this task run.
        ErrorString:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The list of error strings associated with this task run.
        StartedOn:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time that this task run started.
        LastModifiedOn:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The last point in time that the requested task run was updated.
        CompletedOn:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The last point in time that the requested task run was completed.
        ExecutionTime:
          allOf:
          - $ref: '#/components/schemas/ExecutionTime'
          - description: The amount of time (in seconds) that the task run consumed resources.
      description: The sampling parameters that are associated with the machine learning transform.
    TaskType:
      type: string
      enum:
      - EVALUATION
      - LABELING_SET_GENERATION
      - IMPORT_LABELS
      - EXPORT_LABELS
      - FIND_MATCHES
    TaskRunList:
      type: array
      items:
        $ref: '#/components/schemas/TaskRun'
    PaginationToken:
      type: string
    FindMatchesTaskRunProperties:
      type: object
      properties:
        JobId:
          allOf:
          - $ref: '#/components/schemas/HashString'
          - description: The job ID for the Find Matches task run.
        JobName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name assigned to the job for the Find Matches task run.
        JobRunId:
          allOf:
          - $ref: '#/components/schemas/HashString'
          - description: The job run ID for the Find Matches task run.
      description: Specifies configuration properties for a Find Matches task run.
    GetMLTaskRunsRequest:
      type: object
      required:
      - TransformId
      title: GetMLTaskRunsRequest
      properties:
        TransformId:
          allOf:
          - $ref: '#/components/schemas/HashString'
          - description: The unique identifier of the machine learning transform.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: A token for pagination of the results. The default is empty.
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/PageSize'
          - description: 'The maximum number of results to return. '
        Filter:
          allOf:
          - $ref: '#/components/schemas/TaskRunFilterCriteria'
          - description: The filter criteria, in the <code>TaskRunFilterCriteria</code> structure, for the task run.
        Sort:
          allOf:
          - $ref: '#/components/schemas/TaskRunSortCriteria'
          - description: The sorting criteria, in the <code>TaskRunSortCriteria</code> structure, for the task run.
    TaskRunSortColumnType:
      type: string
      enum:
      - TASK_RUN_TYPE
      - STATUS
      - STARTED
    GenericString:
      type: string
    Timestamp:
      type: string
      format: date-time
    ReplaceBoolean:
      type: boolean
    TaskRunFilterCriteria:
      type: object
      properties:
        TaskRunType:
          allOf:
          - $ref: '#/components/schemas/TaskType'
          - description: The type of task run.
        Status:
          allOf:
          - $ref: '#/components/schemas/TaskStatusType'
          - description: The current status of the task run.
        StartedBefore:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Filter on task runs started before this date.
        StartedAfter:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Filter on task runs started after this date.
      description: The criteria that are used to filter the task runs for the machine learning transform.
    GetMLTaskRunsResponse:
      type: object
      properties:
        TaskRuns:
          allOf:
          - $ref: '#/components/schemas/TaskRunList'
          - description: A list of task runs that are associated with the transform.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: A pagination token, if more results are available.
    UriString:
      type: string
    TaskRunProperties:
      type: object
      properties:
        TaskType:
          allOf:
          - $ref: '#/components/schemas/TaskType'
          - description: The type of task run.
        ImportLabelsTaskRunProperties:
          allOf:
          - $ref: '#/components/schemas/ImportLabelsTaskRunProperties'
          - description: The configuration properties for an importing labels task run.
        ExportLabelsTaskRunProperties:
          allOf:
          - $ref: '#/components/schemas/ExportLabelsTaskRunProperties'
          - description: The configuration properties for an exporting labels task run.
        LabelingSetGenerationTaskRunProperties:
          allOf:
          - $ref: '#/components/schemas/LabelingSetGenerationTaskRunProperties'
          - description: The configuration properties for a labeling set generation task run.
        FindMatchesTaskRunProperties:
          allOf:
          - $ref: '#/components/schemas/FindMatchesTaskRunProperties'
          - description: The configuration properties for a find matches task run.
      description: The configuration properties for the task run.
    ExecutionTime:
      type: integer
    InternalServiceException: {}
    ImportLabelsTaskRunProperties:
      type: object
      properties:
        InputS3Path:
          allOf:
          - $ref: '#/components/schemas/UriString'
          - description: The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
        Replace:
          allOf:
          - $ref: '#/components/schemas/ReplaceBoolean'
          - description: Indicates whether to overwrite your existing labels.
      description: Specifies configuration properties for an importing labels task run.
    OperationTimeoutException: {}
    TaskStatusType:
      type: string
      enum:
      - STARTING
      - RUNNING
      - STOPPING
      - STOPPED
      - SUCCEEDED
      - FAILED
      - TIMEOUT
    LabelingSetGenerationTaskRunProperties_2:
      type: object
      properties:
        OutputS3Path:
          type: string
          description: The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
    ExportLabelsTaskRunProperties_2:
      type: object
      properties:
        OutputS3Path:
          type: string
          description: The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
    TaskRun_2:
      type: object
      properties:
        TransformId:
          type: string
          description: The unique identifier for the transform.
        TaskRunId:
          type: string
          description: The unique identifier for this task run.
        Status:
          type: string
          enum:
          - STARTING
          - RUNNING
          - STOPPING
          - STOPPED
          - SUCCEEDED
          - FAILED
          - TIMEOUT
          description: The current status of the requested task run.
        LogGroupName:
          type: string
          description: The names of the log group for secure logging, associated with this task run.
        Properties:
          $ref: '#/components/schemas/TaskRunProperties_2'
        ErrorString:
          type: string
          description: The list of error strings associated with this task run.
        StartedOn:
          type: string
          format: date-time
          description: The date and time that this task run started.
        LastModifiedOn:
          type: string
          format: date-time
          description: The last point in time that the requested task run was updated.
        CompletedOn:
          type: string
          format: date-time
          description: The last point in time that the requested task run was completed.
        ExecutionTime:
          type: integer
          description: The amount of time (in seconds) that the task run consumed resources.
    TaskRunFilterCriteria_2:
      type: object
      properties:
        TaskRunType:
          type: string
          enum:
          - EVALUATION
          - LABELING_SET_GENERATION
          - IMPORT_LABELS
          - EXPORT_LABELS
          - FIND_MATCHES
          description: The type of task run.
        Status:
          type: string
          enum:
          - STARTING
          - RUNNING
          - STOPPING
          - STOPPED
          - SUCCEEDED
          - FAILED
          - TIMEOUT
          description: The current status of the task run.
        StartedBefore:
          type: string
          format: date-time
          description: Filter on task runs started before this date.
        StartedAfter:
          type: string
          format: date-time
          description: Filter on task runs started after this date.
    GetMLTaskRunsResponse_2:
      type: object
      properties:
        TaskRuns:
          type: array
          items:
            $ref: '#/components/schemas/TaskRun_2'
          description: A list of task runs that are associated with the transform.
        NextToken:
          type: string
          description: A pagination token, if more results are available.
    TaskRunProperties_2:
      type: object
      properties:
        TaskType:
          type: string
          enum:
          - EVALUATION
          - LABELING_SET_GENERATION
          - IMPORT_LABELS
          - EXPORT_LABELS
          - FIND_MATCHES
          description: The type of task run.
        ImportLabelsTaskRunProperties:
          $ref: '#/components/schemas/ImportLabelsTaskRunProperties_2'
        ExportLabelsTaskRunProperties:
          $ref: '#/components/schemas/ExportLabelsTaskRunProperties_2'
        LabelingSetGenerationTaskRunProperties:
          $ref: '#/components/schemas/LabelingSetGenerationTaskRunProperties_2'
        FindMatchesTaskRunProperties:
          $ref: '#/components/schemas/FindMatchesTaskRunProperties_2'
    TaskRunSortCriteria_2:
      type: object
      properties:
        Column:
          type: string
          enum:
          - TASK_RUN_TYPE
          - STATUS
          - STARTED
          description: The column to be used to sort the list of task runs for the machine learning transform.
        SortDirection:
          type: string
          enum:
          - DESCENDING
          - ASCENDING
          description: The sort direction to be used to sort the list of task runs for the machine learning transform.
      required:
      - Column
      - SortDirection
    FindMatchesTaskRunProperties_2:
      type: object
      properties:
        JobId:
          type: string
          description: The job ID for the Find Matches task run.
        JobName:
          type: string
          description: The name assigned to the job for the Find Matches task run.
        JobRunId:
          type: string
          description: The job run ID for the Find Matches task run.
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    ImportLabelsTaskRunProperties_2:
      type: object
      properties:
        InputS3Path:
          type: string
          description: The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
        Replace:
          type: boolean
          description: Indicates whether to overwrite your existing labels.
    GetMLTaskRunsRequest_2:
      type: object
      properties:
        TransformId:
          type: string
          description: The unique identifier of the machine learning transform.
        NextToken:
          type: string
          description: A token for pagination of the results. The default is empty.
        MaxResults:
          type: integer
          description: The maximum number of results to return.
        Filter:
          $ref: '#/components/schemas/TaskRunFilterCriteria_2'
        Sort:
          $ref: '#/components/schemas/TaskRunSortCriteria_2'
      required:
      - TransformId
    EntityNotFoundException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
        FromFederationSource:
          type: boolean
          description: Indicates whether or not the exception relates to a federated source.
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
    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: glue
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/glue/
x-refined-from:
- amazon-glue-x-amz-target-awsglue-getmltaskruns-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-getmltaskruns-api-api-openapi.yml
x-hasEquivalentPaths: true