import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeIngestionRequest, DescribeIngestionResponse } from "../models/models_3"; import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeIngestionCommand}. */ export interface DescribeIngestionCommandInput extends DescribeIngestionRequest { } /** * @public * * The output of {@link DescribeIngestionCommand}. */ export interface DescribeIngestionCommandOutput extends DescribeIngestionResponse, __MetadataBearer { } declare const DescribeIngestionCommand_base: { new (input: DescribeIngestionCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DescribeIngestionCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Describes a SPICE ingestion.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QuickSightClient, DescribeIngestionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import * // const { QuickSightClient, DescribeIngestionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import * // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight"; * const config = {}; // type is QuickSightClientConfig * const client = new QuickSightClient(config); * const input = { // DescribeIngestionRequest * AwsAccountId: "STRING_VALUE", // required * DataSetId: "STRING_VALUE", // required * IngestionId: "STRING_VALUE", // required * }; * const command = new DescribeIngestionCommand(input); * const response = await client.send(command); * // { // DescribeIngestionResponse * // Ingestion: { // Ingestion * // Arn: "STRING_VALUE", // required * // IngestionId: "STRING_VALUE", * // IngestionStatus: "INITIALIZED" || "QUEUED" || "RUNNING" || "FAILED" || "COMPLETED" || "CANCELLED", // required * // ErrorInfo: { // ErrorInfo * // Type: "FAILURE_TO_ASSUME_ROLE" || "INGESTION_SUPERSEDED" || "INGESTION_CANCELED" || "DATA_SET_DELETED" || "DATA_SET_NOT_SPICE" || "S3_UPLOADED_FILE_DELETED" || "S3_MANIFEST_ERROR" || "DATA_TOLERANCE_EXCEPTION" || "SPICE_TABLE_NOT_FOUND" || "DATA_SET_SIZE_LIMIT_EXCEEDED" || "ROW_SIZE_LIMIT_EXCEEDED" || "ACCOUNT_CAPACITY_LIMIT_EXCEEDED" || "CUSTOMER_ERROR" || "DATA_SOURCE_NOT_FOUND" || "IAM_ROLE_NOT_AVAILABLE" || "CONNECTION_FAILURE" || "SQL_TABLE_NOT_FOUND" || "PERMISSION_DENIED" || "SSL_CERTIFICATE_VALIDATION_FAILURE" || "OAUTH_TOKEN_FAILURE" || "SOURCE_API_LIMIT_EXCEEDED_FAILURE" || "PASSWORD_AUTHENTICATION_FAILURE" || "SQL_SCHEMA_MISMATCH_ERROR" || "INVALID_DATE_FORMAT" || "INVALID_DATAPREP_SYNTAX" || "SOURCE_RESOURCE_LIMIT_EXCEEDED" || "SQL_INVALID_PARAMETER_VALUE" || "QUERY_TIMEOUT" || "SQL_NUMERIC_OVERFLOW" || "UNRESOLVABLE_HOST" || "UNROUTABLE_HOST" || "SQL_EXCEPTION" || "S3_FILE_INACCESSIBLE" || "IOT_FILE_NOT_FOUND" || "IOT_DATA_SET_FILE_EMPTY" || "INVALID_DATA_SOURCE_CONFIG" || "DATA_SOURCE_AUTH_FAILED" || "DATA_SOURCE_CONNECTION_FAILED" || "FAILURE_TO_PROCESS_JSON_FILE" || "INTERNAL_SERVICE_ERROR" || "REFRESH_SUPPRESSED_BY_EDIT" || "PERMISSION_NOT_FOUND" || "ELASTICSEARCH_CURSOR_NOT_ENABLED" || "CURSOR_NOT_ENABLED" || "DUPLICATE_COLUMN_NAMES_FOUND", * // Message: "STRING_VALUE", * // }, * // RowInfo: { // RowInfo * // RowsIngested: Number("long"), * // RowsDropped: Number("long"), * // TotalRowsInDataset: Number("long"), * // }, * // QueueInfo: { // QueueInfo * // WaitingOnIngestion: "STRING_VALUE", // required * // QueuedIngestion: "STRING_VALUE", // required * // }, * // CreatedTime: new Date("TIMESTAMP"), // required * // IngestionTimeInSeconds: Number("long"), * // IngestionSizeInBytes: Number("long"), * // RequestSource: "MANUAL" || "SCHEDULED", * // RequestType: "INITIAL_INGESTION" || "EDIT" || "INCREMENTAL_REFRESH" || "FULL_REFRESH", * // }, * // RequestId: "STRING_VALUE", * // Status: Number("int"), * // }; * * ``` * * @param DescribeIngestionCommandInput - {@link DescribeIngestionCommandInput} * @returns {@link DescribeIngestionCommandOutput} * @see {@link DescribeIngestionCommandInput} for command's `input` shape. * @see {@link DescribeIngestionCommandOutput} for command's `response` shape. * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You don't have access to this item. The provided credentials couldn't be * validated. You might not be authorized to carry out the request. Make sure that your * account is authorized to use the Amazon Quick Sight service, that your policies have the * correct permissions, and that you are using the correct credentials.

* * @throws {@link InternalFailureException} (server fault) *

An internal failure occurred.

* * @throws {@link InvalidParameterValueException} (client fault) *

One or more parameters has a value that isn't valid.

* * @throws {@link ResourceExistsException} (client fault) *

The resource specified already exists.

* * @throws {@link ResourceNotFoundException} (client fault) *

One or more resources can't be found.

* * @throws {@link ThrottlingException} (client fault) *

Access is throttled.

* * @throws {@link QuickSightServiceException} *

Base exception class for all service exceptions from QuickSight service.

* * * @public */ export declare class DescribeIngestionCommand extends DescribeIngestionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeIngestionRequest; output: DescribeIngestionResponse; }; sdk: { input: DescribeIngestionCommandInput; output: DescribeIngestionCommandOutput; }; }; }