column_statistics_task_runs

Creates, updates, deletes, gets or lists a column_statistics_task_runs resource.

Overview

Name	column_statistics_task_runs
Type	Resource
Id	aws.glue.column_statistics_task_runs

Fields

The following fields are returned by SELECT queries:

get_column_statistics_task_runs

Name	Datatype	Description
column_statistics_task_runs	array	A list of column statistics task runs.
next_token	string	A continuation token, if not all task runs have yet been returned.

get_column_statistics_task_run

Name	Datatype	Description
catalog_id	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. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
column_name_list	array	A list of the column names. If none is supplied, all column names for the table will be used by default.
column_statistics_task_run_id	string	The identifier for the particular column statistics task run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
computation_type	string	The type of column statistics computation. (FULL, INCREMENTAL)
creation_time	string (date-time)	The time that this task was created.
customer_id	string	The Amazon Web Services account ID.
dpu_seconds	number (double)	The calculated DPU usage in seconds for all autoscaled workers.
database_name	string	The database where the table resides.
end_time	string (date-time)	The end time of the task.
error_message	string	The error message for the job. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
last_updated	string (date-time)	The last point in time when this task was modified.
number_of_workers	integer	The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
role	string	The IAM role that the service assumes to generate statistics.
sample_size	number (double)	The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
security_configuration	string	Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
start_time	string (date-time)	The start time of the task.
status	string	The status of the task run. (STARTING, RUNNING, SUCCEEDED, FAILED, STOPPED)
table_name	string	The name of the table for which column statistics is generated.
worker_type	string	The type of workers being used for generating stats. The default is g.1x. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)

list_column_statistics_task_runs

Name	Datatype	Description
column_statistics_task_run_id	string	A list of column statistics task run IDs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_column_statistics_task_runs	select	region		Retrieves information about all runs associated with the specified table.
get_column_statistics_task_run	select	region		Get the associated metadata/information for a task run, given a task run ID.
list_column_statistics_task_runs	select	region		List all task runs for a particular account.
start_column_statistics_task_run_schedule	exec	region, DatabaseName, TableName		Starts a column statistics task run schedule.
stop_column_statistics_task_run_schedule	exec	region, DatabaseName, TableName		Stops a column statistics task run schedule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_column_statistics_task_runs

Retrieves information about all runs associated with the specified table.

SELECT
column_statistics_task_runs,
next_token
FROM aws.glue.column_statistics_task_runs
WHERE region = '{{ region }}' -- required
;

get_column_statistics_task_run

Get the associated metadata/information for a task run, given a task run ID.

SELECT
catalog_id,
column_name_list,
column_statistics_task_run_id,
computation_type,
creation_time,
customer_id,
dpu_seconds,
database_name,
end_time,
error_message,
last_updated,
number_of_workers,
role,
sample_size,
security_configuration,
start_time,
status,
table_name,
worker_type
FROM aws.glue.column_statistics_task_runs
WHERE region = '{{ region }}' -- required
;

list_column_statistics_task_runs

List all task runs for a particular account.

SELECT
column_statistics_task_run_id
FROM aws.glue.column_statistics_task_runs
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

start_column_statistics_task_run_schedule

Starts a column statistics task run schedule.

EXEC aws.glue.column_statistics_task_runs.start_column_statistics_task_run_schedule 
@region='{{ region }}' --required 
@@json=
'{
"DatabaseName": "{{ DatabaseName }}", 
"TableName": "{{ TableName }}"
}'
;

stop_column_statistics_task_run_schedule

Stops a column statistics task run schedule.

EXEC aws.glue.column_statistics_task_runs.stop_column_statistics_task_run_schedule 
@region='{{ region }}' --required 
@@json=
'{
"DatabaseName": "{{ DatabaseName }}", 
"TableName": "{{ TableName }}"
}'
;