AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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.
See also: AWS API Documentation
search-tables
[--catalog-id <value>]
[--next-token <value>]
[--filters <value>]
[--search-text <value>]
[--sort-criteria <value>]
[--max-results <value>]
[--resource-share-type <value>]
[--include-status-details | --no-include-status-details]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--catalog-id
(string)
A unique identifier, consisting of `` account_id `` .
--next-token
(string)
A continuation token, included if this is a continuation call.
--filters
(list)
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 thePropertyPredicate
struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as whenKey=Name
, a fuzzy match algorithm is used. TheKey
field (for example, the value of theName
field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with theValue
member ofPropertyPredicate
. For example, ifKey=Name
andValue=link
, tables namedcustomer-link
andxx-link-yy
are returned, butxxlinkyy
is not returned.(structure)
Defines a property predicate.
Key -> (string)
The key of the property.Value -> (string)
The value of the property.Comparator -> (string)
The comparator used to compare this property to others.
Shorthand Syntax:
Key=string,Value=string,Comparator=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string",
"Comparator": "EQUALS"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_EQUALS"|"LESS_THAN_EQUALS"
}
...
]
--search-text
(string)
A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
--sort-criteria
(list)
A list of criteria for sorting the results by a field name, in an ascending or descending order.
(structure)
Specifies a field to sort by and a sort order.
FieldName -> (string)
The name of the field on which to sort.Sort -> (string)
An ascending or descending sort.
Shorthand Syntax:
FieldName=string,Sort=string ...
JSON Syntax:
[
{
"FieldName": "string",
"Sort": "ASC"|"DESC"
}
...
]
--max-results
(integer)
The maximum number of tables to return in a single response.
--resource-share-type
(string)
Allows you to specify that you want to search the tables shared with your account. The allowable values are
FOREIGN
orALL
.
- 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.Possible values:
FOREIGN
ALL
FEDERATED
--include-status-details
| --no-include-status-details
(boolean)
Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
NextToken -> (string)
A continuation token, present if the current list segment is not the last.
TableList -> (list)
A list of the requested
Table
objects. TheSearchTables
response returns only the tables that you have access to.(structure)
Represents a collection of related data organized in columns and rows.
Name -> (string)
The table name. For Hive compatibility, this must be entirely lowercase.DatabaseName -> (string)
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.Description -> (string)
A description of the table.Owner -> (string)
The owner of the table.CreateTime -> (timestamp)
The time when the table definition was created in the Data Catalog.UpdateTime -> (timestamp)
The last time that the table was updated.LastAccessTime -> (timestamp)
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.LastAnalyzedTime -> (timestamp)
The last time that column statistics were computed for this table.Retention -> (integer)
The retention time for this table.StorageDescriptor -> (structure)
A storage descriptor containing information about the physical storage of this table.
Columns -> (list)
A list of the
Columns
in the table.(structure)
A column in a
Table
.Name -> (string)
The name of theColumn
.Type -> (string)
The data type of theColumn
.Comment -> (string)
A free-form text comment.Parameters -> (map)
These key-value pairs define properties associated with the column.
key -> (string)
value -> (string)
Location -> (string)
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 -> (list)
A list of locations that point to the path where a Delta table is located.
(string)
InputFormat -> (string)
The input format:SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat -> (string)
The output format:SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed -> (boolean)
True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets -> (integer)
Must be specified if the table contains any dimension columns.SerdeInfo -> (structure)
The serialization/deserialization (SerDe) information.
Name -> (string)
Name of the SerDe.SerializationLibrary -> (string)
Usually the class that implements the SerDe. An example isorg.apache.hadoop.hive.serde2.columnar.ColumnarSerDe
.Parameters -> (map)
These key-value pairs define initialization parameters for the SerDe.
key -> (string)
value -> (string)
BucketColumns -> (list)
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string)
SortColumns -> (list)
A list specifying the sort order of each bucket in the table.
(structure)
Specifies the sort order of a sorted column.
Column -> (string)
The name of the column.SortOrder -> (integer)
Indicates that the column is sorted in ascending order (== 1
), or in descending order (==0
).Parameters -> (map)
The user-supplied properties in key-value form.
key -> (string)
value -> (string)
SkewedInfo -> (structure)
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames -> (list)
A list of names of columns that contain skewed values.
(string)
SkewedColumnValues -> (list)
A list of values that appear so frequently as to be considered skewed.
(string)
SkewedColumnValueLocationMaps -> (map)
A mapping of skewed values to the columns that contain them.
key -> (string)
value -> (string)
StoredAsSubDirectories -> (boolean)
True
if the table data is stored in subdirectories, orFalse
if not.SchemaReference -> (structure)
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.
SchemaId -> (structure)
A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn -> (string)
The Amazon Resource Name (ARN) of the schema. One ofSchemaArn
orSchemaName
has to be provided.SchemaName -> (string)
The name of the schema. One ofSchemaArn
orSchemaName
has to be provided.RegistryName -> (string)
The name of the schema registry that contains the schema.SchemaVersionId -> (string)
The unique ID assigned to a version of the schema. Either this or theSchemaId
has to be provided.SchemaVersionNumber -> (long)
The version number of the schema.PartitionKeys -> (list)
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 ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
(structure)
A column in a
Table
.Name -> (string)
The name of theColumn
.Type -> (string)
The data type of theColumn
.Comment -> (string)
A free-form text comment.Parameters -> (map)
These key-value pairs define properties associated with the column.
key -> (string)
value -> (string)
ViewOriginalText -> (string)
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is aVIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText -> (string)
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.TableType -> (string)
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:
EXTERNAL_TABLEHive compatible attribute - indicates a non-Hive managed table.
GOVERNEDUsed by Lake Formation. The Glue Data Catalog understands
GOVERNED
.Parameters -> (map)
These key-value pairs define properties associated with the table.
key -> (string)
value -> (string)
CreatedBy -> (string)
The person or entity who created the table.IsRegisteredWithLakeFormation -> (boolean)
Indicates whether the table has been registered with Lake Formation.TargetTable -> (structure)
A
TableIdentifier
structure that describes a target table for resource linking.CatalogId -> (string)
The ID of the Data Catalog in which the table resides.DatabaseName -> (string)
The name of the catalog database that contains the target table.Name -> (string)
The name of the target table.Region -> (string)
Region of the target table.CatalogId -> (string)
The ID of the Data Catalog in which the table resides.VersionId -> (string)
The ID of the table version.FederatedTable -> (structure)
A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier -> (string)
A unique identifier for the federated table.DatabaseIdentifier -> (string)
A unique identifier for the federated database.ConnectionName -> (string)
The name of the connection to the external metastore.ViewDefinition -> (structure)
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected -> (boolean)
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.Definer -> (string)
The definer of a view in SQL.SubObjects -> (list)
A list of table Amazon Resource Names (ARNs).
(string)
Representations -> (list)
A list of representations.
(structure)
A structure that contains the dialect of the view, and the query that defines the view.
Dialect -> (string)
The dialect of the query engine.DialectVersion -> (string)
The version of the dialect of the query engine. For example, 3.0.0.ViewOriginalText -> (string)
TheSELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText -> (string)
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:
- Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection -> (string)
The name of the connection to be used to validate the specific representation of the view.IsStale -> (boolean)
Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.IsMultiDialectView -> (boolean)
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.Status -> (structure)
A structure containing information about the state of an asynchronous change to a table.
RequestedBy -> (string)
The ARN of the user who requested the asynchronous change.UpdatedBy -> (string)
The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).RequestTime -> (timestamp)
An ISO 8601 formatted date string indicating the time that the change was initiated.UpdateTime -> (timestamp)
An ISO 8601 formatted date string indicating the time that the state was last updated.Action -> (string)
Indicates which action was called on the table, currently onlyCREATE
orUPDATE
.State -> (string)
A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.Error -> (structure)
An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different
Error
s for each dialect.ErrorCode -> (string)
The code associated with this error.ErrorMessage -> (string)
A message describing the error.Details -> (structure)
A
StatusDetails
object with information about the requested change.RequestedChange -> (structure)
A
Table
object representing the requested changes.Name -> (string)
The table name. For Hive compatibility, this must be entirely lowercase.DatabaseName -> (string)
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.Description -> (string)
A description of the table.Owner -> (string)
The owner of the table.CreateTime -> (timestamp)
The time when the table definition was created in the Data Catalog.UpdateTime -> (timestamp)
The last time that the table was updated.LastAccessTime -> (timestamp)
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.LastAnalyzedTime -> (timestamp)
The last time that column statistics were computed for this table.Retention -> (integer)
The retention time for this table.StorageDescriptor -> (structure)
A storage descriptor containing information about the physical storage of this table.
Columns -> (list)
A list of the
Columns
in the table.(structure)
A column in a
Table
.Name -> (string)
The name of theColumn
.Type -> (string)
The data type of theColumn
.Comment -> (string)
A free-form text comment.Parameters -> (map)
These key-value pairs define properties associated with the column.
key -> (string)
value -> (string)
Location -> (string)
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 -> (list)
A list of locations that point to the path where a Delta table is located.
(string)
InputFormat -> (string)
The input format:SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat -> (string)
The output format:SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed -> (boolean)
True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets -> (integer)
Must be specified if the table contains any dimension columns.SerdeInfo -> (structure)
The serialization/deserialization (SerDe) information.
Name -> (string)
Name of the SerDe.SerializationLibrary -> (string)
Usually the class that implements the SerDe. An example isorg.apache.hadoop.hive.serde2.columnar.ColumnarSerDe
.Parameters -> (map)
These key-value pairs define initialization parameters for the SerDe.
key -> (string)
value -> (string)
BucketColumns -> (list)
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string)
SortColumns -> (list)
A list specifying the sort order of each bucket in the table.
(structure)
Specifies the sort order of a sorted column.
Column -> (string)
The name of the column.SortOrder -> (integer)
Indicates that the column is sorted in ascending order (== 1
), or in descending order (==0
).Parameters -> (map)
The user-supplied properties in key-value form.
key -> (string)
value -> (string)
SkewedInfo -> (structure)
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames -> (list)
A list of names of columns that contain skewed values.
(string)
SkewedColumnValues -> (list)
A list of values that appear so frequently as to be considered skewed.
(string)
SkewedColumnValueLocationMaps -> (map)
A mapping of skewed values to the columns that contain them.
key -> (string)
value -> (string)
StoredAsSubDirectories -> (boolean)
True
if the table data is stored in subdirectories, orFalse
if not.SchemaReference -> (structure)
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.
SchemaId -> (structure)
A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn -> (string)
The Amazon Resource Name (ARN) of the schema. One ofSchemaArn
orSchemaName
has to be provided.SchemaName -> (string)
The name of the schema. One ofSchemaArn
orSchemaName
has to be provided.RegistryName -> (string)
The name of the schema registry that contains the schema.SchemaVersionId -> (string)
The unique ID assigned to a version of the schema. Either this or theSchemaId
has to be provided.SchemaVersionNumber -> (long)
The version number of the schema.PartitionKeys -> (list)
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 ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
(structure)
A column in a
Table
.Name -> (string)
The name of theColumn
.Type -> (string)
The data type of theColumn
.Comment -> (string)
A free-form text comment.Parameters -> (map)
These key-value pairs define properties associated with the column.
key -> (string)
value -> (string)
ViewOriginalText -> (string)
Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is aVIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText -> (string)
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.TableType -> (string)
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:
EXTERNAL_TABLEHive compatible attribute - indicates a non-Hive managed table.
GOVERNEDUsed by Lake Formation. The Glue Data Catalog understands
GOVERNED
.Parameters -> (map)
These key-value pairs define properties associated with the table.
key -> (string)
value -> (string)
CreatedBy -> (string)
The person or entity who created the table.IsRegisteredWithLakeFormation -> (boolean)
Indicates whether the table has been registered with Lake Formation.TargetTable -> (structure)
A
TableIdentifier
structure that describes a target table for resource linking.CatalogId -> (string)
The ID of the Data Catalog in which the table resides.DatabaseName -> (string)
The name of the catalog database that contains the target table.Name -> (string)
The name of the target table.Region -> (string)
Region of the target table.CatalogId -> (string)
The ID of the Data Catalog in which the table resides.VersionId -> (string)
The ID of the table version.FederatedTable -> (structure)
A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier -> (string)
A unique identifier for the federated table.DatabaseIdentifier -> (string)
A unique identifier for the federated database.ConnectionName -> (string)
The name of the connection to the external metastore.ViewDefinition -> (structure)
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected -> (boolean)
You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.Definer -> (string)
The definer of a view in SQL.SubObjects -> (list)
A list of table Amazon Resource Names (ARNs).
(string)
Representations -> (list)
A list of representations.
(structure)
A structure that contains the dialect of the view, and the query that defines the view.
Dialect -> (string)
The dialect of the query engine.DialectVersion -> (string)
The version of the dialect of the query engine. For example, 3.0.0.ViewOriginalText -> (string)
TheSELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText -> (string)
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:
- Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection -> (string)
The name of the connection to be used to validate the specific representation of the view.IsStale -> (boolean)
Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.IsMultiDialectView -> (boolean)
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.Status -> (structure)
A structure containing information about the state of an asynchronous change to a table.
RequestedBy -> (string)
The ARN of the user who requested the asynchronous change.UpdatedBy -> (string)
The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).RequestTime -> (timestamp)
An ISO 8601 formatted date string indicating the time that the change was initiated.UpdateTime -> (timestamp)
An ISO 8601 formatted date string indicating the time that the state was last updated.Action -> (string)
Indicates which action was called on the table, currently onlyCREATE
orUPDATE
.State -> (string)
A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.Error -> (structure)
An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different
Error
s for each dialect.ErrorCode -> (string)
The code associated with this error.ErrorMessage -> (string)
A message describing the error.Details -> (structure)
A
StatusDetails
object with information about the requested change.( ... recursive ... )ViewValidations -> (list)
A list of
ViewValidation
objects that contain information for an analytical engine to validate a view.(structure)
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct
UpdateTable
orCreateTable
API calls.Dialect -> (string)
The dialect of the query engine.DialectVersion -> (string)
The version of the dialect of the query engine. For example, 3.0.0.ViewValidationText -> (string)
TheSELECT
query that defines the view, as provided by the customer.UpdateTime -> (timestamp)
The time of the last update.State -> (string)
The state of the validation.Error -> (structure)
An error associated with the validation.
ErrorCode -> (string)
The code associated with this error.ErrorMessage -> (string)
A message describing the error.ViewValidations -> (list)
A list of
ViewValidation
objects that contain information for an analytical engine to validate a view.(structure)
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct
UpdateTable
orCreateTable
API calls.Dialect -> (string)
The dialect of the query engine.DialectVersion -> (string)
The version of the dialect of the query engine. For example, 3.0.0.ViewValidationText -> (string)
TheSELECT
query that defines the view, as provided by the customer.UpdateTime -> (timestamp)
The time of the last update.State -> (string)
The state of the validation.Error -> (structure)
An error associated with the validation.
ErrorCode -> (string)
The code associated with this error.ErrorMessage -> (string)
A message describing the error.