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.GetSchemaVersion 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.GetSchemaVersion' paths: /#X-Amz-Target=AWSGlue.GetSchemaVersion: 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: GetSchemaVersion description: Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSchemaVersionResponse' examples: GetSchemaVersion200Example: summary: Default GetSchemaVersion 200 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: GetSchemaVersion480Example: summary: Default GetSchemaVersion 480 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetSchemaVersion481Example: summary: Default GetSchemaVersion 481 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '482': description: EntityNotFoundException content: application/json: schema: $ref: '#/components/schemas/EntityNotFoundException' examples: GetSchemaVersion482Example: summary: Default GetSchemaVersion 482 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED '483': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: GetSchemaVersion483Example: summary: Default GetSchemaVersion 483 response x-microcks-default: true value: JobRunId: jr_abc123 State: SUCCEEDED requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetSchemaVersionInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSGlue.GetSchemaVersion summary: Amazon Glue Get Schema Version x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=AWSGlue.GetSchemaVersion' components: schemas: CreatedTimestamp: type: string InternalServiceException: {} 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.
EntityNotFoundException: {}
GetSchemaVersionInput:
type: object
title: GetSchemaVersionInput
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.
SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.
SchemaVersionNumber:
allOf:
- $ref: '#/components/schemas/SchemaVersionNumber'
- description: The version number of the schema.
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
SchemaVersionStatus:
type: string
enum:
- AVAILABLE
- PENDING
- FAILURE
- DELETING
LatestSchemaVersionBoolean:
type: boolean
DataFormat:
type: string
enum:
- AVRO
- JSON
- PROTOBUF
SchemaRegistryNameString:
type: string
pattern: '[a-zA-Z0-9-_$#.]+'
minLength: 1
maxLength: 255
AccessDeniedException: {}
GlueResourceArn:
type: string
pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
minLength: 1
maxLength: 10240
InvalidInputException: {}
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.
GetSchemaVersionResponse:
type: object
properties:
SchemaVersionId:
allOf:
- $ref: '#/components/schemas/SchemaVersionIdString'
- description: The SchemaVersionId of the schema version.
SchemaDefinition:
allOf:
- $ref: '#/components/schemas/SchemaDefinitionString'
- description: The schema definition for the schema ID.
DataFormat:
allOf:
- $ref: '#/components/schemas/DataFormat'
- description: The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
SchemaArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: The Amazon Resource Name (ARN) of the schema.
VersionNumber:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The version number of the schema.
Status:
allOf:
- $ref: '#/components/schemas/SchemaVersionStatus'
- description: 'The status of the schema version. '
CreatedTime:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: The date and time the schema version was created.
VersionLongNumber:
type: integer
minimum: 1
maximum: 100000
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