[ aws . glue ]

get-column-statistics-for-table

Description

Retrieves table statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is GetTable .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-column-statistics-for-table
[--catalog-id <value>]
--database-name <value>
--table-name <value>
--column-names <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--catalog-id (string)

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

--database-name (string)

The name of the catalog database where the partitions reside.

--table-name (string)

The name of the partitions’ table.

--column-names (list)

A list of the column names.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ColumnStatisticsList -> (list)

List of ColumnStatistics that failed to be retrieved.

(structure)

Represents the generated column-level statistics for a table or partition.

ColumnName -> (string)

Name of column which statistics belong to.

ColumnType -> (string)

The data type of the column.

AnalyzedTime -> (timestamp)

The timestamp of when column statistics were generated.

StatisticsData -> (structure)

A ColumnStatisticData object that contains the statistics data values.

Type -> (string)

The type of column statistics data.

BooleanColumnStatisticsData -> (structure)

Boolean column statistics data.

NumberOfTrues -> (long)

The number of true values in the column.

NumberOfFalses -> (long)

The number of false values in the column.

NumberOfNulls -> (long)

The number of null values in the column.

DateColumnStatisticsData -> (structure)

Date column statistics data.

MinimumValue -> (timestamp)

The lowest value in the column.

MaximumValue -> (timestamp)

The highest value in the column.

NumberOfNulls -> (long)

The number of null values in the column.

NumberOfDistinctValues -> (long)

The number of distinct values in a column.

DecimalColumnStatisticsData -> (structure)

Decimal column statistics data.

MinimumValue -> (structure)

The lowest value in the column.

UnscaledValue -> (blob)

The unscaled numeric value.

Scale -> (integer)

The scale that determines where the decimal point falls in the unscaled value.

MaximumValue -> (structure)

The highest value in the column.

UnscaledValue -> (blob)

The unscaled numeric value.

Scale -> (integer)

The scale that determines where the decimal point falls in the unscaled value.

NumberOfNulls -> (long)

The number of null values in the column.

NumberOfDistinctValues -> (long)

The number of distinct values in a column.

DoubleColumnStatisticsData -> (structure)

Double column statistics data.

MinimumValue -> (double)

The lowest value in the column.

MaximumValue -> (double)

The highest value in the column.

NumberOfNulls -> (long)

The number of null values in the column.

NumberOfDistinctValues -> (long)

The number of distinct values in a column.

LongColumnStatisticsData -> (structure)

Long column statistics data.

MinimumValue -> (long)

The lowest value in the column.

MaximumValue -> (long)

The highest value in the column.

NumberOfNulls -> (long)

The number of null values in the column.

NumberOfDistinctValues -> (long)

The number of distinct values in a column.

StringColumnStatisticsData -> (structure)

String column statistics data.

MaximumLength -> (long)

The size of the longest string in the column.

AverageLength -> (double)

The average string length in the column.

NumberOfNulls -> (long)

The number of null values in the column.

NumberOfDistinctValues -> (long)

The number of distinct values in a column.

BinaryColumnStatisticsData -> (structure)

Binary column statistics data.

MaximumLength -> (long)

The size of the longest bit sequence in the column.

AverageLength -> (double)

The average bit sequence length in the column.

NumberOfNulls -> (long)

The number of null values in the column.

Errors -> (list)

List of ColumnStatistics that failed to be retrieved.

(structure)

Encapsulates a column name that failed and the reason for failure.

ColumnName -> (string)

The name of the column that failed.

Error -> (structure)

An error message with the reason for the failure of an operation.

ErrorCode -> (string)

The code associated with this error.

ErrorMessage -> (string)

A message describing the error.