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

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.StartDataQualityRuleRecommend…'
  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.StartDataQualityRuleRecommend… across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-startdataqualityrulerecommendationrun-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-startdataqualityrulerecommend-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.StartDataQualityRuleRecommend…'
paths:
  /#X-Amz-Target=AWSGlue.StartDataQualityRuleRecommendationRun:
    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: StartDataQualityRuleRecommendationRun
      description: Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartDataQualityRuleRecommendationRunResponse'
              examples:
                StartDataQualityRuleRecommendationRun200Example:
                  summary: Default StartDataQualityRuleRecommendationRun 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                StartDataQualityRuleRecommendationRun480Example:
                  summary: Default StartDataQualityRuleRecommendationRun 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                StartDataQualityRuleRecommendationRun481Example:
                  summary: Default StartDataQualityRuleRecommendationRun 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                StartDataQualityRuleRecommendationRun482Example:
                  summary: Default StartDataQualityRuleRecommendationRun 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                StartDataQualityRuleRecommendationRun483Example:
                  summary: Default StartDataQualityRuleRecommendationRun 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartDataQualityRuleRecommendationRunRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.StartDataQualityRuleRecommendationRun
      summary: Amazon Glue Start Data Quality Rule Recommendation Run
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.StartDataQualityRuleRecommend…'
      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)
  /#StartDataQualityRuleRecommendationRun:
    post:
      operationId: post#StartDataQualityRuleRecommendationRun
      summary: Start Data Quality Rule Recommendation Run
      description: Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking. Recommendation runs are automatically deleted after 90 days.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartDataQualityRuleRecommendationRunResponse_2'
        '400':
          description: ConflictException; InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException_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.StartDataQualityRuleRecommendationRun
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartDataQualityRuleRecommendationRunRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.StartDataQualityRuleRecommend…'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: StartDataQualityRuleRecommendationRun
    servers:
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    RoleString:
      type: string
    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'
    StartDataQualityRuleRecommendationRunRequest:
      type: object
      required:
      - DataSource
      - Role
      title: StartDataQualityRuleRecommendationRunRequest
      properties:
        DataSource:
          allOf:
          - $ref: '#/components/schemas/DataSource'
          - description: The data source (Glue table) associated with this run.
        Role:
          allOf:
          - $ref: '#/components/schemas/RoleString'
          - description: An IAM role supplied to encrypt the results of the run.
        NumberOfWorkers:
          allOf:
          - $ref: '#/components/schemas/NullableInteger'
          - description: The number of <code>G.1X</code> workers to be used in the run. The default is 5.
        Timeout:
          allOf:
          - $ref: '#/components/schemas/Timeout'
          - description: The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).
        CreatedRulesetName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: A name for the ruleset.
        ClientToken:
          allOf:
          - $ref: '#/components/schemas/HashString'
          - description: Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
    ConflictException: {}
    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]*'
    Timeout:
      type: integer
      minimum: 1
    NullableInteger:
      type: integer
    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.
    InternalServiceException: {}
    StartDataQualityRuleRecommendationRunResponse:
      type: object
      properties:
        RunId:
          allOf:
          - $ref: '#/components/schemas/HashString'
          - description: The unique run identifier associated with this run.
    OperationTimeoutException: {}
    DataQualityRuleRecommendationRunAdditionalRunOptions:
      type: object
      properties:
        CustomLogGroupPrefix:
          type: string
          description: A custom prefix for the CloudWatch log group names. When specified, recommendation run logs are written to /error and /output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups.
    DataSource_2:
      type: object
      properties:
        GlueTable:
          $ref: '#/components/schemas/GlueTable_2'
        DataQualityGlueTable:
          $ref: '#/components/schemas/DataQualityGlueTable'
    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.
    StartDataQualityRuleRecommendationRunRequest_2:
      type: object
      properties:
        DataSource:
          $ref: '#/components/schemas/DataSource_2'
        Role:
          type: string
          description: The IAM role that Glue assumes to access resources for the run. For more information, see Configure IAM permissions for Glue Data Quality.
        NumberOfWorkers:
          type: integer
          description: The number of G.1X workers to be used in the run. The default is 5.
        Timeout:
          type: integer
          description: The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
        CreatedRulesetName:
          type: string
          description: A name for the ruleset.
        DataQualitySecurityConfiguration:
          type: string
          description: The name of the security configuration created with the data quality encryption option.
        ClientToken:
          type: string
          description: Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
        AdditionalRunOptions:
          $ref: '#/components/schemas/DataQualityRuleRecommendationRunAdditionalRunOptions'
        RecommendationMode:
          type: string
          enum:
          - BASIC
          - ADVANCED
          description: The mode that Glue Data Quality uses to recommend rules. The default is BASIC.
      required:
      - DataSource
      - Role
    StartDataQualityRuleRecommendationRunResponse_2:
      type: object
      properties:
        RunId:
          type: string
          description: The unique run identifier associated with this run.
    ConflictException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    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-startdataqualityrulerecommendationrun-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-startdataqualityrulerecommend-api-openapi.yml
x-hasEquivalentPaths: true