Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

describe-ingestion

Description

Describes a SPICE ingestion.

See also: AWS API Documentation

Synopsis

  describe-ingestion
--aws-account-id <value>
--data-set-id <value>
--ingestion-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.