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.RegisterSchemaVersion API'
description:
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: '#X Amz Target=AWSGlue.RegisterSchemaVersion' paths: /#X-Amz-Target=AWSGlue.RegisterSchemaVersion: 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: RegisterSchemaVersion description:Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.
If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.
If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RegisterSchemaVersionResponse' examples: RegisterSchemaVersion200Example: summary: Default RegisterSchemaVersion 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: RegisterSchemaVersion480Example: summary: Default RegisterSchemaVersion 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: RegisterSchemaVersion481Example: summary: Default RegisterSchemaVersion 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: RegisterSchemaVersion482Example: summary: Default RegisterSchemaVersion 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: ResourceNumberLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceNumberLimitExceededException' examples: RegisterSchemaVersion483Example: summary: Default RegisterSchemaVersion 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: RegisterSchemaVersion484Example: summary: Default RegisterSchemaVersion 484 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '485': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: RegisterSchemaVersion485Example: summary: Default RegisterSchemaVersion 485 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegisterSchemaVersionInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.RegisterSchemaVersion summary: Amazon Glue Register Schema Version x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=AWSGlue.RegisterSchemaVersion' components: schemas: InternalServiceException: {} EntityNotFoundException: {} SchemaId: type: object properties: SchemaArn: allOf: - $ref: '#/components/schemas/GlueResourceArn' - description: The Amazon Resource Name (ARN) of the schema. One ofSchemaArn 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.
RegisterSchemaVersionResponse:
type: object
properties:
SchemaVersionId:
allOf:
- $ref: '#/components/schemas/SchemaVersionIdString'
- description: The unique ID that represents the version of this schema.
VersionNumber:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The version of this schema (for sync flow only, in case this is the first version).
Status:
allOf:
- $ref: '#/components/schemas/SchemaVersionStatus'
- description: The status of the schema version.
SchemaVersionIdString:
type: string
pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'
minLength: 36
maxLength: 36
ConcurrentModificationException: {}
SchemaVersionStatus:
type: string
enum:
- AVAILABLE
- PENDING
- FAILURE
- DELETING
RegisterSchemaVersionInput:
type: object
required:
- SchemaId
- SchemaDefinition
title: RegisterSchemaVersionInput
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. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
DataFormat setting for the SchemaName.
AccessDeniedException: {}
SchemaRegistryNameString:
type: string
pattern: '[a-zA-Z0-9-_$#.]+'
minLength: 1
maxLength: 255
GlueResourceArn:
type: string
pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
minLength: 1
maxLength: 10240
InvalidInputException: {}
VersionLongNumber:
type: integer
minimum: 1
maximum: 100000
ResourceNumberLimitExceededException: {}
SchemaDefinitionString:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 170000
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