GetColumnStatisticsForPartition - AWS Glue

GetColumnStatisticsForPartition

Retrieves partition statistics of columns.

Request Syntax

{ "CatalogId": "string", "ColumnNames": [ "string" ], "DatabaseName": "string", "PartitionValues": [ "string" ], "TableName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

ColumnNames

A list of the column names.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

DatabaseName

The name of the catalog database where the partitions reside.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

PartitionValues

A list of partition values identifying the partition.

Type: Array of strings

Length Constraints: Maximum length of 1024.

Required: Yes

TableName

The name of the partitions' table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax

{ "ColumnStatisticsList": [ { "AnalyzedTime": number, "ColumnName": "string", "ColumnType": "string", "StatisticsData": { "BinaryColumnStatisticsData": { "AverageLength": number, "MaximumLength": number, "NumberOfNulls": number }, "BooleanColumnStatisticsData": { "NumberOfFalses": number, "NumberOfNulls": number, "NumberOfTrues": number }, "DateColumnStatisticsData": { "MaximumValue": number, "MinimumValue": number, "NumberOfDistinctValues": number, "NumberOfNulls": number }, "DecimalColumnStatisticsData": { "MaximumValue": { "Scale": number, "UnscaledValue": blob }, "MinimumValue": { "Scale": number, "UnscaledValue": blob }, "NumberOfDistinctValues": number, "NumberOfNulls": number }, "DoubleColumnStatisticsData": { "MaximumValue": number, "MinimumValue": number, "NumberOfDistinctValues": number, "NumberOfNulls": number }, "LongColumnStatisticsData": { "MaximumValue": number, "MinimumValue": number, "NumberOfDistinctValues": number, "NumberOfNulls": number }, "StringColumnStatisticsData": { "AverageLength": number, "MaximumLength": number, "NumberOfDistinctValues": number, "NumberOfNulls": number }, "Type": "string" } } ], "Errors": [ { "ColumnName": "string", "Error": { "ErrorCode": "string", "ErrorMessage": "string" } } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ColumnStatisticsList

List of ColumnStatistics that failed to be retrieved.

Type: Array of ColumnStatistics objects

Errors

Error occurred during retrieving column statistics data.

Type: Array of ColumnError objects

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

GlueEncryptionException

An encryption operation failed.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: