AWS Glue AWS Glue #X Amz Target=AWSGlue.ListDataQualityRulesetEvaluat… API

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.ListDataQualityRulesetEvaluat…'
  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.ListDataQualityRulesetEvaluat… across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-listdataqualityrulesetevaluationruns-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-listdataqualityrulesetevaluat-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.ListDataQualityRulesetEvaluat…'
paths:
  /#X-Amz-Target=AWSGlue.ListDataQualityRulesetEvaluationRuns:
    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: ListDataQualityRulesetEvaluationRuns
      description: Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataQualityRulesetEvaluationRunsResponse'
              examples:
                ListDataQualityRulesetEvaluationRuns200Example:
                  summary: Default ListDataQualityRulesetEvaluationRuns 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                ListDataQualityRulesetEvaluationRuns480Example:
                  summary: Default ListDataQualityRulesetEvaluationRuns 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                ListDataQualityRulesetEvaluationRuns481Example:
                  summary: Default ListDataQualityRulesetEvaluationRuns 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                ListDataQualityRulesetEvaluationRuns482Example:
                  summary: Default ListDataQualityRulesetEvaluationRuns 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDataQualityRulesetEvaluationRunsRequest'
      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.ListDataQualityRulesetEvaluationRuns
      summary: Amazon Glue List Data Quality Ruleset Evaluation Runs
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.ListDataQualityRulesetEvaluat…'
      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)
  /#ListDataQualityRulesetEvaluationRuns:
    post:
      operationId: post#ListDataQualityRulesetEvaluationRuns
      summary: List Data Quality Ruleset Evaluation Runs
      description: Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDataQualityRulesetEvaluationRunsResponse_2'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException_2'
        '400':
          description: InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.ListDataQualityRulesetEvaluationRuns
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDataQualityRulesetEvaluationRunsRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.ListDataQualityRulesetEvaluat…'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: ListDataQualityRulesetEvaluationRuns
    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: {}
    DataSource:
      type: object
      required:
      - GlueTable
      properties:
        GlueTable:
          allOf:
          - $ref: '#/components/schemas/GlueTable'
          - description: An Glue table.
      description: A data source (an Glue table) for which you want data quality results.
    GlueTableAdditionalOptions:
      type: object
      minProperties: 1
      maxProperties: 10
      additionalProperties:
        $ref: '#/components/schemas/DescriptionString'
    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]*'
    DescriptionString:
      type: string
      minLength: 0
      maxLength: 2048
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    ListDataQualityRulesetEvaluationRunsResponse:
      type: object
      properties:
        Runs:
          allOf:
          - $ref: '#/components/schemas/DataQualityRulesetEvaluationRunList'
          - description: A list of <code>DataQualityRulesetEvaluationRunDescription</code> objects representing data quality ruleset runs.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: A pagination token, if more results are available.
    DataQualityRulesetEvaluationRunList:
      type: array
      items:
        $ref: '#/components/schemas/DataQualityRulesetEvaluationRunDescription'
    PaginationToken:
      type: string
    DataQualityRulesetEvaluationRunDescription:
      type: object
      properties:
        RunId:
          allOf:
          - $ref: '#/components/schemas/HashString'
          - description: The unique run identifier associated with this run.
        Status:
          allOf:
          - $ref: '#/components/schemas/TaskStatusType'
          - description: The status for this run.
        StartedOn:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time when the run started.
        DataSource:
          allOf:
          - $ref: '#/components/schemas/DataSource'
          - description: The data source (an Glue table) associated with the run.
      description: Describes the result of a data quality ruleset evaluation run.
    ListDataQualityRulesetEvaluationRunsRequest:
      type: object
      title: ListDataQualityRulesetEvaluationRunsRequest
      properties:
        Filter:
          allOf:
          - $ref: '#/components/schemas/DataQualityRulesetEvaluationRunFilter'
          - description: The filter criteria.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: A paginated token to offset the results.
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/PageSize'
          - description: The maximum number of results to return.
    GlueTable:
      type: object
      required:
      - DatabaseName
      - TableName
      properties:
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: A database name in the Glue Data Catalog.
        TableName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: A table name in the Glue Data Catalog.
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: A unique identifier for the Glue Data Catalog.
        ConnectionName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the connection to the Glue Data Catalog.
        AdditionalOptions:
          allOf:
          - $ref: '#/components/schemas/GlueTableAdditionalOptions'
          - description: '<p>Additional options for the table. Currently there are two keys supported:</p> <ul> <li> <p> <code>pushDownPredicate</code>: to filter on partitions without having to list and read all the files in your dataset.</p> </li> <li> <p> <code>catalogPartitionPredicate</code>: to use server-side partition pruning using partition indexes in the Glue Data Catalog.</p> </li> </ul>'
      description: The database and table in the Glue Data Catalog that is used for input or output data.
    Timestamp:
      type: string
      format: date-time
    InternalServiceException: {}
    DataQualityRulesetEvaluationRunFilter:
      type: object
      required:
      - DataSource
      properties:
        DataSource:
          allOf:
          - $ref: '#/components/schemas/DataSource'
          - description: Filter based on a data source (an Glue table) associated with the run.
        StartedBefore:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Filter results by runs that started before this time.
        StartedAfter:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Filter results by runs that started after this time.
      description: The filter criteria.
    OperationTimeoutException: {}
    TaskStatusType:
      type: string
      enum:
      - STARTING
      - RUNNING
      - STOPPING
      - STOPPED
      - SUCCEEDED
      - FAILED
      - TIMEOUT
    DataQualityRulesetEvaluationRunDescription_2:
      type: object
      properties:
        RunId:
          type: string
          description: The unique run identifier associated with this run.
        Status:
          type: string
          enum:
          - STARTING
          - RUNNING
          - STOPPING
          - STOPPED
          - SUCCEEDED
          - FAILED
          - TIMEOUT
          description: The status for this run.
        StartedOn:
          type: string
          format: date-time
          description: The date and time when the run started.
        DataSource:
          $ref: '#/components/schemas/DataSource_2'
    InvalidInputException_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.
    ListDataQualityRulesetEvaluationRunsResponse_2:
      type: object
      properties:
        Runs:
          type: array
          items:
            $ref: '#/components/schemas/DataQualityRulesetEvaluationRunDescription_2'
          description: A list of DataQualityRulesetEvaluationRunDescription objects representing data quality ruleset runs.
        NextToken:
          type: string
          description: A pagination token, if more results are available.
    DataSource_2:
      type: object
      properties:
        GlueTable:
          $ref: '#/components/schemas/GlueTable_2'
        DataQualityGlueTable:
          $ref: '#/components/schemas/DataQualityGlueTable'
    ListDataQualityRulesetEvaluationRunsRequest_2:
      type: object
      properties:
        Filter:
          $ref: '#/components/schemas/DataQualityRulesetEvaluationRunFilter_2'
        NextToken:
          type: string
          description: A paginated token to offset the results.
        MaxResults:
          type: integer
          description: The maximum number of results to return.
    DataQualityGlueTable:
      type: object
      properties:
        DatabaseName:
          type: string
          description: A database name in the Glue Data Catalog.
        TableName:
          type: string
          description: A table name in the Glue Data Catalog.
        CatalogId:
          type: string
          description: A unique identifier for the Glue Data Catalog.
        ConnectionName:
          type: string
          description: The name of the connection to the Glue Data Catalog.
        AdditionalOptions:
          type: object
          additionalProperties:
            type: string
          description: 'Additional options for the table. Currently there are two keys supported: pushDownPredicate: to filter on partitions without having to list and read all the files in your dataset. catalogPartitionPredicate: to use server-side partition pruning using partition indexes in the Glue Data Catalog.'
        PreProcessingQuery:
          type: string
          description: SQL Query of SparkSQL format that can be used to pre-process the data for the table in Glue Data Catalog, before running the Data Quality Operation.
      required:
      - DatabaseName
      - TableName
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    DataQualityRulesetEvaluationRunFilter_2:
      type: object
      properties:
        DataSource:
          $ref: '#/components/schemas/DataSource_2'
        StartedBefore:
          type: string
          format: date-time
          description: Filter results by runs that started before this time.
        StartedAfter:
          type: string
          format: date-time
          description: Filter results by runs that started after this time.
        RulesetName:
          type: string
          description: Filter results by the name of the ruleset.
      required:
      - DataSource
    GlueTable_2:
      type: object
      properties:
        DatabaseName:
          type: string
          description: A database name in the Glue Data Catalog.
        TableName:
          type: string
          description: A table name in the Glue Data Catalog.
        CatalogId:
          type: string
          description: A unique identifier for the Glue Data Catalog.
        ConnectionName:
          type: string
          description: The name of the connection to the Glue Data Catalog.
        AdditionalOptions:
          type: object
          additionalProperties:
            type: string
          description: 'Additional options for the table. Currently there are two keys supported: pushDownPredicate: to filter on partitions without having to list and read all the files in your dataset. catalogPartitionPredicate: to use server-side partition pruning using partition indexes in the Glue Data Catalog.'
      required:
      - DatabaseName
      - TableName
  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-listdataqualityrulesetevaluationruns-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-listdataqualityrulesetevaluat-api-openapi.yml
x-hasEquivalentPaths: true