openapi: 3.2.0
info:
version: '2017-03-31'
x-release: v4
title: 'AWS Glue #X Amz Target=AWSGlue.SearchTables 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.SearchTables API'
paths:
/#X-Amz-Target=AWSGlue.SearchTables:
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: SearchTables
description: 'Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SearchTablesResponse'
examples:
SearchTables200Example:
summary: Default SearchTables 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
SearchTables480Example:
summary: Default SearchTables 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
SearchTables481Example:
summary: Default SearchTables 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
SearchTables482Example:
summary: Default SearchTables 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SearchTablesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.SearchTables
summary: Amazon Glue Search Tables
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- 'AWS Glue #X Amz Target=AWSGlue.SearchTables API'
components:
schemas:
FederationIdentifier:
type: string
minLength: 1
maxLength: 512
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
InvalidInputException: {}
GlueResourceArn:
type: string
pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
minLength: 1
maxLength: 10240
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.
ColumnTypeString:
type: string
minLength: 0
maxLength: 131072
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
DescriptionString:
type: string
minLength: 0
maxLength: 2048
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
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.
LocationString:
type: string
maxLength: 2056
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\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.
SearchTablesResponse:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, present if the current list segment is not the last.
TableList:
allOf:
- $ref: '#/components/schemas/TableList'
- description: A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.
PageSize:
type: integer
minimum: 1
maximum: 1000
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.
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
NonNegativeInteger:
type: integer
minimum: 0
SortCriterion:
type: object
properties:
FieldName:
allOf:
- $ref: '#/components/schemas/ValueString'
- description: The name of the field on which to sort.
Sort:
allOf:
- $ref: '#/components/schemas/Sort'
- description: An ascending or descending sort.
description: Specifies a field to sort by and a sort order.
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.
ValueString:
type: string
maxLength: 1024
SearchPropertyPredicates:
type: array
items:
$ref: '#/components/schemas/PropertyPredicate'
PropertyPredicate:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/ValueString'
- description: The key of the property.
Value:
allOf:
- $ref: '#/components/schemas/ValueString'
- description: The value of the property.
Comparator:
allOf:
- $ref: '#/components/schemas/Comparator'
- description: The comparator used to compare this property to others.
description: Defines a property predicate.
ColumnValuesString:
type: string
IntegerFlag:
type: integer
minimum: 0
maximum: 1
SearchTablesRequest:
type: object
title: SearchTablesRequest
properties:
CatalogId:
allOf:
- $ref: '#/components/schemas/CatalogIdString'
- description: A unique identifier, consisting of account_id .
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: A continuation token, included if this is a continuation call.
Filters:
allOf:
- $ref: '#/components/schemas/SearchPropertyPredicates'
- description: 'A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.
A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
SortCriteria: allOf: - $ref: '#/components/schemas/SortCriteria' - description: A list of criteria for sorting the results by a field name, in an ascending or descending order. MaxResults: allOf: - $ref: '#/components/schemas/PageSize' - description: The maximum number of tables to return in a single response. ResourceShareType: allOf: - $ref: '#/components/schemas/ResourceShareType' - description:Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.
If set to FOREIGN, will search the tables shared with your account.
If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.
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. Timestamp: type: string format: date-time SchemaReference: type: object properties: SchemaId: allOf: - $ref: '#/components/schemas/SchemaId' - description: A structure that contains schema identity fields. Either this or theSchemaVersionId 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.
ParametersMapValue:
type: string
maxLength: 512000
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.
SchemaRegistryNameString:
type: string
pattern: '[a-zA-Z0-9-_$#.]+'
minLength: 1
maxLength: 255
SortCriteria:
type: array
items:
$ref: '#/components/schemas/SortCriterion'
minItems: 0
maxItems: 1
VersionLongNumber:
type: integer
minimum: 1
maximum: 100000
ViewTextString:
type: string
maxLength: 409600
CommentString:
type: string
minLength: 0
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
TableTypeString:
type: string
maxLength: 255
Token:
type: string
Integer:
type: integer
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.
VersionString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
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.
LocationStringList:
type: array
items:
$ref: '#/components/schemas/LocationString'
NameString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
ColumnValueStringList:
type: array
items:
$ref: '#/components/schemas/ColumnValuesString'
Sort:
type: string
enum:
- ASC
- DESC
CatalogIdString:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
Boolean:
type: boolean
OperationTimeoutException: {}
LocationMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ColumnValuesString'
FormatString:
type: string
maxLength: 128
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
NameStringList:
type: array
items:
$ref: '#/components/schemas/NameString'
ParametersMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ParametersMapValue'
ColumnList:
type: array
items:
$ref: '#/components/schemas/Column'
TableList:
type: array
items:
$ref: '#/components/schemas/Table'
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