openapi: 3.2.0
info:
version: '2017-03-31'
x-release: v4
title: 'AWS Glue #X Amz Target=AWSGlue.GetSchemaVersionsDiff API'
description: 'Glue
Defines the public endpoint for the Glue service.'
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: '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'
components:
schemas:
SchemaDiffType:
type: string
enum:
- SYNTAX_DIFF
InvalidInputException: {}
GlueResourceArn:
type: string
pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
minLength: 1
maxLength: 10240
SchemaDefinitionDiff:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 340000
EntityNotFoundException: {}
InternalServiceException: {}
SchemaId:
type: object
properties:
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaName:
allOf:
- $ref: '#/components/schemas/SchemaRegistryNameString'
- description: The name of the schema. One of SchemaArn or SchemaName 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.
GetSchemaVersionsDiffResponse:
type: object
properties:
Diff:
allOf:
- $ref: '#/components/schemas/SchemaDefinitionDiff'
- description: The difference between schemas as a string in JsonPatch format.
LatestSchemaVersionBoolean:
type: boolean
SchemaRegistryNameString:
type: string
pattern: '[a-zA-Z0-9-_$#.]+'
minLength: 1
maxLength: 255
VersionLongNumber:
type: integer
minimum: 1
maximum: 100000
GetSchemaVersionsDiffInput:
type: object
required:
- SchemaId
- FirstSchemaVersionNumber
- SecondSchemaVersionNumber
- SchemaDiffType
title: GetSchemaVersionsDiffInput
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: '
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.
SYNTAX_DIFF, 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.
AccessDeniedException: {}
parameters:
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
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-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
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
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/glue/
x-hasEquivalentPaths: true