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

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.GetSchemaVersionsDiff 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.GetSchemaVersionsDiff API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-getschemaversionsdiff-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-getschemaversionsdiff-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.GetSchemaVersionsDiff API'
paths:
  /#X-Amz-Target=AWSGlue.GetSchemaVersionsDiff:
    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: GetSchemaVersionsDiff
      description: 'Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.


        This API allows you to compare two schema versions between two schema definitions under the same schema.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSchemaVersionsDiffResponse'
              examples:
                GetSchemaVersionsDiff200Example:
                  summary: Default GetSchemaVersionsDiff 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                GetSchemaVersionsDiff480Example:
                  summary: Default GetSchemaVersionsDiff 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: EntityNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
              examples:
                GetSchemaVersionsDiff481Example:
                  summary: Default GetSchemaVersionsDiff 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                GetSchemaVersionsDiff482Example:
                  summary: Default GetSchemaVersionsDiff 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                GetSchemaVersionsDiff483Example:
                  summary: Default GetSchemaVersionsDiff 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSchemaVersionsDiffInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetSchemaVersionsDiff
      summary: Amazon Glue Get Schema Versions Diff
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetSchemaVersionsDiff 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)
  /#GetSchemaVersionsDiff:
    post:
      operationId: post#GetSchemaVersionsDiff
      summary: Get Schema Versions Diff
      description: Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry. This API allows you to compare two schema versions between two schema definitions under the same schema.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetSchemaVersionsDiffResponse_2'
        '400':
          description: AccessDeniedException; EntityNotFoundException; InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException_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.GetSchemaVersionsDiff
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetSchemaVersionsDiffInput_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetSchemaVersionsDiff API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: GetSchemaVersionsDiff
    servers:
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    InvalidInputException: {}
    VersionLongNumber:
      type: integer
      minimum: 1
      maximum: 100000
    GlueResourceArn:
      type: string
      pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
      minLength: 1
      maxLength: 10240
    EntityNotFoundException: {}
    LatestSchemaVersionBoolean:
      type: boolean
    GetSchemaVersionsDiffResponse:
      type: object
      properties:
        Diff:
          allOf:
          - $ref: '#/components/schemas/SchemaDefinitionDiff'
          - description: The difference between schemas as a string in JsonPatch format.
    SchemaId:
      type: object
      properties:
        SchemaArn:
          allOf:
          - $ref: '#/components/schemas/GlueResourceArn'
          - description: The Amazon Resource Name (ARN) of the schema. One of <code>SchemaArn</code> or <code>SchemaName</code> has to be provided.
        SchemaName:
          allOf:
          - $ref: '#/components/schemas/SchemaRegistryNameString'
          - description: The name of the schema. One of <code>SchemaArn</code> or <code>SchemaName</code> has to be provided.
        RegistryName:
          allOf:
          - $ref: '#/components/schemas/SchemaRegistryNameString'
          - description: The name of the schema registry that contains the schema.
      description: The unique ID of the schema in the Glue schema registry.
    SchemaRegistryNameString:
      type: string
      pattern: '[a-zA-Z0-9-_$#.]+'
      minLength: 1
      maxLength: 255
    GetSchemaVersionsDiffInput:
      type: object
      required:
      - SchemaId
      - FirstSchemaVersionNumber
      - SecondSchemaVersionNumber
      - SchemaDiffType
      title: GetSchemaVersionsDiffInput
      properties:
        SchemaId:
          allOf:
          - $ref: '#/components/schemas/SchemaId'
          - description: '<p>This is a wrapper structure to contain schema identity fields. The structure contains:</p> <ul> <li> <p>SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of <code>SchemaArn</code> or <code>SchemaName</code> has to be provided.</p> </li> <li> <p>SchemaId$SchemaName: The name of the schema. One of <code>SchemaArn</code> or <code>SchemaName</code> has to be provided.</p> </li> </ul>'
        FirstSchemaVersionNumber:
          allOf:
          - $ref: '#/components/schemas/SchemaVersionNumber'
          - description: The first of the two schema versions to be compared.
        SecondSchemaVersionNumber:
          allOf:
          - $ref: '#/components/schemas/SchemaVersionNumber'
          - description: The second of the two schema versions to be compared.
        SchemaDiffType:
          allOf:
          - $ref: '#/components/schemas/SchemaDiffType'
          - description: Refers to <code>SYNTAX_DIFF</code>, which is the currently supported diff type.
    SchemaVersionNumber:
      type: object
      properties:
        LatestVersion:
          allOf:
          - $ref: '#/components/schemas/LatestSchemaVersionBoolean'
          - description: The latest version available for the schema.
        VersionNumber:
          allOf:
          - $ref: '#/components/schemas/VersionLongNumber'
          - description: The version number of the schema.
      description: A structure containing the schema version information.
    SchemaDefinitionDiff:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 340000
    InternalServiceException: {}
    AccessDeniedException: {}
    SchemaDiffType:
      type: string
      enum:
      - SYNTAX_DIFF
    GetSchemaVersionsDiffInput_2:
      type: object
      properties:
        SchemaId:
          $ref: '#/components/schemas/SchemaId_2'
        FirstSchemaVersionNumber:
          $ref: '#/components/schemas/SchemaVersionNumber_2'
        SecondSchemaVersionNumber:
          $ref: '#/components/schemas/SchemaVersionNumber_2'
        SchemaDiffType:
          type: string
          enum:
          - SYNTAX_DIFF
          description: Refers to SYNTAX_DIFF, which is the currently supported diff type.
      required:
      - SchemaId
      - FirstSchemaVersionNumber
      - SecondSchemaVersionNumber
      - SchemaDiffType
    SchemaVersionNumber_2:
      type: object
      properties:
        LatestVersion:
          type: boolean
          description: The latest version available for the schema.
        VersionNumber:
          type: integer
          description: The version number of the schema.
    SchemaId_2:
      type: object
      properties:
        SchemaArn:
          type: string
          description: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
        SchemaName:
          type: string
          description: The name of the schema. One of SchemaArn or SchemaName has to be provided.
        RegistryName:
          type: string
          description: The name of the schema registry that contains the schema.
    AccessDeniedException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    GetSchemaVersionsDiffResponse_2:
      type: object
      properties:
        Diff:
          type: string
          description: The difference between schemas as a string in JsonPatch format.
  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-getschemaversionsdiff-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-getschemaversionsdiff-api-api-openapi.yml
x-hasEquivalentPaths: true