Amazon Glue #X Amz Target=AWSGlue.ListDataQualityRulesets API

openapi: 3.0.0
info:
  version: '2017-03-31'
  x-release: v4
  title: 'AWS Glue #X Amz Target=AWSGlue.BatchCreatePartition #X Amz Target=AWSGlue.BatchCreatePartition #X Amz Target=AWSGlue.ListDataQualityRulesets API'
  description: <fullname>Glue</fullname> <p>Defines the public endpoint for the Glue service.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: glue
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/glue-2017-03-31.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
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)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSGlue.ListDataQualityRulesets'
paths:
  /#X-Amz-Target=AWSGlue.ListDataQualityRulesets:
    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: ListDataQualityRulesets
      description: Returns a paginated list of rulesets for the specified list of Glue tables.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataQualityRulesetsResponse'
              examples:
                ListDataQualityRulesets200Example:
                  summary: Default ListDataQualityRulesets 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: EntityNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
              examples:
                ListDataQualityRulesets480Example:
                  summary: Default ListDataQualityRulesets 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                ListDataQualityRulesets481Example:
                  summary: Default ListDataQualityRulesets 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                ListDataQualityRulesets482Example:
                  summary: Default ListDataQualityRulesets 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                ListDataQualityRulesets483Example:
                  summary: Default ListDataQualityRulesets 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDataQualityRulesetsRequest'
      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.ListDataQualityRulesets
      summary: Amazon Glue List Data Quality Rulesets
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSGlue.ListDataQualityRulesets'
components:
  schemas:
    TagsMap:
      type: object
      minProperties: 0
      maxProperties: 50
      additionalProperties:
        $ref: '#/components/schemas/TagValue'
    InternalServiceException: {}
    DescriptionString:
      type: string
      minLength: 0
      maxLength: 2048
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    NullableInteger:
      type: integer
    EntityNotFoundException: {}
    DataQualityRulesetFilterCriteria:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the ruleset filter criteria.
        Description:
          allOf:
          - $ref: '#/components/schemas/DescriptionString'
          - description: The description of the ruleset filter criteria.
        CreatedBefore:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Filter on rulesets created before this date.
        CreatedAfter:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Filter on rulesets created after this date.
        LastModifiedBefore:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Filter on rulesets last modified before this date.
        LastModifiedAfter:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Filter on rulesets last modified after this date.
        TargetTable:
          allOf:
          - $ref: '#/components/schemas/DataQualityTargetTable'
          - description: The name and database name of the target table.
      description: The criteria used to filter data quality rulesets.
    ListDataQualityRulesetsResponse:
      type: object
      properties:
        Rulesets:
          allOf:
          - $ref: '#/components/schemas/DataQualityRulesetList'
          - description: A paginated list of rulesets for the specified list of Glue tables.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: A pagination token, if more results are available.
    PageSize:
      type: integer
      minimum: 1
      maximum: 1000
    DataQualityRulesetList:
      type: array
      items:
        $ref: '#/components/schemas/DataQualityRulesetListDetails'
    PaginationToken:
      type: string
    OperationTimeoutException: {}
    DataQualityRulesetListDetails:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the data quality ruleset.
        Description:
          allOf:
          - $ref: '#/components/schemas/DescriptionString'
          - description: A description of the data quality ruleset.
        CreatedOn:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time the data quality ruleset was created.
        LastModifiedOn:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time the data quality ruleset was last modified.
        TargetTable:
          allOf:
          - $ref: '#/components/schemas/DataQualityTargetTable'
          - description: An object representing an Glue table.
        RecommendationRunId:
          allOf:
          - $ref: '#/components/schemas/HashString'
          - description: When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
        RuleCount:
          allOf:
          - $ref: '#/components/schemas/NullableInteger'
          - description: The number of rules in the ruleset.
      description: Describes a data quality ruleset returned by <code>GetDataQualityRuleset</code>.
    HashString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    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.
    ListDataQualityRulesetsRequest:
      type: object
      title: ListDataQualityRulesetsRequest
      properties:
        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.
        Filter:
          allOf:
          - $ref: '#/components/schemas/DataQualityRulesetFilterCriteria'
          - description: 'The filter criteria. '
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagsMap'
          - description: A list of key-value pair tags.
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    Timestamp:
      type: string
      format: date-time
    InvalidInputException: {}
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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-Date:
      name: X-Amz-Date
      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-Algorithm:
      name: X-Amz-Algorithm
      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
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/glue/
x-hasEquivalentPaths: true