Get the associated metadata/information for a task run, given a task run ID.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetColumnStatisticsTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetColumnStatisticsTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const input = { // GetColumnStatisticsTaskRunRequest + * ColumnStatisticsTaskRunId: "STRING_VALUE", // required + * }; + * const command = new GetColumnStatisticsTaskRunCommand(input); + * const response = await client.send(command); + * // { // GetColumnStatisticsTaskRunResponse + * // ColumnStatisticsTaskRun: { // ColumnStatisticsTaskRun + * // CustomerId: "STRING_VALUE", + * // ColumnStatisticsTaskRunId: "STRING_VALUE", + * // DatabaseName: "STRING_VALUE", + * // TableName: "STRING_VALUE", + * // ColumnNameList: [ // ColumnNameList + * // "STRING_VALUE", + * // ], + * // CatalogID: "STRING_VALUE", + * // Role: "STRING_VALUE", + * // SampleSize: Number("double"), + * // SecurityConfiguration: "STRING_VALUE", + * // NumberOfWorkers: Number("int"), + * // WorkerType: "STRING_VALUE", + * // Status: "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED" || "STOPPED", + * // CreationTime: new Date("TIMESTAMP"), + * // LastUpdated: new Date("TIMESTAMP"), + * // StartTime: new Date("TIMESTAMP"), + * // EndTime: new Date("TIMESTAMP"), + * // ErrorMessage: "STRING_VALUE", + * // DPUSeconds: Number("double"), + * // }, + * // }; + * + * ``` + * + * @param GetColumnStatisticsTaskRunCommandInput - {@link GetColumnStatisticsTaskRunCommandInput} + * @returns {@link GetColumnStatisticsTaskRunCommandOutput} + * @see {@link GetColumnStatisticsTaskRunCommandInput} for command's `input` shape. + * @see {@link GetColumnStatisticsTaskRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape. + * + * @throws {@link EntityNotFoundException} (client fault) + *A specified entity does not exist
+ * + * @throws {@link InvalidInputException} (client fault) + *The input provided was not valid.
+ * + * @throws {@link OperationTimeoutException} (client fault) + *The operation timed out.
+ * + * @throws {@link GlueServiceException} + *Base exception class for all service exceptions from Glue service.
+ * + */ +export class GetColumnStatisticsTaskRunCommand extends $Command< + GetColumnStatisticsTaskRunCommandInput, + GetColumnStatisticsTaskRunCommandOutput, + GlueClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetColumnStatisticsTaskRunCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieves information about all runs associated with the specified table.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetColumnStatisticsTaskRunsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetColumnStatisticsTaskRunsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const input = { // GetColumnStatisticsTaskRunsRequest + * DatabaseName: "STRING_VALUE", // required + * TableName: "STRING_VALUE", // required + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new GetColumnStatisticsTaskRunsCommand(input); + * const response = await client.send(command); + * // { // GetColumnStatisticsTaskRunsResponse + * // ColumnStatisticsTaskRuns: [ // ColumnStatisticsTaskRunsList + * // { // ColumnStatisticsTaskRun + * // CustomerId: "STRING_VALUE", + * // ColumnStatisticsTaskRunId: "STRING_VALUE", + * // DatabaseName: "STRING_VALUE", + * // TableName: "STRING_VALUE", + * // ColumnNameList: [ // ColumnNameList + * // "STRING_VALUE", + * // ], + * // CatalogID: "STRING_VALUE", + * // Role: "STRING_VALUE", + * // SampleSize: Number("double"), + * // SecurityConfiguration: "STRING_VALUE", + * // NumberOfWorkers: Number("int"), + * // WorkerType: "STRING_VALUE", + * // Status: "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED" || "STOPPED", + * // CreationTime: new Date("TIMESTAMP"), + * // LastUpdated: new Date("TIMESTAMP"), + * // StartTime: new Date("TIMESTAMP"), + * // EndTime: new Date("TIMESTAMP"), + * // ErrorMessage: "STRING_VALUE", + * // DPUSeconds: Number("double"), + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetColumnStatisticsTaskRunsCommandInput - {@link GetColumnStatisticsTaskRunsCommandInput} + * @returns {@link GetColumnStatisticsTaskRunsCommandOutput} + * @see {@link GetColumnStatisticsTaskRunsCommandInput} for command's `input` shape. + * @see {@link GetColumnStatisticsTaskRunsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape. + * + * @throws {@link OperationTimeoutException} (client fault) + *The operation timed out.
+ * + * @throws {@link GlueServiceException} + *Base exception class for all service exceptions from Glue service.
+ * + */ +export class GetColumnStatisticsTaskRunsCommand extends $Command< + GetColumnStatisticsTaskRunsCommandInput, + GetColumnStatisticsTaskRunsCommandOutput, + GlueClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetColumnStatisticsTaskRunsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackList all task runs for a particular account.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListColumnStatisticsTaskRunsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListColumnStatisticsTaskRunsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const input = { // ListColumnStatisticsTaskRunsRequest + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListColumnStatisticsTaskRunsCommand(input); + * const response = await client.send(command); + * // { // ListColumnStatisticsTaskRunsResponse + * // ColumnStatisticsTaskRunIds: [ // ColumnStatisticsTaskRunIdList + * // "STRING_VALUE", + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListColumnStatisticsTaskRunsCommandInput - {@link ListColumnStatisticsTaskRunsCommandInput} + * @returns {@link ListColumnStatisticsTaskRunsCommandOutput} + * @see {@link ListColumnStatisticsTaskRunsCommandInput} for command's `input` shape. + * @see {@link ListColumnStatisticsTaskRunsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape. + * + * @throws {@link OperationTimeoutException} (client fault) + *The operation timed out.
+ * + * @throws {@link GlueServiceException} + *Base exception class for all service exceptions from Glue service.
+ * + */ +export class ListColumnStatisticsTaskRunsCommand extends $Command< + ListColumnStatisticsTaskRunsCommandInput, + ListColumnStatisticsTaskRunsCommandOutput, + GlueClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListColumnStatisticsTaskRunsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackStarts a column statistics task run, for a specified table and columns.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartColumnStatisticsTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartColumnStatisticsTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const input = { // StartColumnStatisticsTaskRunRequest + * DatabaseName: "STRING_VALUE", // required + * TableName: "STRING_VALUE", // required + * ColumnNameList: [ // ColumnNameList + * "STRING_VALUE", + * ], + * Role: "STRING_VALUE", // required + * SampleSize: Number("double"), + * CatalogID: "STRING_VALUE", + * SecurityConfiguration: "STRING_VALUE", + * }; + * const command = new StartColumnStatisticsTaskRunCommand(input); + * const response = await client.send(command); + * // { // StartColumnStatisticsTaskRunResponse + * // ColumnStatisticsTaskRunId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param StartColumnStatisticsTaskRunCommandInput - {@link StartColumnStatisticsTaskRunCommandInput} + * @returns {@link StartColumnStatisticsTaskRunCommandOutput} + * @see {@link StartColumnStatisticsTaskRunCommandInput} for command's `input` shape. + * @see {@link StartColumnStatisticsTaskRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Access to a resource was denied.
+ * + * @throws {@link ColumnStatisticsTaskRunningException} (client fault) + *An exception thrown when you try to start another job while running a column stats generation job.
+ * + * @throws {@link EntityNotFoundException} (client fault) + *A specified entity does not exist
+ * + * @throws {@link InvalidInputException} (client fault) + *The input provided was not valid.
+ * + * @throws {@link OperationTimeoutException} (client fault) + *The operation timed out.
+ * + * @throws {@link ResourceNumberLimitExceededException} (client fault) + *A resource numerical limit was exceeded.
+ * + * @throws {@link GlueServiceException} + *Base exception class for all service exceptions from Glue service.
+ * + */ +export class StartColumnStatisticsTaskRunCommand extends $Command< + StartColumnStatisticsTaskRunCommandInput, + StartColumnStatisticsTaskRunCommandOutput, + GlueClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartColumnStatisticsTaskRunCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackStops a task run for the specified table.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StopColumnStatisticsTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StopColumnStatisticsTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const input = { // StopColumnStatisticsTaskRunRequest + * DatabaseName: "STRING_VALUE", // required + * TableName: "STRING_VALUE", // required + * }; + * const command = new StopColumnStatisticsTaskRunCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param StopColumnStatisticsTaskRunCommandInput - {@link StopColumnStatisticsTaskRunCommandInput} + * @returns {@link StopColumnStatisticsTaskRunCommandOutput} + * @see {@link StopColumnStatisticsTaskRunCommandInput} for command's `input` shape. + * @see {@link StopColumnStatisticsTaskRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape. + * + * @throws {@link ColumnStatisticsTaskNotRunningException} (client fault) + *An exception thrown when you try to stop a task run when there is no task running.
+ * + * @throws {@link ColumnStatisticsTaskStoppingException} (client fault) + *An exception thrown when you try to stop a task run.
+ * + * @throws {@link EntityNotFoundException} (client fault) + *A specified entity does not exist
+ * + * @throws {@link OperationTimeoutException} (client fault) + *The operation timed out.
+ * + * @throws {@link GlueServiceException} + *Base exception class for all service exceptions from Glue service.
+ * + */ +export class StopColumnStatisticsTaskRunCommand extends $Command< + StopColumnStatisticsTaskRunCommandInput, + StopColumnStatisticsTaskRunCommandOutput, + GlueClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StopColumnStatisticsTaskRunCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe identifier for the particular column statistics task run.
+ */ + ColumnStatisticsTaskRunId: string | undefined; +} + +/** + * @public + * @enum + */ +export const ColumnStatisticsState = { + FAILED: "FAILED", + RUNNING: "RUNNING", + STARTING: "STARTING", + STOPPED: "STOPPED", + SUCCEEDED: "SUCCEEDED", +} as const; + +/** + * @public + */ +export type ColumnStatisticsState = (typeof ColumnStatisticsState)[keyof typeof ColumnStatisticsState]; + +/** + * @public + *The object that shows the details of the column stats run.
+ */ +export interface ColumnStatisticsTaskRun { + /** + * @public + *The Amazon Web Services account ID.
+ */ + CustomerId?: string; + + /** + * @public + *The identifier for the particular column statistics task run.
+ */ + ColumnStatisticsTaskRunId?: string; + + /** + * @public + *The database where the table resides.
+ */ + DatabaseName?: string; + + /** + * @public + *The name of the table for which column statistics is generated.
+ */ + TableName?: string; + + /** + * @public + *A list of the column names. If none is supplied, all column names for the table will be used by default.
+ */ + ColumnNameList?: string[]; + + /** + * @public + *The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
+ */ + CatalogID?: string; + + /** + * @public + *The IAM role that the service assumes to generate statistics.
+ */ + Role?: string; + + /** + * @public + *The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
+ */ + SampleSize?: number; + + /** + * @public + *Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
+ */ + SecurityConfiguration?: string; + + /** + * @public + *The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
+ */ + NumberOfWorkers?: number; + + /** + * @public + *The type of workers being used for generating stats. The default is g.1x.
The status of the task run.
+ */ + Status?: ColumnStatisticsState; + + /** + * @public + *The time that this task was created.
+ */ + CreationTime?: Date; + + /** + * @public + *The last point in time when this task was modified.
+ */ + LastUpdated?: Date; + + /** + * @public + *The start time of the task.
+ */ + StartTime?: Date; + + /** + * @public + *The end time of the task.
+ */ + EndTime?: Date; + + /** + * @public + *The error message for the job.
+ */ + ErrorMessage?: string; + + /** + * @public + *The calculated DPU usage in seconds for all autoscaled workers.
+ */ + DPUSeconds?: number; +} + +/** + * @public + */ +export interface GetColumnStatisticsTaskRunResponse { + /** + * @public + *A ColumnStatisticsTaskRun object representing the details of the column stats run.
The name of the database where the table resides.
+ */ + DatabaseName: string | undefined; + + /** + * @public + *The name of the table.
+ */ + TableName: string | undefined; + + /** + * @public + *The maximum size of the response.
+ */ + MaxResults?: number; + + /** + * @public + *A continuation token, if this is a continuation call.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface GetColumnStatisticsTaskRunsResponse { + /** + * @public + *A list of column statistics task runs.
+ */ + ColumnStatisticsTaskRuns?: ColumnStatisticsTaskRun[]; + + /** + * @public + *A continuation token, if not all task runs have yet been returned.
+ */ + NextToken?: string; +} + /** * @public */ @@ -7909,172 +8108,3 @@ export interface GetStatementRequest { */ RequestOrigin?: string; } - -/** - * @public - *The code execution output in JSON format.
- */ -export interface StatementOutputData { - /** - * @public - *The code execution output in text format.
- */ - TextPlain?: string; -} - -/** - * @public - * @enum - */ -export const StatementState = { - AVAILABLE: "AVAILABLE", - CANCELLED: "CANCELLED", - CANCELLING: "CANCELLING", - ERROR: "ERROR", - RUNNING: "RUNNING", - WAITING: "WAITING", -} as const; - -/** - * @public - */ -export type StatementState = (typeof StatementState)[keyof typeof StatementState]; - -/** - * @public - *The code execution output in JSON format.
- */ -export interface StatementOutput { - /** - * @public - *The code execution output.
- */ - Data?: StatementOutputData; - - /** - * @public - *The execution count of the output.
- */ - ExecutionCount?: number; - - /** - * @public - *The status of the code execution output.
- */ - Status?: StatementState; - - /** - * @public - *The name of the error in the output.
- */ - ErrorName?: string; - - /** - * @public - *The error value of the output.
- */ - ErrorValue?: string; - - /** - * @public - *The traceback of the output.
- */ - Traceback?: string[]; -} - -/** - * @public - *The statement or request for a particular action to occur in a session.
- */ -export interface Statement { - /** - * @public - *The ID of the statement.
- */ - Id?: number; - - /** - * @public - *The execution code of the statement.
- */ - Code?: string; - - /** - * @public - *The state while request is actioned.
- */ - State?: StatementState; - - /** - * @public - *The output in JSON.
- */ - Output?: StatementOutput; - - /** - * @public - *The code execution progress.
- */ - Progress?: number; - - /** - * @public - *The unix time and date that the job definition was started.
- */ - StartedOn?: number; - - /** - * @public - *The unix time and date that the job definition was completed.
- */ - CompletedOn?: number; -} - -/** - * @public - */ -export interface GetStatementResponse { - /** - * @public - *Returns the statement.
- */ - Statement?: Statement; -} - -/** - * @public - */ -export interface GetTableRequest { - /** - * @public - *The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account - * ID is used by default.
- */ - CatalogId?: string; - - /** - * @public - *The name of the database in the catalog in which the table resides. - * For Hive compatibility, this name is entirely lowercase.
- */ - DatabaseName: string | undefined; - - /** - * @public - *The name of the table for which to retrieve the definition. For Hive - * compatibility, this name is entirely lowercase.
- */ - Name: string | undefined; - - /** - * @public - *The transaction ID at which to read the table contents.
- */ - TransactionId?: string; - - /** - * @public - *The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
The code execution output in JSON format.
+ */ +export interface StatementOutputData { + /** + * @public + *The code execution output in text format.
+ */ + TextPlain?: string; +} + +/** + * @public + * @enum + */ +export const StatementState = { + AVAILABLE: "AVAILABLE", + CANCELLED: "CANCELLED", + CANCELLING: "CANCELLING", + ERROR: "ERROR", + RUNNING: "RUNNING", + WAITING: "WAITING", +} as const; + +/** + * @public + */ +export type StatementState = (typeof StatementState)[keyof typeof StatementState]; + +/** + * @public + *The code execution output in JSON format.
+ */ +export interface StatementOutput { + /** + * @public + *The code execution output.
+ */ + Data?: StatementOutputData; + + /** + * @public + *The execution count of the output.
+ */ + ExecutionCount?: number; + + /** + * @public + *The status of the code execution output.
+ */ + Status?: StatementState; + + /** + * @public + *The name of the error in the output.
+ */ + ErrorName?: string; + + /** + * @public + *The error value of the output.
+ */ + ErrorValue?: string; + + /** + * @public + *The traceback of the output.
+ */ + Traceback?: string[]; +} + +/** + * @public + *The statement or request for a particular action to occur in a session.
+ */ +export interface Statement { + /** + * @public + *The ID of the statement.
+ */ + Id?: number; + + /** + * @public + *The execution code of the statement.
+ */ + Code?: string; + + /** + * @public + *The state while request is actioned.
+ */ + State?: StatementState; + + /** + * @public + *The output in JSON.
+ */ + Output?: StatementOutput; + + /** + * @public + *The code execution progress.
+ */ + Progress?: number; + + /** + * @public + *The unix time and date that the job definition was started.
+ */ + StartedOn?: number; + + /** + * @public + *The unix time and date that the job definition was completed.
+ */ + CompletedOn?: number; +} + +/** + * @public + */ +export interface GetStatementResponse { + /** + * @public + *Returns the statement.
+ */ + Statement?: Statement; +} + +/** + * @public + */ +export interface GetTableRequest { + /** + * @public + *The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account + * ID is used by default.
+ */ + CatalogId?: string; + + /** + * @public + *The name of the database in the catalog in which the table resides. + * For Hive compatibility, this name is entirely lowercase.
+ */ + DatabaseName: string | undefined; + + /** + * @public + *The name of the table for which to retrieve the definition. For Hive + * compatibility, this name is entirely lowercase.
+ */ + Name: string | undefined; + + /** + * @public + *The transaction ID at which to read the table contents.
+ */ + TransactionId?: string; + + /** + * @public + *The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
A table that points to an entity outside the Glue Data Catalog.
@@ -1393,6 +1561,40 @@ export interface ListBlueprintsResponse { NextToken?: string; } +/** + * @public + */ +export interface ListColumnStatisticsTaskRunsRequest { + /** + * @public + *The maximum size of the response.
+ */ + MaxResults?: number; + + /** + * @public + *A continuation token, if this is a continuation call.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListColumnStatisticsTaskRunsResponse { + /** + * @public + *A list of column statistics task run IDs.
+ */ + ColumnStatisticsTaskRunIds?: string[]; + + /** + * @public + *A continuation token, if not all task run IDs have yet been returned.
+ */ + NextToken?: string; +} + /** * @public */ @@ -3625,6 +3827,90 @@ export interface StartBlueprintRunResponse { RunId?: string; } +/** + * @public + *An exception thrown when you try to start another job while running a column stats generation job.
+ */ +export class ColumnStatisticsTaskRunningException extends __BaseException { + readonly name: "ColumnStatisticsTaskRunningException" = "ColumnStatisticsTaskRunningException"; + readonly $fault: "client" = "client"; + /** + * @public + *A message describing the problem.
+ */ + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe name of the database where the table resides.
+ */ + DatabaseName: string | undefined; + + /** + * @public + *The name of the table to generate statistics.
+ */ + TableName: string | undefined; + + /** + * @public + *A list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
+ */ + ColumnNameList?: string[]; + + /** + * @public + *The IAM role that the service assumes to generate statistics.
+ */ + Role: string | undefined; + + /** + * @public + *The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
+ */ + SampleSize?: number; + + /** + * @public + *The ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
+ */ + CatalogID?: string; + + /** + * @public + *Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
+ */ + SecurityConfiguration?: string; +} + +/** + * @public + */ +export interface StartColumnStatisticsTaskRunResponse { + /** + * @public + *The identifier for the column statistics task run.
+ */ + ColumnStatisticsTaskRunId?: string; +} + /** * @public */ @@ -4163,6 +4449,80 @@ export interface StartWorkflowRunResponse { RunId?: string; } +/** + * @public + *An exception thrown when you try to stop a task run when there is no task running.
+ */ +export class ColumnStatisticsTaskNotRunningException extends __BaseException { + readonly name: "ColumnStatisticsTaskNotRunningException" = "ColumnStatisticsTaskNotRunningException"; + readonly $fault: "client" = "client"; + /** + * @public + *A message describing the problem.
+ */ + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeAn exception thrown when you try to stop a task run.
+ */ +export class ColumnStatisticsTaskStoppingException extends __BaseException { + readonly name: "ColumnStatisticsTaskStoppingException" = "ColumnStatisticsTaskStoppingException"; + readonly $fault: "client" = "client"; + /** + * @public + *A message describing the problem.
+ */ + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe name of the database where the table resides.
+ */ + DatabaseName: string | undefined; + + /** + * @public + *The name of the table.
+ */ + TableName: string | undefined; +} + +/** + * @public + */ +export interface StopColumnStatisticsTaskRunResponse {} + /** * @public *The specified crawler is not running.
diff --git a/clients/client-glue/src/pagination/GetColumnStatisticsTaskRunsPaginator.ts b/clients/client-glue/src/pagination/GetColumnStatisticsTaskRunsPaginator.ts new file mode 100644 index 0000000000000..aaae367037c72 --- /dev/null +++ b/clients/client-glue/src/pagination/GetColumnStatisticsTaskRunsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + GetColumnStatisticsTaskRunsCommand, + GetColumnStatisticsTaskRunsCommandInput, + GetColumnStatisticsTaskRunsCommandOutput, +} from "../commands/GetColumnStatisticsTaskRunsCommand"; +import { GlueClient } from "../GlueClient"; +import { GluePaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: GlueClient, + input: GetColumnStatisticsTaskRunsCommandInput, + ...args: any +): PromiseA message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An exception thrown when you try to stop a task run when there is no task running.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskRun": { + "type": "structure", + "members": { + "CustomerId": { + "target": "com.amazonaws.glue#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
" + } + }, + "ColumnStatisticsTaskRunId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "The identifier for the particular column statistics task run.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#DatabaseName", + "traits": { + "smithy.api#documentation": "The database where the table resides.
" + } + }, + "TableName": { + "target": "com.amazonaws.glue#TableName", + "traits": { + "smithy.api#documentation": "The name of the table for which column statistics is generated.
" + } + }, + "ColumnNameList": { + "target": "com.amazonaws.glue#ColumnNameList", + "traits": { + "smithy.api#documentation": "A list of the column names. If none is supplied, all column names for the table will be used by default.
" + } + }, + "CatalogID": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
" + } + }, + "Role": { + "target": "com.amazonaws.glue#Role", + "traits": { + "smithy.api#documentation": "The IAM role that the service assumes to generate statistics.
" + } + }, + "SampleSize": { + "target": "com.amazonaws.glue#SampleSizePercentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
" + } + }, + "SecurityConfiguration": { + "target": "com.amazonaws.glue#CrawlerSecurityConfiguration", + "traits": { + "smithy.api#documentation": "Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
" + } + }, + "NumberOfWorkers": { + "target": "com.amazonaws.glue#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
" + } + }, + "WorkerType": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The type of workers being used for generating stats. The default is g.1x.
The status of the task run.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this task was created.
" + } + }, + "LastUpdated": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The last point in time when this task was modified.
" + } + }, + "StartTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the task.
" + } + }, + "EndTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the task.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "The error message for the job.
" + } + }, + "DPUSeconds": { + "target": "com.amazonaws.glue#NonNegativeDouble", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The calculated DPU usage in seconds for all autoscaled workers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object that shows the details of the column stats run.
" + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskRunIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#HashString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskRunningException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An exception thrown when you try to start another job while running a column stats generation job.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskRunsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRun" + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskStoppingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An exception thrown when you try to stop a task run.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.glue#ColumnStatisticsType": { "type": "enum", "members": { @@ -15036,6 +15263,134 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#GetColumnStatisticsTaskRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetColumnStatisticsTaskRunRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetColumnStatisticsTaskRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Get the associated metadata/information for a task run, given a task run ID.
" + } + }, + "com.amazonaws.glue#GetColumnStatisticsTaskRunRequest": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRunId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "The identifier for the particular column statistics task run.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetColumnStatisticsTaskRunResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRun": { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRun", + "traits": { + "smithy.api#documentation": "A ColumnStatisticsTaskRun object representing the details of the column stats run.
Retrieves information about all runs associated with the specified table.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#GetColumnStatisticsTaskRunsRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.glue#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database where the table resides.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the table.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "The maximum size of the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is a continuation call.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetColumnStatisticsTaskRunsResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRuns": { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRunsList", + "traits": { + "smithy.api#documentation": "A list of column statistics task runs.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if not all task runs have yet been returned.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#GetConnection": { "type": "operation", "input": { @@ -22614,6 +22969,68 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#ListColumnStatisticsTaskRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListColumnStatisticsTaskRunsRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListColumnStatisticsTaskRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "List all task runs for a particular account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#ListColumnStatisticsTaskRunsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "The maximum size of the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is a continuation call.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#ListColumnStatisticsTaskRunsResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRunIds": { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRunIdList", + "traits": { + "smithy.api#documentation": "A list of column statistics task run IDs.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if not all task run IDs have yet been returned.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#ListCrawlers": { "type": "operation", "input": { @@ -26024,6 +26441,15 @@ } } }, + "com.amazonaws.glue#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.glue#PositiveLong": { "type": "long", "traits": { @@ -28687,6 +29113,16 @@ "target": "com.amazonaws.glue#S3Target" } }, + "com.amazonaws.glue#SampleSizePercentage": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.glue#ScalaCode": { "type": "string" }, @@ -30349,6 +30785,106 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#StartColumnStatisticsTaskRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#StartColumnStatisticsTaskRunRequest" + }, + "output": { + "target": "com.amazonaws.glue#StartColumnStatisticsTaskRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRunningException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a column statistics task run, for a specified table and columns.
" + } + }, + "com.amazonaws.glue#StartColumnStatisticsTaskRunRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the database where the table resides.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the table to generate statistics.
", + "smithy.api#required": {} + } + }, + "ColumnNameList": { + "target": "com.amazonaws.glue#ColumnNameList", + "traits": { + "smithy.api#documentation": "A list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
" + } + }, + "Role": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The IAM role that the service assumes to generate statistics.
", + "smithy.api#required": {} + } + }, + "SampleSize": { + "target": "com.amazonaws.glue#SampleSizePercentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
" + } + }, + "CatalogID": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
" + } + }, + "SecurityConfiguration": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#StartColumnStatisticsTaskRunResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRunId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "The identifier for the column statistics task run.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#StartCrawler": { "type": "operation", "input": { @@ -31357,6 +31893,61 @@ } } }, + "com.amazonaws.glue#StopColumnStatisticsTaskRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#StopColumnStatisticsTaskRunRequest" + }, + "output": { + "target": "com.amazonaws.glue#StopColumnStatisticsTaskRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#ColumnStatisticsTaskNotRunningException" + }, + { + "target": "com.amazonaws.glue#ColumnStatisticsTaskStoppingException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a task run for the specified table.
" + } + }, + "com.amazonaws.glue#StopColumnStatisticsTaskRunRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.glue#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database where the table resides.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the table.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#StopColumnStatisticsTaskRunResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#StopCrawler": { "type": "operation", "input": {