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

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.CreateDataQualityRuleset 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.CreateDataQualityRuleset API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-createdataqualityruleset-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-createdataqualityruleset-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.CreateDataQualityRuleset API'
paths:
  /#X-Amz-Target=AWSGlue.CreateDataQualityRuleset:
    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: CreateDataQualityRuleset
      description: 'Creates a data quality ruleset with DQDL rules applied to a specified Glue table.


        You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataQualityRulesetResponse'
              examples:
                CreateDataQualityRuleset200Example:
                  summary: Default CreateDataQualityRuleset 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                CreateDataQualityRuleset480Example:
                  summary: Default CreateDataQualityRuleset 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: AlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
              examples:
                CreateDataQualityRuleset481Example:
                  summary: Default CreateDataQualityRuleset 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                CreateDataQualityRuleset482Example:
                  summary: Default CreateDataQualityRuleset 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                CreateDataQualityRuleset483Example:
                  summary: Default CreateDataQualityRuleset 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '484':
          description: ResourceNumberLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNumberLimitExceededException'
              examples:
                CreateDataQualityRuleset484Example:
                  summary: Default CreateDataQualityRuleset 484 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataQualityRulesetRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.CreateDataQualityRuleset
      summary: Amazon Glue Create Data Quality Ruleset
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.CreateDataQualityRuleset 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)
  /#CreateDataQualityRuleset:
    post:
      operationId: post#CreateDataQualityRuleset
      summary: Create Data Quality Ruleset
      description: Creates a data quality ruleset with DQDL rules applied to a specified Glue table. You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDataQualityRulesetResponse_2'
        '400':
          description: AlreadyExistsException; InvalidInputException; OperationTimeoutException; ResourceNumberLimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException_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.CreateDataQualityRuleset
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDataQualityRulesetRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.CreateDataQualityRuleset API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: CreateDataQualityRuleset
    servers:
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    DataQualityRulesetString:
      type: string
      minLength: 1
      maxLength: 65536
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    InvalidInputException: {}
    CreateDataQualityRulesetResponse:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: A unique name for the data quality ruleset.
    HashString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    CreateDataQualityRulesetRequest:
      type: object
      required:
      - Name
      - Ruleset
      title: CreateDataQualityRulesetRequest
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: A unique name for the data quality ruleset.
        Description:
          allOf:
          - $ref: '#/components/schemas/DescriptionString'
          - description: A description of the data quality ruleset.
        Ruleset:
          allOf:
          - $ref: '#/components/schemas/DataQualityRulesetString'
          - description: A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagsMap'
          - description: A list of tags applied to the data quality ruleset.
        TargetTable:
          allOf:
          - $ref: '#/components/schemas/DataQualityTargetTable'
          - description: A target table associated with the data quality 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.
    DescriptionString:
      type: string
      minLength: 0
      maxLength: 2048
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    ResourceNumberLimitExceededException: {}
    DataQualityTargetTable:
      type: object
      required:
      - TableName
      - DatabaseName
      properties:
        TableName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the Glue table.
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the database where the Glue table exists.
      description: An object representing an Glue table.
    AlreadyExistsException: {}
    TagsMap:
      type: object
      minProperties: 0
      maxProperties: 50
      additionalProperties:
        $ref: '#/components/schemas/TagValue'
    InternalServiceException: {}
    OperationTimeoutException: {}
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    AlreadyExistsException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    DataQualityTargetTable_2:
      type: object
      properties:
        TableName:
          type: string
          description: The name of the Glue table.
        DatabaseName:
          type: string
          description: The name of the database where the Glue table exists.
        CatalogId:
          type: string
          description: The catalog id where the Glue table exists.
      required:
      - TableName
      - DatabaseName
    CreateDataQualityRulesetResponse_2:
      type: object
      properties:
        Name:
          type: string
          description: A unique name for the data quality ruleset.
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    CreateDataQualityRulesetRequest_2:
      type: object
      properties:
        Name:
          type: string
          description: A unique name for the data quality ruleset.
        Description:
          type: string
          description: A description of the data quality ruleset.
        Ruleset:
          type: string
          description: A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A list of tags applied to the data quality ruleset.
        TargetTable:
          $ref: '#/components/schemas/DataQualityTargetTable_2'
        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.
      required:
      - Name
      - Ruleset
  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-createdataqualityruleset-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-createdataqualityruleset-api-api-openapi.yml
x-hasEquivalentPaths: true