DescribeIngestionCommand

Suggest an Edit

Describes a SPICE ingestion.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QuickSightClient, DescribeIngestionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, DescribeIngestionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
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"),
// };

DescribeIngestionCommand Input

See DescribeIngestionCommandInput for more details

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The Amazon Web Services account ID.

DataSetId
Required
string | undefined

The ID of the dataset used in the ingestion.

IngestionId
Required
string | undefined

An ID for the ingestion.

DescribeIngestionCommand Output

See DescribeIngestionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Ingestion
Ingestion | undefined

Information about the ingestion.

RequestId
string | undefined

The Amazon Web Services request ID for this operation.

Status
number | undefined

The HTTP status of the request.

Throws

Name
Fault
Details
AccessDeniedException
client

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 QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

InternalFailureException
server

An internal failure occurred.

InvalidParameterValueException
client

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

ResourceExistsException
client

The resource specified already exists.

ResourceNotFoundException
client

One or more resources can't be found.

ThrottlingException
client

Access is throttled.

QuickSightServiceException
Base exception class for all service exceptions from QuickSight service.