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

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.DeleteSchemaVersions 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.DeleteSchemaVersions API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-deleteschemaversions-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-deleteschemaversions-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.DeleteSchemaVersions API'
paths:
  /#X-Amz-Target=AWSGlue.DeleteSchemaVersions:
    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: DeleteSchemaVersions
      description: 'Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions.


        When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API.


        You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database.


        If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSchemaVersionsResponse'
              examples:
                DeleteSchemaVersions200Example:
                  summary: Default DeleteSchemaVersions 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                DeleteSchemaVersions480Example:
                  summary: Default DeleteSchemaVersions 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: EntityNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
              examples:
                DeleteSchemaVersions481Example:
                  summary: Default DeleteSchemaVersions 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                DeleteSchemaVersions482Example:
                  summary: Default DeleteSchemaVersions 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
              examples:
                DeleteSchemaVersions483Example:
                  summary: Default DeleteSchemaVersions 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSchemaVersionsInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.DeleteSchemaVersions
      summary: Amazon Glue Delete Schema Versions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.DeleteSchemaVersions 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)
  /#DeleteSchemaVersions:
    post:
      operationId: post#DeleteSchemaVersions
      summary: Delete Schema Versions
      description: Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions. When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API. You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteSchemaVersionsResponse_2'
        '400':
          description: AccessDeniedException; ConcurrentModificationException; EntityNotFoundException; InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.DeleteSchemaVersions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteSchemaVersionsInput_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.DeleteSchemaVersions API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: DeleteSchemaVersions
    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
    SchemaVersionErrorList:
      type: array
      items:
        $ref: '#/components/schemas/SchemaVersionErrorItem'
    EntityNotFoundException: {}
    DeleteSchemaVersionsResponse:
      type: object
      properties:
        SchemaVersionErrors:
          allOf:
          - $ref: '#/components/schemas/SchemaVersionErrorList'
          - description: A list of <code>SchemaVersionErrorItem</code> objects, each containing an error and schema version.
    ErrorCodeString:
      type: string
    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
    DeleteSchemaVersionsInput:
      type: object
      required:
      - SchemaId
      - Versions
      title: DeleteSchemaVersionsInput
      properties:
        SchemaId:
          allOf:
          - $ref: '#/components/schemas/SchemaId'
          - description: This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
        Versions:
          allOf:
          - $ref: '#/components/schemas/VersionsString'
          - description: '<p>A version range may be supplied which may be of the format:</p> <ul> <li> <p>a single version number, 5</p> </li> <li> <p>a range, 5-8 : deletes versions 5, 6, 7, 8</p> </li> </ul>'
    ErrorMessageString:
      type: string
    SchemaVersionErrorItem:
      type: object
      properties:
        VersionNumber:
          allOf:
          - $ref: '#/components/schemas/VersionLongNumber'
          - description: The version number of the schema.
        ErrorDetails:
          allOf:
          - $ref: '#/components/schemas/ErrorDetails'
          - description: The details of the error for the schema version.
      description: An object that contains the error details for an operation on a schema version.
    AccessDeniedException: {}
    ErrorDetails:
      type: object
      properties:
        ErrorCode:
          allOf:
          - $ref: '#/components/schemas/ErrorCodeString'
          - description: The error code for an error.
        ErrorMessage:
          allOf:
          - $ref: '#/components/schemas/ErrorMessageString'
          - description: The error message for an error.
      description: An object containing error details.
    ConcurrentModificationException: {}
    VersionsString:
      type: string
      pattern: '[1-9][0-9]*|[1-9][0-9]*-[1-9][0-9]*'
      minLength: 1
      maxLength: 100000
    DeleteSchemaVersionsResponse_2:
      type: object
      properties:
        SchemaVersionErrors:
          type: array
          items:
            $ref: '#/components/schemas/SchemaVersionErrorItem_2'
          description: A list of SchemaVersionErrorItem objects, each containing an error and schema version.
    SchemaVersionErrorItem_2:
      type: object
      properties:
        VersionNumber:
          type: integer
          description: The version number of the schema.
        ErrorDetails:
          $ref: '#/components/schemas/ErrorDetails_2'
    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.
    ErrorDetails_2:
      type: object
      properties:
        ErrorCode:
          type: string
          description: The error code for an error.
        ErrorMessage:
          type: string
          description: The error message for an error.
    DeleteSchemaVersionsInput_2:
      type: object
      properties:
        SchemaId:
          $ref: '#/components/schemas/SchemaId_2'
        Versions:
          type: string
          description: 'A version range may be supplied which may be of the format: a single version number, 5 a range, 5-8 : deletes versions 5, 6, 7, 8'
      required:
      - SchemaId
      - Versions
  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-deleteschemaversions-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-deleteschemaversions-api-api-openapi.yml
x-hasEquivalentPaths: true