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

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.UpdateClassifier 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.UpdateClassifier API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-updateclassifier-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-updateclassifier-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.UpdateClassifier API'
paths:
  /#X-Amz-Target=AWSGlue.UpdateClassifier:
    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: UpdateClassifier
      description: Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateClassifierResponse'
              examples:
                UpdateClassifier200Example:
                  summary: Default UpdateClassifier 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                UpdateClassifier480Example:
                  summary: Default UpdateClassifier 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: VersionMismatchException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionMismatchException'
              examples:
                UpdateClassifier481Example:
                  summary: Default UpdateClassifier 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: EntityNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
              examples:
                UpdateClassifier482Example:
                  summary: Default UpdateClassifier 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                UpdateClassifier483Example:
                  summary: Default UpdateClassifier 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClassifierRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.UpdateClassifier
      summary: Amazon Glue Update Classifier
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.UpdateClassifier 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)
  /#UpdateClassifier:
    post:
      operationId: post#UpdateClassifier
      summary: Update Classifier
      description: Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateClassifierResponse'
        '400':
          description: EntityNotFoundException; InvalidInputException; OperationTimeoutException; VersionMismatchException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.UpdateClassifier
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateClassifierRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.UpdateClassifier API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: UpdateClassifier
    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]*'
    InvalidInputException: {}
    UpdateGrokClassifierRequest:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the <code>GrokClassifier</code>.
        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.
        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 grok classifier to update when passed to <code>UpdateClassifier</code>.
    CustomPatterns:
      type: string
      minLength: 0
      maxLength: 16000
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    EntityNotFoundException: {}
    UpdateClassifierRequest:
      type: object
      title: UpdateClassifierRequest
      properties:
        GrokClassifier:
          allOf:
          - $ref: '#/components/schemas/UpdateGrokClassifierRequest'
          - description: A <code>GrokClassifier</code> object with updated fields.
        XMLClassifier:
          allOf:
          - $ref: '#/components/schemas/UpdateXMLClassifierRequest'
          - description: An <code>XMLClassifier</code> object with updated fields.
        JsonClassifier:
          allOf:
          - $ref: '#/components/schemas/UpdateJsonClassifierRequest'
          - description: A <code>JsonClassifier</code> object with updated fields.
        CsvClassifier:
          allOf:
          - $ref: '#/components/schemas/UpdateCsvClassifierRequest'
          - description: A <code>CsvClassifier</code> object with updated fields.
    Classification:
      type: string
    UpdateClassifierResponse:
      type: object
      properties: {}
    UpdateJsonClassifierRequest:
      type: object
      required:
      - Name
      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 to be updated.
    UpdateCsvClassifierRequest:
      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. 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 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: Specifies the configuration of custom datatypes.
        CustomDatatypes:
          allOf:
          - $ref: '#/components/schemas/CustomDatatypes'
          - description: Specifies a list of supported custom datatypes.
      description: Specifies a custom CSV classifier to be updated.
    UpdateXMLClassifierRequest:
      type: object
      required:
      - Name
      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.
        RowTag:
          allOf:
          - $ref: '#/components/schemas/RowTag'
          - description: The XML tag designating the element that contains each record in an XML document being parsed. This cannot 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 to be updated.
    CustomDatatypes:
      type: array
      items:
        $ref: '#/components/schemas/NameString'
    NullableBoolean:
      type: boolean
    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
    CsvColumnDelimiter:
      type: string
      pattern: '[^\r\n]'
      minLength: 1
      maxLength: 1
    CsvHeaderOption:
      type: string
      enum:
      - UNKNOWN
      - PRESENT
      - ABSENT
    OperationTimeoutException: {}
    VersionMismatchException: {}
    CsvHeader:
      type: array
      items:
        $ref: '#/components/schemas/NameString'
    UpdateXMLClassifierRequest_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.
        RowTag:
          type: string
          description: The XML tag designating the element that contains each record in an XML document being parsed. This cannot 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
    UpdateClassifierRequest_2:
      type: object
      properties:
        GrokClassifier:
          $ref: '#/components/schemas/UpdateGrokClassifierRequest_2'
        XMLClassifier:
          $ref: '#/components/schemas/UpdateXMLClassifierRequest_2'
        JsonClassifier:
          $ref: '#/components/schemas/UpdateJsonClassifierRequest_2'
        CsvClassifier:
          $ref: '#/components/schemas/UpdateCsvClassifierRequest_2'
    UpdateGrokClassifierRequest_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the GrokClassifier.
        Classification:
          type: string
          description: An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
        GrokPattern:
          type: string
          description: The grok pattern used by this classifier.
        CustomPatterns:
          type: string
          description: Optional custom grok patterns used by this classifier.
      required:
      - Name
    EntityNotFoundException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
        FromFederationSource:
          type: boolean
          description: Indicates whether or not the exception relates to a federated source.
    UpdateJsonClassifierRequest_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the 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
    UpdateCsvClassifierRequest_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the 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: Specifies the configuration of custom datatypes.
        CustomDatatypes:
          type: array
          items:
            type: string
          description: Specifies a list of supported custom datatypes.
        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
  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-updateclassifier-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-updateclassifier-api-api-openapi.yml
x-hasEquivalentPaths: true