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.GetTable 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.GetTable' paths: /#X-Amz-Target=AWSGlue.GetTable: 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: GetTable description: Retrieves theTable definition in a Data Catalog for a specified table.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTableResponse'
examples:
GetTable200Example:
summary: Default GetTable 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
GetTable480Example:
summary: Default GetTable 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
GetTable481Example:
summary: Default GetTable 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
GetTable482Example:
summary: Default GetTable 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
GetTable483Example:
summary: Default GetTable 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: GlueEncryptionException
content:
application/json:
schema:
$ref: '#/components/schemas/GlueEncryptionException'
examples:
GetTable484Example:
summary: Default GetTable 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'485':
description: ResourceNotReadyException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotReadyException'
examples:
GetTable485Example:
summary: Default GetTable 485 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'486':
description: FederationSourceException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceException'
examples:
GetTable486Example:
summary: Default GetTable 486 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'487':
description: FederationSourceRetryableException
content:
application/json:
schema:
$ref: '#/components/schemas/FederationSourceRetryableException'
examples:
GetTable487Example:
summary: Default GetTable 487 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetTableRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.GetTable
summary: Amazon Glue Get Table
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSGlue.GetTable'
components:
schemas:
FederationIdentifier:
type: string
minLength: 1
maxLength: 512
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
IntegerFlag:
type: integer
minimum: 0
maximum: 1
StorageDescriptor:
type: object
properties:
Columns:
allOf:
- $ref: '#/components/schemas/ColumnList'
- description: A list of the Columns in the table.
Location:
allOf:
- $ref: '#/components/schemas/LocationString'
- description: The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
AdditionalLocations:
allOf:
- $ref: '#/components/schemas/LocationStringList'
- description: A list of locations that point to the path where a Delta table is located.
InputFormat:
allOf:
- $ref: '#/components/schemas/FormatString'
- description: 'The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.'
OutputFormat:
allOf:
- $ref: '#/components/schemas/FormatString'
- description: 'The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.'
Compressed:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: ' True if the data in the table is compressed, or False if not.'
NumberOfBuckets:
allOf:
- $ref: '#/components/schemas/Integer'
- description: Must be specified if the table contains any dimension columns.
SerdeInfo:
allOf:
- $ref: '#/components/schemas/SerDeInfo'
- description: The serialization/deserialization (SerDe) information.
BucketColumns:
allOf:
- $ref: '#/components/schemas/NameStringList'
- description: A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
SortColumns:
allOf:
- $ref: '#/components/schemas/OrderList'
- description: A list specifying the sort order of each bucket in the table.
Parameters:
allOf:
- $ref: '#/components/schemas/ParametersMap'
- description: The user-supplied properties in key-value form.
SkewedInfo:
allOf:
- $ref: '#/components/schemas/SkewedInfo'
- description: The information about values that appear frequently in a column (skewed values).
StoredAsSubDirectories:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: ' True if the table data is stored in subdirectories, or False if not.'
SchemaReference:
allOf:
- $ref: '#/components/schemas/SchemaReference'
- description: An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
description: Describes the physical storage of table data. ColumnList: type: array items: $ref: '#/components/schemas/Column' LocationStringList: type: array items: $ref: '#/components/schemas/LocationString' InternalServiceException: {} DescriptionString: type: string minLength: 0 maxLength: 2048 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' FormatString: type: string maxLength: 128 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*' ColumnTypeString: type: string minLength: 0 maxLength: 131072 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*' Boolean: type: boolean LocationString: type: string maxLength: 2056 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' FederatedTable: type: object properties: Identifier: allOf: - $ref: '#/components/schemas/FederationIdentifier' - description: A unique identifier for the federated table. DatabaseIdentifier: allOf: - $ref: '#/components/schemas/FederationIdentifier' - description: A unique identifier for the federated database. ConnectionName: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the connection to the external metastore. description: A table that points to an entity outside the Glue Data Catalog. ColumnValueStringList: type: array items: $ref: '#/components/schemas/ColumnValuesString' 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: {}
GetTableResponse:
type: object
properties:
Table:
allOf:
- $ref: '#/components/schemas/Table'
- description: The Table object that defines the specified table.
GetTableRequest:
type: object
required:
- DatabaseName
- Name
title: GetTableRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.
TransactionId:
allOf:
- $ref: '#/components/schemas/TransactionIdString'
- description: 'The transaction ID at which to read the table contents. '
QueryAsOfTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
NameStringList:
type: array
items:
$ref: '#/components/schemas/NameString'
OperationTimeoutException: {}
Column:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the Column.
Type:
allOf:
- $ref: '#/components/schemas/ColumnTypeString'
- description: The data type of the Column.
Comment:
allOf:
- $ref: '#/components/schemas/CommentString'
- description: A free-form text comment.
Parameters:
allOf:
- $ref: '#/components/schemas/ParametersMap'
- description: These key-value pairs define properties associated with the column.
description: A column in a Table.
FederationSourceException: {}
ParametersMapValue:
type: string
maxLength: 512000
CommentString:
type: string
minLength: 0
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
SkewedInfo:
type: object
properties:
SkewedColumnNames:
allOf:
- $ref: '#/components/schemas/NameStringList'
- description: A list of names of columns that contain skewed values.
SkewedColumnValues:
allOf:
- $ref: '#/components/schemas/ColumnValueStringList'
- description: A list of values that appear so frequently as to be considered skewed.
SkewedColumnValueLocationMaps:
allOf:
- $ref: '#/components/schemas/LocationMap'
- description: A mapping of skewed values to the columns that contain them.
description: Specifies skewed values in a table. Skewed values are those that occur with very high frequency.
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
FederationSourceRetryableException: {}
CatalogIdString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
OrderList:
type: array
items:
$ref: '#/components/schemas/Order'
TableIdentifier:
type: object
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the table resides.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the catalog database that contains the target table.
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the target table.
description: A structure that describes a target table for resource linking.
SchemaRegistryNameString:
type: string
pattern: '[a-zA-Z0-9-_$#.]+'
minLength: 1
maxLength: 255
SerDeInfo:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Name of the SerDe.
SerializationLibrary:
allOf:
- $ref: '#/components/schemas/NameString'
- description: Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
Parameters:
allOf:
- $ref: '#/components/schemas/ParametersMap'
- description: These key-value pairs define initialization parameters for the SerDe.
description: Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
SchemaReference:
type: object
properties:
SchemaId:
allOf:
- $ref: '#/components/schemas/SchemaId'
- description: A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaVersionId:
allOf:
- $ref: '#/components/schemas/SchemaVersionIdString'
- description: The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.
SchemaVersionNumber:
allOf:
- $ref: '#/components/schemas/VersionLongNumber'
- description: The version number of the schema.
description: An object that references a schema stored in the Glue Schema Registry.
ColumnValuesString:
type: string
ParametersMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ParametersMapValue'
GlueResourceArn:
type: string
pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
minLength: 1
maxLength: 10240
TransactionIdString:
type: string
pattern: '[\p{L}\p{N}\p{P}]*'
minLength: 1
maxLength: 255
GlueEncryptionException: {}
NameString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
VersionString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
Order:
type: object
required:
- Column
- SortOrder
properties:
Column:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the column.
SortOrder:
allOf:
- $ref: '#/components/schemas/IntegerFlag'
- description: Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).
description: Specifies the sort order of a sorted column.
Table:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: A description of the table.
Owner:
allOf:
- $ref: '#/components/schemas/NameString'
- description: The owner of the table.
CreateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the table definition was created in the Data Catalog.
UpdateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that the table was updated.
LastAccessTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that column statistics were computed for this table.
Retention:
allOf:
- $ref: '#/components/schemas/NonNegativeInteger'
- description: The retention time for this table.
StorageDescriptor:
allOf:
- $ref: '#/components/schemas/StorageDescriptor'
- description: A storage descriptor containing information about the physical storage of this table.
PartitionKeys:
allOf:
- $ref: '#/components/schemas/ColumnList'
- description: 'A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": []
VIRTUAL_VIEW, certain Athena configuration encoded in base64.
ViewExpandedText:
allOf:
- $ref: '#/components/schemas/ViewTextString'
- description: Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType:
allOf:
- $ref: '#/components/schemas/TableTypeString'
- description: The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED.
TableIdentifier structure that describes a target table for resource linking.
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: The ID of the Data Catalog in which the table resides.
VersionId:
allOf:
- $ref: '#/components/schemas/VersionString'
- description: The ID of the table version.
FederatedTable:
allOf:
- $ref: '#/components/schemas/FederatedTable'
- description: A FederatedTable structure that references an entity outside the Glue Data Catalog.
description: Represents a collection of related data organized in columns and rows.
ViewTextString:
type: string
maxLength: 409600
Timestamp:
type: string
format: date-time
Integer:
type: integer
LocationMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ColumnValuesString'
InvalidInputException: {}
VersionLongNumber:
type: integer
minimum: 1
maximum: 100000
NonNegativeInteger:
type: integer
minimum: 0
ResourceNotReadyException: {}
TableTypeString:
type: string
maxLength: 255
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