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

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.GetClassifiers 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.GetClassifiers API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-getclassifiers-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-getclassifiers-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.GetClassifiers API'
paths:
  /#X-Amz-Target=AWSGlue.GetClassifiers:
    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: GetClassifiers
      description: Lists all classifier objects in the Data Catalog.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClassifiersResponse'
              examples:
                GetClassifiers200Example:
                  summary: Default GetClassifiers 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                GetClassifiers480Example:
                  summary: Default GetClassifiers 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetClassifiersRequest'
      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.GetClassifiers
      summary: Amazon Glue Get Classifiers
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetClassifiers 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)
  /#GetClassifiers:
    post:
      operationId: post#GetClassifiers
      summary: Get Classifiers
      description: Lists all classifier objects in the Data Catalog.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetClassifiersResponse_2'
        '400':
          description: OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetClassifiers
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetClassifiersRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetClassifiers API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: GetClassifiers
    servers:
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    CsvQuoteSymbol:
      type: string
      pattern: '[^\r\n]'
      minLength: 1
      maxLength: 1
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    GetClassifiersRequest:
      type: object
      title: GetClassifiersRequest
      properties:
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/PageSize'
          - description: The size of the list to return (optional).
        NextToken:
          allOf:
          - $ref: '#/components/schemas/Token'
          - description: An optional continuation token.
    XMLClassifier:
      type: object
      required:
      - Name
      - Classification
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the classifier.
        Classification:
          allOf:
          - $ref: '#/components/schemas/Classification'
          - description: An identifier of the data format that the classifier matches.
        CreationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that this classifier was registered.
        LastUpdated:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that this classifier was last updated.
        Version:
          allOf:
          - $ref: '#/components/schemas/VersionId'
          - description: The version of this classifier.
        RowTag:
          allOf:
          - $ref: '#/components/schemas/RowTag'
          - description: The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by <code>/&gt;</code>). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <code>&lt;row item_a="A" item_b="B"&gt;&lt;/row&gt;</code> is okay, but <code>&lt;row item_a="A" item_b="B" /&gt;</code> is not).
      description: A classifier for <code>XML</code> content.
    CustomPatterns:
      type: string
      minLength: 0
      maxLength: 16000
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    PageSize:
      type: integer
      minimum: 1
      maximum: 1000
    CsvClassifier:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the classifier.
        CreationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that this classifier was registered.
        LastUpdated:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that this classifier was last updated.
        Version:
          allOf:
          - $ref: '#/components/schemas/VersionId'
          - description: The version of this classifier.
        Delimiter:
          allOf:
          - $ref: '#/components/schemas/CsvColumnDelimiter'
          - description: A custom symbol to denote what separates each column entry in the row.
        QuoteSymbol:
          allOf:
          - $ref: '#/components/schemas/CsvQuoteSymbol'
          - description: A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
        ContainsHeader:
          allOf:
          - $ref: '#/components/schemas/CsvHeaderOption'
          - description: Indicates whether the CSV file contains a header.
        Header:
          allOf:
          - $ref: '#/components/schemas/CsvHeader'
          - description: A list of strings representing column names.
        DisableValueTrimming:
          allOf:
          - $ref: '#/components/schemas/NullableBoolean'
          - description: Specifies not to trim values before identifying the type of column values. The default value is <code>true</code>.
        AllowSingleColumn:
          allOf:
          - $ref: '#/components/schemas/NullableBoolean'
          - description: Enables the processing of files that contain only one column.
        CustomDatatypeConfigured:
          allOf:
          - $ref: '#/components/schemas/NullableBoolean'
          - description: Enables the custom datatype to be configured.
        CustomDatatypes:
          allOf:
          - $ref: '#/components/schemas/CustomDatatypes'
          - description: A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
      description: A classifier for custom <code>CSV</code> content.
    ClassifierList:
      type: array
      items:
        $ref: '#/components/schemas/Classifier'
    Classification:
      type: string
    JsonClassifier:
      type: object
      required:
      - Name
      - JsonPath
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the classifier.
        CreationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that this classifier was registered.
        LastUpdated:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that this classifier was last updated.
        Version:
          allOf:
          - $ref: '#/components/schemas/VersionId'
          - description: The version of this classifier.
        JsonPath:
          allOf:
          - $ref: '#/components/schemas/JsonPath'
          - description: A <code>JsonPath</code> string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in <a href="https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json">Writing JsonPath Custom Classifiers</a>.
      description: A classifier for <code>JSON</code> content.
    VersionId:
      type: integer
    CustomDatatypes:
      type: array
      items:
        $ref: '#/components/schemas/NameString'
    NullableBoolean:
      type: boolean
    Classifier:
      type: object
      properties:
        GrokClassifier:
          allOf:
          - $ref: '#/components/schemas/GrokClassifier'
          - description: A classifier that uses <code>grok</code>.
        XMLClassifier:
          allOf:
          - $ref: '#/components/schemas/XMLClassifier'
          - description: A classifier for XML content.
        JsonClassifier:
          allOf:
          - $ref: '#/components/schemas/JsonClassifier'
          - description: A classifier for JSON content.
        CsvClassifier:
          allOf:
          - $ref: '#/components/schemas/CsvClassifier'
          - description: A classifier for comma-separated values (CSV).
      description: <p>Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a <code>StructType</code> object that matches that data format.</p> <p>You can use the standard classifiers that Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a <code>grok</code> classifier, an <code>XML</code> classifier, a <code>JSON</code> classifier, or a custom <code>CSV</code> classifier, as specified in one of the fields in the <code>Classifier</code> object.</p>
    GrokPattern:
      type: string
      minLength: 1
      maxLength: 2048
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\t]*'
    JsonPath:
      type: string
    RowTag:
      type: string
    Timestamp:
      type: string
      format: date-time
    GetClassifiersResponse:
      type: object
      properties:
        Classifiers:
          allOf:
          - $ref: '#/components/schemas/ClassifierList'
          - description: The requested list of classifier objects.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/Token'
          - description: A continuation token.
    CsvColumnDelimiter:
      type: string
      pattern: '[^\r\n]'
      minLength: 1
      maxLength: 1
    CsvHeaderOption:
      type: string
      enum:
      - UNKNOWN
      - PRESENT
      - ABSENT
    Token:
      type: string
    GrokClassifier:
      type: object
      required:
      - Name
      - Classification
      - GrokPattern
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the classifier.
        Classification:
          allOf:
          - $ref: '#/components/schemas/Classification'
          - description: An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
        CreationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that this classifier was registered.
        LastUpdated:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that this classifier was last updated.
        Version:
          allOf:
          - $ref: '#/components/schemas/VersionId'
          - description: The version of this classifier.
        GrokPattern:
          allOf:
          - $ref: '#/components/schemas/GrokPattern'
          - description: The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in <a href="https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html">Writing Custom Classifiers</a>.
        CustomPatterns:
          allOf:
          - $ref: '#/components/schemas/CustomPatterns'
          - description: Optional custom grok patterns defined by this classifier. For more information, see custom patterns in <a href="https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html">Writing Custom Classifiers</a>.
      description: A classifier that uses <code>grok</code> patterns.
    OperationTimeoutException: {}
    CsvHeader:
      type: array
      items:
        $ref: '#/components/schemas/NameString'
    GetClassifiersRequest_2:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The size of the list to return (optional).
        NextToken:
          type: string
          description: An optional continuation token.
    GetClassifiersResponse_2:
      type: object
      properties:
        Classifiers:
          type: array
          items:
            $ref: '#/components/schemas/Classifier_2'
          description: The requested list of classifier objects.
        NextToken:
          type: string
          description: A continuation token.
    CsvClassifier_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the classifier.
        CreationTime:
          type: string
          format: date-time
          description: The time that this classifier was registered.
        LastUpdated:
          type: string
          format: date-time
          description: The time that this classifier was last updated.
        Version:
          type: integer
          description: The version of this classifier.
        Delimiter:
          type: string
          description: A custom symbol to denote what separates each column entry in the row.
        QuoteSymbol:
          type: string
          description: A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
        ContainsHeader:
          type: string
          enum:
          - UNKNOWN
          - PRESENT
          - ABSENT
          description: Indicates whether the CSV file contains a header.
        Header:
          type: array
          items:
            type: string
          description: A list of strings representing column names.
        DisableValueTrimming:
          type: boolean
          description: Specifies not to trim values before identifying the type of column values. The default value is true.
        AllowSingleColumn:
          type: boolean
          description: Enables the processing of files that contain only one column.
        CustomDatatypeConfigured:
          type: boolean
          description: Enables the custom datatype to be configured.
        CustomDatatypes:
          type: array
          items:
            type: string
          description: A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
        Serde:
          type: string
          enum:
          - OpenCSVSerDe
          - LazySimpleSerDe
          - None
          description: Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and None. You can specify the None value when you want the crawler to do the detection.
      required:
      - Name
    Classifier_2:
      type: object
      properties:
        GrokClassifier:
          $ref: '#/components/schemas/GrokClassifier_2'
        XMLClassifier:
          $ref: '#/components/schemas/XMLClassifier_2'
        JsonClassifier:
          $ref: '#/components/schemas/JsonClassifier_2'
        CsvClassifier:
          $ref: '#/components/schemas/CsvClassifier_2'
    GrokClassifier_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the classifier.
        Classification:
          type: string
          description: An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
        CreationTime:
          type: string
          format: date-time
          description: The time that this classifier was registered.
        LastUpdated:
          type: string
          format: date-time
          description: The time that this classifier was last updated.
        Version:
          type: integer
          description: The version of this classifier.
        GrokPattern:
          type: string
          description: The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.
        CustomPatterns:
          type: string
          description: Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.
      required:
      - Name
      - Classification
      - GrokPattern
    XMLClassifier_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the classifier.
        Classification:
          type: string
          description: An identifier of the data format that the classifier matches.
        CreationTime:
          type: string
          format: date-time
          description: The time that this classifier was registered.
        LastUpdated:
          type: string
          format: date-time
          description: The time that this classifier was last updated.
        Version:
          type: integer
          description: The version of this classifier.
        RowTag:
          type: string
          description: The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, is okay, but is not).
      required:
      - Name
      - Classification
    OperationTimeoutException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    JsonClassifier_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the classifier.
        CreationTime:
          type: string
          format: date-time
          description: The time that this classifier was registered.
        LastUpdated:
          type: string
          format: date-time
          description: The time that this classifier was last updated.
        Version:
          type: integer
          description: The version of this classifier.
        JsonPath:
          type: string
          description: A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
      required:
      - Name
      - JsonPath
  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-getclassifiers-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-getclassifiers-api-api-openapi.yml
x-hasEquivalentPaths: true