2026/09/30 - AWS Glue - 11 updated api methods
Changes Enable Catalog ID for crawler, column statistics and materialized views.
{'Crawlers': {'CatalogId': 'string'}}
Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
See also: AWS API Documentation
Request Syntax
client.batch_get_crawlers(
CrawlerNames=[
'string',
]
)
list
[REQUIRED]
A list of crawler names, which might be the names returned from the ListCrawlers operation.
(string) --
dict
Response Syntax
{
'Crawlers': [
{
'Name': 'string',
'Role': 'string',
'Targets': {
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
],
'EnableAdditionalMetadata': [
'COMMENTS'|'RAWTYPES',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
],
'ConnectionName': 'string',
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'DeltaTargets': [
{
'DeltaTables': [
'string',
],
'ConnectionName': 'string',
'WriteManifest': True|False,
'CreateNativeDeltaTable': True|False
},
],
'IcebergTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
],
'HudiTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
]
},
'DatabaseName': 'string',
'Description': 'string',
'Classifiers': [
'string',
],
'RecrawlPolicy': {
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
'SchemaChangePolicy': {
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
'LineageConfiguration': {
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
'State': 'READY'|'RUNNING'|'STOPPING',
'TablePrefix': 'string',
'Schedule': {
'ScheduleExpression': 'string',
'State': 'SCHEDULED'|'NOT_SCHEDULED'|'TRANSITIONING'
},
'CrawlElapsedTime': 123,
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'LastCrawl': {
'Status': 'SUCCEEDED'|'CANCELLED'|'FAILED',
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string',
'MessagePrefix': 'string',
'StartTime': datetime(2015, 1, 1)
},
'Version': 123,
'Configuration': 'string',
'CrawlerSecurityConfiguration': 'string',
'LakeFormationConfiguration': {
'UseLakeFormationCredentials': True|False,
'AccountId': 'string'
},
'CatalogId': 'string'
},
],
'CrawlersNotFound': [
'string',
]
}
Response Structure
(dict) --
Crawlers (list) --
A list of crawler definitions.
(dict) --
Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the Glue Data Catalog.
Name (string) --
The name of the crawler.
Role (string) --
The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
Targets (dict) --
A collection of targets to crawl.
S3Targets (list) --
Specifies Amazon Simple Storage Service (Amazon S3) targets.
(dict) --
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
Path (string) --
The path to the Amazon S3 target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
ConnectionName (string) --
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize (integer) --
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
EnableAdditionalMetadata (list) --
Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
(string) --
MongoDBTargets (list) --
Specifies Amazon DocumentDB or MongoDB targets.
(dict) --
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path (string) --
The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
DynamoDBTargets (list) --
Specifies Amazon DynamoDB targets.
(dict) --
Specifies an Amazon DynamoDB table to crawl.
Path (string) --
The name of the DynamoDB table to crawl.
scanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
scanRate (float) --
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets (list) --
Specifies Glue Data Catalog targets.
(dict) --
Specifies an Glue Data Catalog target.
DatabaseName (string) --
The name of the database to be synchronized.
Tables (list) --
A list of the tables to be synchronized.
(string) --
ConnectionName (string) --
The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
DeltaTargets (list) --
Specifies Delta data store targets.
(dict) --
Specifies a Delta data store to crawl one or more Delta tables.
DeltaTables (list) --
A list of the Amazon S3 paths to the Delta tables.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Delta table target.
WriteManifest (boolean) --
Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable (boolean) --
Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets (list) --
Specifies Apache Iceberg data store targets.
(dict) --
Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
Paths (list) --
One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Iceberg target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets (list) --
Specifies Apache Hudi data store targets.
(dict) --
Specifies an Apache Hudi data source.
Paths (list) --
An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
DatabaseName (string) --
The name of the database in which the crawler's output is stored.
Description (string) --
A description of the crawler.
Classifiers (list) --
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
(string) --
RecrawlPolicy (dict) --
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior (string) --
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
SchemaChangePolicy (dict) --
The policy that specifies update and delete behaviors for the crawler.
UpdateBehavior (string) --
The update behavior when the crawler finds a changed schema.
DeleteBehavior (string) --
The deletion behavior when the crawler finds a deleted object.
LineageConfiguration (dict) --
A configuration that specifies whether data lineage is enabled for the crawler.
CrawlerLineageSettings (string) --
Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
State (string) --
Indicates whether the crawler is running, or whether a run is pending.
TablePrefix (string) --
The prefix added to the names of tables that are created.
Schedule (dict) --
For scheduled crawlers, the schedule when the crawler runs.
ScheduleExpression (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
State (string) --
The state of the schedule.
CrawlElapsedTime (integer) --
If the crawler is running, contains the total time elapsed since the last crawl began.
CreationTime (datetime) --
The time that the crawler was created.
LastUpdated (datetime) --
The time that the crawler was last updated.
LastCrawl (dict) --
The status of the last crawl, and potentially error information if an error occurred.
Status (string) --
Status of the last crawl.
ErrorMessage (string) --
If an error occurred, the error information about the last crawl.
LogGroup (string) --
The log group for the last crawl.
LogStream (string) --
The log stream for the last crawl.
MessagePrefix (string) --
The prefix for a message about this crawl.
StartTime (datetime) --
The time at which the crawl started.
Version (integer) --
The version of the crawler.
Configuration (string) --
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
CrawlerSecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used by this crawler.
LakeFormationConfiguration (dict) --
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
UseLakeFormationCredentials (boolean) --
Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId (string) --
Required for cross account crawls. For same account crawls as the target data, this can be left as null.
CatalogId (string) --
The ID of the Data Catalog in which the crawler's output is stored.
CrawlersNotFound (list) --
A list of names of crawlers that were not found.
(string) --
{'CatalogId': 'string'}
Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.
See also: AWS API Documentation
Request Syntax
client.create_crawler(
Name='string',
Role='string',
DatabaseName='string',
Description='string',
Targets={
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
],
'EnableAdditionalMetadata': [
'COMMENTS'|'RAWTYPES',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
],
'ConnectionName': 'string',
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'DeltaTargets': [
{
'DeltaTables': [
'string',
],
'ConnectionName': 'string',
'WriteManifest': True|False,
'CreateNativeDeltaTable': True|False
},
],
'IcebergTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
],
'HudiTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
]
},
Schedule='string',
Classifiers=[
'string',
],
TablePrefix='string',
SchemaChangePolicy={
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
RecrawlPolicy={
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
LineageConfiguration={
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
LakeFormationConfiguration={
'UseLakeFormationCredentials': True|False,
'AccountId': 'string'
},
Configuration='string',
CrawlerSecurityConfiguration='string',
Tags={
'string': 'string'
},
CatalogId='string'
)
string
[REQUIRED]
Name of the new crawler.
string
[REQUIRED]
The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
string
The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
string
A description of the new crawler.
dict
[REQUIRED]
A list of collection of targets to crawl.
S3Targets (list) --
Specifies Amazon Simple Storage Service (Amazon S3) targets.
(dict) --
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
Path (string) --
The path to the Amazon S3 target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
ConnectionName (string) --
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize (integer) --
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
EnableAdditionalMetadata (list) --
Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
(string) --
MongoDBTargets (list) --
Specifies Amazon DocumentDB or MongoDB targets.
(dict) --
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path (string) --
The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
DynamoDBTargets (list) --
Specifies Amazon DynamoDB targets.
(dict) --
Specifies an Amazon DynamoDB table to crawl.
Path (string) --
The name of the DynamoDB table to crawl.
scanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
scanRate (float) --
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets (list) --
Specifies Glue Data Catalog targets.
(dict) --
Specifies an Glue Data Catalog target.
DatabaseName (string) -- [REQUIRED]
The name of the database to be synchronized.
Tables (list) -- [REQUIRED]
A list of the tables to be synchronized.
(string) --
ConnectionName (string) --
The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
DeltaTargets (list) --
Specifies Delta data store targets.
(dict) --
Specifies a Delta data store to crawl one or more Delta tables.
DeltaTables (list) --
A list of the Amazon S3 paths to the Delta tables.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Delta table target.
WriteManifest (boolean) --
Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable (boolean) --
Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets (list) --
Specifies Apache Iceberg data store targets.
(dict) --
Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
Paths (list) --
One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Iceberg target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets (list) --
Specifies Apache Hudi data store targets.
(dict) --
Specifies an Apache Hudi data source.
Paths (list) --
An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
string
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
list
A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
(string) --
string
The table prefix used for catalog tables that are created.
dict
The policy for the crawler's update and deletion behavior.
UpdateBehavior (string) --
The update behavior when the crawler finds a changed schema.
DeleteBehavior (string) --
The deletion behavior when the crawler finds a deleted object.
dict
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior (string) --
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
dict
Specifies data lineage configuration settings for the crawler.
CrawlerLineageSettings (string) --
Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
dict
Specifies Lake Formation configuration settings for the crawler.
UseLakeFormationCredentials (boolean) --
Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId (string) --
Required for cross account crawls. For same account crawls as the target data, this can be left as null.
string
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
string
The name of the SecurityConfiguration structure to be used by this crawler.
dict
The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
(string) --
(string) --
string
The ID of the Data Catalog in which to store the crawler's output. If none is supplied, the Amazon Web Services account ID is used by default.
dict
Response Syntax
{}
Response Structure
(dict) --
{'CatalogID': 'string'}
Deletes settings for a column statistics task.
See also: AWS API Documentation
Request Syntax
client.delete_column_statistics_task_settings(
DatabaseName='string',
TableName='string',
CatalogID='string'
)
string
[REQUIRED]
The name of the database where the table resides.
string
[REQUIRED]
The name of the table for which to delete column statistics.
string
The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
dict
Response Syntax
{}
Response Structure
(dict) --
{'CatalogID': 'string'}
Retrieves information about all runs associated with the specified table.
See also: AWS API Documentation
Request Syntax
client.get_column_statistics_task_runs(
DatabaseName='string',
TableName='string',
MaxResults=123,
NextToken='string',
CatalogID='string'
)
string
[REQUIRED]
The name of the database where the table resides.
string
[REQUIRED]
The name of the table.
integer
The maximum size of the response.
string
A continuation token, if this is a continuation call.
string
The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
dict
Response Syntax
{
'ColumnStatisticsTaskRuns': [
{
'CustomerId': 'string',
'ColumnStatisticsTaskRunId': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'ColumnNameList': [
'string',
],
'CatalogID': 'string',
'Role': 'string',
'SampleSize': 123.0,
'SecurityConfiguration': 'string',
'NumberOfWorkers': 123,
'WorkerType': 'string',
'ComputationType': 'FULL'|'INCREMENTAL',
'Status': 'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'STOPPED',
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ErrorMessage': 'string',
'DPUSeconds': 123.0
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ColumnStatisticsTaskRuns (list) --
A list of column statistics task runs.
(dict) --
The object that shows the details of the column stats run.
CustomerId (string) --
The Amazon Web Services account ID.
ColumnStatisticsTaskRunId (string) --
The identifier for the particular column statistics task run.
DatabaseName (string) --
The database where the table resides.
TableName (string) --
The name of the table for which column statistics is generated.
ColumnNameList (list) --
A list of the column names. If none is supplied, all column names for the table will be used by default.
(string) --
CatalogID (string) --
The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
Role (string) --
The IAM role that the service assumes to generate statistics.
SampleSize (float) --
The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
SecurityConfiguration (string) --
Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
NumberOfWorkers (integer) --
The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
WorkerType (string) --
The type of workers being used for generating stats. The default is g.1x.
ComputationType (string) --
The type of column statistics computation.
Status (string) --
The status of the task run.
CreationTime (datetime) --
The time that this task was created.
LastUpdated (datetime) --
The last point in time when this task was modified.
StartTime (datetime) --
The start time of the task.
EndTime (datetime) --
The end time of the task.
ErrorMessage (string) --
The error message for the job.
DPUSeconds (float) --
The calculated DPU usage in seconds for all autoscaled workers.
NextToken (string) --
A continuation token, if not all task runs have yet been returned.
{'CatalogID': 'string'}
Gets settings for a column statistics task.
See also: AWS API Documentation
Request Syntax
client.get_column_statistics_task_settings(
DatabaseName='string',
TableName='string',
CatalogID='string'
)
string
[REQUIRED]
The name of the database where the table resides.
string
[REQUIRED]
The name of the table for which to retrieve column statistics.
string
The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
dict
Response Syntax
{
'ColumnStatisticsTaskSettings': {
'DatabaseName': 'string',
'TableName': 'string',
'Schedule': {
'ScheduleExpression': 'string',
'State': 'SCHEDULED'|'NOT_SCHEDULED'|'TRANSITIONING'
},
'ColumnNameList': [
'string',
],
'CatalogID': 'string',
'Role': 'string',
'SampleSize': 123.0,
'SecurityConfiguration': 'string',
'ScheduleType': 'CRON'|'AUTO',
'SettingSource': 'CATALOG'|'TABLE',
'LastExecutionAttempt': {
'Status': 'FAILED'|'STARTED',
'ColumnStatisticsTaskRunId': 'string',
'ExecutionTimestamp': datetime(2015, 1, 1),
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
ColumnStatisticsTaskSettings (dict) --
A ColumnStatisticsTaskSettings object representing the settings for the column statistics task.
DatabaseName (string) --
The name of the database where the table resides.
TableName (string) --
The name of the table for which to generate column statistics.
Schedule (dict) --
A schedule for running the column statistics, specified in CRON syntax.
ScheduleExpression (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
State (string) --
The state of the schedule.
ColumnNameList (list) --
A list of column names for which to run statistics.
(string) --
CatalogID (string) --
The ID of the Data Catalog in which the database resides.
Role (string) --
The role used for running the column statistics.
SampleSize (float) --
The percentage of data to sample.
SecurityConfiguration (string) --
Name of the security configuration that is used to encrypt CloudWatch logs.
ScheduleType (string) --
The type of schedule for a column statistics task. Possible values may be CRON or AUTO.
SettingSource (string) --
The source of setting the column statistics task. Possible values may be CATALOG or TABLE.
LastExecutionAttempt (dict) --
The last ExecutionAttempt for the column statistics task run.
Status (string) --
The status of the last column statistics task run.
ColumnStatisticsTaskRunId (string) --
A task run ID for the last column statistics task run.
ExecutionTimestamp (datetime) --
A timestamp when the last column statistics task run occurred.
ErrorMessage (string) --
An error message associated with the last column statistics task run.
{'Crawler': {'CatalogId': 'string'}}
Retrieves metadata for a specified crawler.
See also: AWS API Documentation
Request Syntax
client.get_crawler(
Name='string'
)
string
[REQUIRED]
The name of the crawler to retrieve metadata for.
dict
Response Syntax
{
'Crawler': {
'Name': 'string',
'Role': 'string',
'Targets': {
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
],
'EnableAdditionalMetadata': [
'COMMENTS'|'RAWTYPES',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
],
'ConnectionName': 'string',
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'DeltaTargets': [
{
'DeltaTables': [
'string',
],
'ConnectionName': 'string',
'WriteManifest': True|False,
'CreateNativeDeltaTable': True|False
},
],
'IcebergTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
],
'HudiTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
]
},
'DatabaseName': 'string',
'Description': 'string',
'Classifiers': [
'string',
],
'RecrawlPolicy': {
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
'SchemaChangePolicy': {
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
'LineageConfiguration': {
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
'State': 'READY'|'RUNNING'|'STOPPING',
'TablePrefix': 'string',
'Schedule': {
'ScheduleExpression': 'string',
'State': 'SCHEDULED'|'NOT_SCHEDULED'|'TRANSITIONING'
},
'CrawlElapsedTime': 123,
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'LastCrawl': {
'Status': 'SUCCEEDED'|'CANCELLED'|'FAILED',
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string',
'MessagePrefix': 'string',
'StartTime': datetime(2015, 1, 1)
},
'Version': 123,
'Configuration': 'string',
'CrawlerSecurityConfiguration': 'string',
'LakeFormationConfiguration': {
'UseLakeFormationCredentials': True|False,
'AccountId': 'string'
},
'CatalogId': 'string'
}
}
Response Structure
(dict) --
Crawler (dict) --
The metadata for the specified crawler.
Name (string) --
The name of the crawler.
Role (string) --
The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
Targets (dict) --
A collection of targets to crawl.
S3Targets (list) --
Specifies Amazon Simple Storage Service (Amazon S3) targets.
(dict) --
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
Path (string) --
The path to the Amazon S3 target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
ConnectionName (string) --
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize (integer) --
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
EnableAdditionalMetadata (list) --
Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
(string) --
MongoDBTargets (list) --
Specifies Amazon DocumentDB or MongoDB targets.
(dict) --
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path (string) --
The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
DynamoDBTargets (list) --
Specifies Amazon DynamoDB targets.
(dict) --
Specifies an Amazon DynamoDB table to crawl.
Path (string) --
The name of the DynamoDB table to crawl.
scanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
scanRate (float) --
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets (list) --
Specifies Glue Data Catalog targets.
(dict) --
Specifies an Glue Data Catalog target.
DatabaseName (string) --
The name of the database to be synchronized.
Tables (list) --
A list of the tables to be synchronized.
(string) --
ConnectionName (string) --
The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
DeltaTargets (list) --
Specifies Delta data store targets.
(dict) --
Specifies a Delta data store to crawl one or more Delta tables.
DeltaTables (list) --
A list of the Amazon S3 paths to the Delta tables.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Delta table target.
WriteManifest (boolean) --
Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable (boolean) --
Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets (list) --
Specifies Apache Iceberg data store targets.
(dict) --
Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
Paths (list) --
One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Iceberg target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets (list) --
Specifies Apache Hudi data store targets.
(dict) --
Specifies an Apache Hudi data source.
Paths (list) --
An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
DatabaseName (string) --
The name of the database in which the crawler's output is stored.
Description (string) --
A description of the crawler.
Classifiers (list) --
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
(string) --
RecrawlPolicy (dict) --
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior (string) --
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
SchemaChangePolicy (dict) --
The policy that specifies update and delete behaviors for the crawler.
UpdateBehavior (string) --
The update behavior when the crawler finds a changed schema.
DeleteBehavior (string) --
The deletion behavior when the crawler finds a deleted object.
LineageConfiguration (dict) --
A configuration that specifies whether data lineage is enabled for the crawler.
CrawlerLineageSettings (string) --
Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
State (string) --
Indicates whether the crawler is running, or whether a run is pending.
TablePrefix (string) --
The prefix added to the names of tables that are created.
Schedule (dict) --
For scheduled crawlers, the schedule when the crawler runs.
ScheduleExpression (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
State (string) --
The state of the schedule.
CrawlElapsedTime (integer) --
If the crawler is running, contains the total time elapsed since the last crawl began.
CreationTime (datetime) --
The time that the crawler was created.
LastUpdated (datetime) --
The time that the crawler was last updated.
LastCrawl (dict) --
The status of the last crawl, and potentially error information if an error occurred.
Status (string) --
Status of the last crawl.
ErrorMessage (string) --
If an error occurred, the error information about the last crawl.
LogGroup (string) --
The log group for the last crawl.
LogStream (string) --
The log stream for the last crawl.
MessagePrefix (string) --
The prefix for a message about this crawl.
StartTime (datetime) --
The time at which the crawl started.
Version (integer) --
The version of the crawler.
Configuration (string) --
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
CrawlerSecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used by this crawler.
LakeFormationConfiguration (dict) --
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
UseLakeFormationCredentials (boolean) --
Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId (string) --
Required for cross account crawls. For same account crawls as the target data, this can be left as null.
CatalogId (string) --
The ID of the Data Catalog in which the crawler's output is stored.
{'Crawlers': {'CatalogId': 'string'}}
Retrieves metadata for all crawlers defined in the customer account.
See also: AWS API Documentation
Request Syntax
client.get_crawlers(
MaxResults=123,
NextToken='string'
)
integer
The number of crawlers to return on each call.
string
A continuation token, if this is a continuation request.
dict
Response Syntax
{
'Crawlers': [
{
'Name': 'string',
'Role': 'string',
'Targets': {
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
],
'EnableAdditionalMetadata': [
'COMMENTS'|'RAWTYPES',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
],
'ConnectionName': 'string',
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'DeltaTargets': [
{
'DeltaTables': [
'string',
],
'ConnectionName': 'string',
'WriteManifest': True|False,
'CreateNativeDeltaTable': True|False
},
],
'IcebergTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
],
'HudiTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
]
},
'DatabaseName': 'string',
'Description': 'string',
'Classifiers': [
'string',
],
'RecrawlPolicy': {
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
'SchemaChangePolicy': {
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
'LineageConfiguration': {
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
'State': 'READY'|'RUNNING'|'STOPPING',
'TablePrefix': 'string',
'Schedule': {
'ScheduleExpression': 'string',
'State': 'SCHEDULED'|'NOT_SCHEDULED'|'TRANSITIONING'
},
'CrawlElapsedTime': 123,
'CreationTime': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'LastCrawl': {
'Status': 'SUCCEEDED'|'CANCELLED'|'FAILED',
'ErrorMessage': 'string',
'LogGroup': 'string',
'LogStream': 'string',
'MessagePrefix': 'string',
'StartTime': datetime(2015, 1, 1)
},
'Version': 123,
'Configuration': 'string',
'CrawlerSecurityConfiguration': 'string',
'LakeFormationConfiguration': {
'UseLakeFormationCredentials': True|False,
'AccountId': 'string'
},
'CatalogId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Crawlers (list) --
A list of crawler metadata.
(dict) --
Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the Glue Data Catalog.
Name (string) --
The name of the crawler.
Role (string) --
The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
Targets (dict) --
A collection of targets to crawl.
S3Targets (list) --
Specifies Amazon Simple Storage Service (Amazon S3) targets.
(dict) --
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
Path (string) --
The path to the Amazon S3 target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
ConnectionName (string) --
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize (integer) --
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
EnableAdditionalMetadata (list) --
Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
(string) --
MongoDBTargets (list) --
Specifies Amazon DocumentDB or MongoDB targets.
(dict) --
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path (string) --
The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
DynamoDBTargets (list) --
Specifies Amazon DynamoDB targets.
(dict) --
Specifies an Amazon DynamoDB table to crawl.
Path (string) --
The name of the DynamoDB table to crawl.
scanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
scanRate (float) --
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets (list) --
Specifies Glue Data Catalog targets.
(dict) --
Specifies an Glue Data Catalog target.
DatabaseName (string) --
The name of the database to be synchronized.
Tables (list) --
A list of the tables to be synchronized.
(string) --
ConnectionName (string) --
The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
DeltaTargets (list) --
Specifies Delta data store targets.
(dict) --
Specifies a Delta data store to crawl one or more Delta tables.
DeltaTables (list) --
A list of the Amazon S3 paths to the Delta tables.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Delta table target.
WriteManifest (boolean) --
Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable (boolean) --
Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets (list) --
Specifies Apache Iceberg data store targets.
(dict) --
Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
Paths (list) --
One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Iceberg target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets (list) --
Specifies Apache Hudi data store targets.
(dict) --
Specifies an Apache Hudi data source.
Paths (list) --
An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
DatabaseName (string) --
The name of the database in which the crawler's output is stored.
Description (string) --
A description of the crawler.
Classifiers (list) --
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
(string) --
RecrawlPolicy (dict) --
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior (string) --
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
SchemaChangePolicy (dict) --
The policy that specifies update and delete behaviors for the crawler.
UpdateBehavior (string) --
The update behavior when the crawler finds a changed schema.
DeleteBehavior (string) --
The deletion behavior when the crawler finds a deleted object.
LineageConfiguration (dict) --
A configuration that specifies whether data lineage is enabled for the crawler.
CrawlerLineageSettings (string) --
Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
State (string) --
Indicates whether the crawler is running, or whether a run is pending.
TablePrefix (string) --
The prefix added to the names of tables that are created.
Schedule (dict) --
For scheduled crawlers, the schedule when the crawler runs.
ScheduleExpression (string) --
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
State (string) --
The state of the schedule.
CrawlElapsedTime (integer) --
If the crawler is running, contains the total time elapsed since the last crawl began.
CreationTime (datetime) --
The time that the crawler was created.
LastUpdated (datetime) --
The time that the crawler was last updated.
LastCrawl (dict) --
The status of the last crawl, and potentially error information if an error occurred.
Status (string) --
Status of the last crawl.
ErrorMessage (string) --
If an error occurred, the error information about the last crawl.
LogGroup (string) --
The log group for the last crawl.
LogStream (string) --
The log stream for the last crawl.
MessagePrefix (string) --
The prefix for a message about this crawl.
StartTime (datetime) --
The time at which the crawl started.
Version (integer) --
The version of the crawler.
Configuration (string) --
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
CrawlerSecurityConfiguration (string) --
The name of the SecurityConfiguration structure to be used by this crawler.
LakeFormationConfiguration (dict) --
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
UseLakeFormationCredentials (boolean) --
Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId (string) --
Required for cross account crawls. For same account crawls as the target data, this can be left as null.
CatalogId (string) --
The ID of the Data Catalog in which the crawler's output is stored.
NextToken (string) --
A continuation token, if the returned list has not reached the end of those defined in this customer account.
{'CatalogID': 'string'}
Starts a column statistics task run schedule.
See also: AWS API Documentation
Request Syntax
client.start_column_statistics_task_run_schedule(
DatabaseName='string',
TableName='string',
CatalogID='string'
)
string
[REQUIRED]
The name of the database where the table resides.
string
[REQUIRED]
The name of the table for which to start a column statistic task run schedule.
string
The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
dict
Response Syntax
{}
Response Structure
(dict) --
{'CatalogID': 'string'}
Stops a task run for the specified table.
See also: AWS API Documentation
Request Syntax
client.stop_column_statistics_task_run(
DatabaseName='string',
TableName='string',
CatalogID='string'
)
string
[REQUIRED]
The name of the database where the table resides.
string
[REQUIRED]
The name of the table.
string
The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
dict
Response Syntax
{}
Response Structure
(dict) --
{'CatalogID': 'string'}
Stops a column statistics task run schedule.
See also: AWS API Documentation
Request Syntax
client.stop_column_statistics_task_run_schedule(
DatabaseName='string',
TableName='string',
CatalogID='string'
)
string
[REQUIRED]
The name of the database where the table resides.
string
[REQUIRED]
The name of the table for which to stop a column statistic task run schedule.
string
The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
dict
Response Syntax
{}
Response Structure
(dict) --
{'CatalogId': 'string'}
Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.
See also: AWS API Documentation
Request Syntax
client.update_crawler(
Name='string',
Role='string',
DatabaseName='string',
Description='string',
Targets={
'S3Targets': [
{
'Path': 'string',
'Exclusions': [
'string',
],
'ConnectionName': 'string',
'SampleSize': 123,
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'JdbcTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'Exclusions': [
'string',
],
'EnableAdditionalMetadata': [
'COMMENTS'|'RAWTYPES',
]
},
],
'MongoDBTargets': [
{
'ConnectionName': 'string',
'Path': 'string',
'ScanAll': True|False
},
],
'DynamoDBTargets': [
{
'Path': 'string',
'scanAll': True|False,
'scanRate': 123.0
},
],
'CatalogTargets': [
{
'DatabaseName': 'string',
'Tables': [
'string',
],
'ConnectionName': 'string',
'EventQueueArn': 'string',
'DlqEventQueueArn': 'string'
},
],
'DeltaTargets': [
{
'DeltaTables': [
'string',
],
'ConnectionName': 'string',
'WriteManifest': True|False,
'CreateNativeDeltaTable': True|False
},
],
'IcebergTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
],
'HudiTargets': [
{
'Paths': [
'string',
],
'ConnectionName': 'string',
'Exclusions': [
'string',
],
'MaximumTraversalDepth': 123
},
]
},
Schedule='string',
Classifiers=[
'string',
],
TablePrefix='string',
SchemaChangePolicy={
'UpdateBehavior': 'LOG'|'UPDATE_IN_DATABASE',
'DeleteBehavior': 'LOG'|'DELETE_FROM_DATABASE'|'DEPRECATE_IN_DATABASE'
},
RecrawlPolicy={
'RecrawlBehavior': 'CRAWL_EVERYTHING'|'CRAWL_NEW_FOLDERS_ONLY'|'CRAWL_EVENT_MODE'
},
LineageConfiguration={
'CrawlerLineageSettings': 'ENABLE'|'DISABLE'
},
LakeFormationConfiguration={
'UseLakeFormationCredentials': True|False,
'AccountId': 'string'
},
Configuration='string',
CrawlerSecurityConfiguration='string',
CatalogId='string'
)
string
[REQUIRED]
Name of the new crawler.
string
The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
string
The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.
string
A description of the new crawler.
dict
A list of targets to crawl.
S3Targets (list) --
Specifies Amazon Simple Storage Service (Amazon S3) targets.
(dict) --
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
Path (string) --
The path to the Amazon S3 target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
ConnectionName (string) --
The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize (integer) --
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
JdbcTargets (list) --
Specifies JDBC targets.
(dict) --
Specifies a JDBC data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the JDBC target.
Path (string) --
The path of the JDBC target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
EnableAdditionalMetadata (list) --
Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
(string) --
MongoDBTargets (list) --
Specifies Amazon DocumentDB or MongoDB targets.
(dict) --
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
ConnectionName (string) --
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path (string) --
The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
DynamoDBTargets (list) --
Specifies Amazon DynamoDB targets.
(dict) --
Specifies an Amazon DynamoDB table to crawl.
Path (string) --
The name of the DynamoDB table to crawl.
scanAll (boolean) --
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
scanRate (float) --
The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets (list) --
Specifies Glue Data Catalog targets.
(dict) --
Specifies an Glue Data Catalog target.
DatabaseName (string) -- [REQUIRED]
The name of the database to be synchronized.
Tables (list) -- [REQUIRED]
A list of the tables to be synchronized.
(string) --
ConnectionName (string) --
The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
EventQueueArn (string) --
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
DlqEventQueueArn (string) --
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
DeltaTargets (list) --
Specifies Delta data store targets.
(dict) --
Specifies a Delta data store to crawl one or more Delta tables.
DeltaTables (list) --
A list of the Amazon S3 paths to the Delta tables.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Delta table target.
WriteManifest (boolean) --
Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable (boolean) --
Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets (list) --
Specifies Apache Iceberg data store targets.
(dict) --
Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
Paths (list) --
One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Iceberg target.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets (list) --
Specifies Apache Hudi data store targets.
(dict) --
Specifies an Apache Hudi data source.
Paths (list) --
An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
(string) --
ConnectionName (string) --
The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions (list) --
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
(string) --
MaximumTraversalDepth (integer) --
The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
string
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
list
A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
(string) --
string
The table prefix used for catalog tables that are created.
dict
The policy for the crawler's update and deletion behavior.
UpdateBehavior (string) --
The update behavior when the crawler finds a changed schema.
DeleteBehavior (string) --
The deletion behavior when the crawler finds a deleted object.
dict
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior (string) --
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
dict
Specifies data lineage configuration settings for the crawler.
CrawlerLineageSettings (string) --
Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
dict
Specifies Lake Formation configuration settings for the crawler.
UseLakeFormationCredentials (boolean) --
Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId (string) --
Required for cross account crawls. For same account crawls as the target data, this can be left as null.
string
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
string
The name of the SecurityConfiguration structure to be used by this crawler.
string
The ID of the Data Catalog in which to store the crawler's output. If you omit this value, the existing value on the crawler is preserved.
dict
Response Syntax
{}
Response Structure
(dict) --