[ aws . quicksight ]

describe-ingestion

Description

Describes a SPICE ingestion.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-ingestion
--aws-account-id <value>
--data-set-id <value>
--ingestion-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The Amazon Web Services account ID.

--data-set-id (string)

The ID of the dataset used in the ingestion.

--ingestion-id (string)

An ID for the ingestion.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

Ingestion -> (structure)

Information about the ingestion.

Arn -> (string)

The Amazon Resource Name (ARN) of the resource.

IngestionId -> (string)

Ingestion ID.

IngestionStatus -> (string)

Ingestion status.

ErrorInfo -> (structure)

Error information for this ingestion.

Type -> (string)

Error type.

Message -> (string)

Error message.

RowInfo -> (structure)

Information about rows for a data set SPICE ingestion.

RowsIngested -> (long)

The number of rows that were ingested.

RowsDropped -> (long)

The number of rows that were not ingested.

TotalRowsInDataset -> (long)

The total number of rows in the dataset.

QueueInfo -> (structure)

Information about a queued dataset SPICE ingestion.

WaitingOnIngestion -> (string)

The ID of the queued ingestion.

QueuedIngestion -> (string)

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.

CreatedTime -> (timestamp)

The time that this ingestion started.

IngestionTimeInSeconds -> (long)

The time that this ingestion took, measured in seconds.

IngestionSizeInBytes -> (long)

The size of the data ingested, in bytes.

RequestSource -> (string)

Event source for this ingestion.

RequestType -> (string)

Type of this ingestion.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.