StartColumnStatisticsTaskRun
Starts a column statistics task run, for a specified table and columns.
Request Syntax
{
"CatalogID": "string",
"ColumnNameList": [ "string" ],
"DatabaseName": "string",
"Role": "string",
"SampleSize": number,
"SecurityConfiguration": "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 table 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
- ColumnNameList
-
A list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- DatabaseName
-
The name of the database where the table resides.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
- Role
-
The IAM role that the service assumes to generate statistics.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
- SampleSize
-
The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- SecurityConfiguration
-
Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- TableName
-
The name of the table to generate statistics.
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
{
"ColumnStatisticsTaskRunId": "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.
- ColumnStatisticsTaskRunId
-
The identifier for the column statistics task run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to a resource was denied.
HTTP Status Code: 400
- ColumnStatisticsTaskRunningException
-
An exception thrown when you try to start another job while running a column stats generation job.
HTTP Status Code: 400
- EntityNotFoundException
-
A specified entity does not exist
HTTP Status Code: 400
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
- ResourceNumberLimitExceededException
-
A resource numerical limit was exceeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
