Amazon Glue #X Amz Target=AWSGlue.CreateClassifier API

The #X Amz Target=AWSGlue.CreateClassifier API from Amazon Glue — 1 operation(s) for #x amz target=awsglue.createclassifier.

OpenAPI Specification

amazon-glue-x-amz-target-awsglue-createclassifier-api-openapi.yml Raw ↑
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.CreateClassifier 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.CreateClassifier'
paths:
  /#X-Amz-Target=AWSGlue.CreateClassifier:
    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: CreateClassifier
      description: Creates a classifier in the user's account. This can be a <code>GrokClassifier</code>, an <code>XMLClassifier</code>, a <code>JsonClassifier</code>, or a <code>CsvClassifier</code>, depending on which field of the request is present.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateClassifierResponse'
              examples:
                CreateClassifier200Example:
                  summary: Default CreateClassifier 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: AlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
              examples:
                CreateClassifier480Example:
                  summary: Default CreateClassifier 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                CreateClassifier481Example:
                  summary: Default CreateClassifier 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                CreateClassifier482Example:
                  summary: Default CreateClassifier 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClassifierRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.CreateClassifier
      summary: Amazon Glue Create Classifier
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSGlue.CreateClassifier'
components:
  schemas:
    CreateJsonClassifierRequest:
      type: object
      required:
      - Name
      - JsonPath
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the 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: Specifies a JSON classifier for <code>CreateClassifier</code> to create.
    CreateClassifierResponse:
      type: object
      properties: {}
    JsonPath:
      type: string
    NullableBoolean:
      type: boolean
    CreateCsvClassifierRequest:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the 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. 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 true.
        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 configuration of custom datatypes.
        CustomDatatypes:
          allOf:
          - $ref: '#/components/schemas/CustomDatatypes'
          - description: Creates a list of supported custom datatypes.
      description: Specifies a custom CSV classifier for <code>CreateClassifier</code> to create.
    GrokPattern:
      type: string
      minLength: 1
      maxLength: 2048
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\t]*'
    OperationTimeoutException: {}
    CreateClassifierRequest:
      type: object
      title: CreateClassifierRequest
      properties:
        GrokClassifier:
          allOf:
          - $ref: '#/components/schemas/CreateGrokClassifierRequest'
          - description: A <code>GrokClassifier</code> object specifying the classifier to create.
        XMLClassifier:
          allOf:
          - $ref: '#/components/schemas/CreateXMLClassifierRequest'
          - description: An <code>XMLClassifier</code> object specifying the classifier to create.
        JsonClassifier:
          allOf:
          - $ref: '#/components/schemas/CreateJsonClassifierRequest'
          - description: A <code>JsonClassifier</code> object specifying the classifier to create.
        CsvClassifier:
          allOf:
          - $ref: '#/components/schemas/CreateCsvClassifierRequest'
          - description: A <code>CsvClassifier</code> object specifying the classifier to create.
    AlreadyExistsException: {}
    CreateXMLClassifierRequest:
      type: object
      required:
      - Classification
      - Name
      properties:
        Classification:
          allOf:
          - $ref: '#/components/schemas/Classification'
          - description: An identifier of the data format that the classifier matches.
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the 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: Specifies an XML classifier for <code>CreateClassifier</code> to create.
    CsvHeaderOption:
      type: string
      enum:
      - UNKNOWN
      - PRESENT
      - ABSENT
    CsvQuoteSymbol:
      type: string
      pattern: '[^\r\n]'
      minLength: 1
      maxLength: 1
    CustomDatatypes:
      type: array
      items:
        $ref: '#/components/schemas/NameString'
    CustomPatterns:
      type: string
      minLength: 0
      maxLength: 16000
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    CsvHeader:
      type: array
      items:
        $ref: '#/components/schemas/NameString'
    Classification:
      type: string
    RowTag:
      type: string
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    InvalidInputException: {}
    CsvColumnDelimiter:
      type: string
      pattern: '[^\r\n]'
      minLength: 1
      maxLength: 1
    CreateGrokClassifierRequest:
      type: object
      required:
      - Classification
      - Name
      - GrokPattern
      properties:
        Classification:
          allOf:
          - $ref: '#/components/schemas/Classification'
          - description: An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the new classifier.
        GrokPattern:
          allOf:
          - $ref: '#/components/schemas/GrokPattern'
          - description: The grok pattern used by this classifier.
        CustomPatterns:
          allOf:
          - $ref: '#/components/schemas/CustomPatterns'
          - description: Optional custom grok patterns used by this classifier.
      description: Specifies a <code>grok</code> classifier for <code>CreateClassifier</code> to create.
  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-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      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