Glue / Client / get_column_statistics_task_settings

get_column_statistics_task_settings#

Glue.Client.get_column_statistics_task_settings(**kwargs)#

Gets settings for a column statistics task.

See also: AWS API Documentation

Request Syntax

response = client.get_column_statistics_task_settings(
    DatabaseName='string',
    TableName='string'
)
Parameters:

  • DatabaseName (string) –

    [REQUIRED]

    The name of the database where the table resides.

  • TableName (string) –

    [REQUIRED]

    The name of the table for which to retrieve column statistics.

Return type:

dict

Returns:

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'
    }
}

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.

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException

  • Glue.Client.exceptions.InvalidInputException

  • Glue.Client.exceptions.OperationTimeoutException