AWS CLI Command Reference

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 . lookoutequipment ]

describe-data-ingestion-job

Description

Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.

See also: AWS API Documentation

Synopsis

  describe-data-ingestion-job
--job-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

--job-id (string)

The job ID of the data ingestion job.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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

JobId -> (string)

Indicates the job ID of the data ingestion job.

DatasetArn -> (string)

The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.

IngestionInputConfiguration -> (structure)

Specifies the S3 location configuration for the data input for the data ingestion job.

S3InputConfiguration -> (structure)

The location information for the S3 bucket used for input data for the data ingestion.

Bucket -> (string)

The name of the S3 bucket used for the input data for the data ingestion.

Prefix -> (string)

The prefix for the S3 location being used for the input data for the data ingestion.

KeyPattern -> (string)

The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)

RoleArn -> (string)

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.

CreatedAt -> (timestamp)

The time at which the data ingestion job was created.

Status -> (string)

Indicates the status of the DataIngestionJob operation.

FailedReason -> (string)

Specifies the reason for failure when a data ingestion job has failed.

DataQualitySummary -> (structure)

Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

InsufficientSensorData -> (structure)

Parameter that gives information about insufficient data for sensors in the dataset. This includes information about those sensors that have complete data missing and those with a short date range.

MissingCompleteSensorData -> (structure)

Parameter that describes the total number of sensors that have data completely missing for it.

AffectedSensorCount -> (integer)

Indicates the number of sensors that have data missing completely.

SensorsWithShortDateRange -> (structure)

Parameter that describes the total number of sensors that have a short date range of less than 14 days of data overall.

AffectedSensorCount -> (integer)

Indicates the number of sensors that have less than 14 days of data.

MissingSensorData -> (structure)

Parameter that gives information about data that is missing over all the sensors in the input data.

AffectedSensorCount -> (integer)

Indicates the number of sensors that have atleast some data missing.

TotalNumberOfMissingValues -> (integer)

Indicates the total number of missing values across all the sensors.

InvalidSensorData -> (structure)

Parameter that gives information about data that is invalid over all the sensors in the input data.

AffectedSensorCount -> (integer)

Indicates the number of sensors that have at least some invalid values.

TotalNumberOfInvalidValues -> (integer)

Indicates the total number of invalid values across all the sensors.

UnsupportedTimestamps -> (structure)

Parameter that gives information about unsupported timestamps in the input data.

TotalNumberOfUnsupportedTimestamps -> (integer)

Indicates the total number of unsupported timestamps across the ingested data.

DuplicateTimestamps -> (structure)

Parameter that gives information about duplicate timestamps in the input data.

TotalNumberOfDuplicateTimestamps -> (integer)

Indicates the total number of duplicate timestamps.

IngestedFilesSummary -> (structure)

Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.

TotalNumberOfFiles -> (integer)

Indicates the total number of files that were submitted for ingestion.

IngestedNumberOfFiles -> (integer)

Indicates the number of files that were successfully ingested.

DiscardedFiles -> (list)

Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.

(structure)

Contains information about an S3 bucket.

Bucket -> (string)

The name of the specific S3 bucket.

Key -> (string)

The Amazon Web Services Key Management Service (KMS key) key being used to encrypt the S3 object. Without this key, data in the bucket is not accessible.

StatusDetail -> (string)

Provides details about status of the ingestion job that is currently in progress.

IngestedDataSize -> (long)

Indicates the size of the ingested dataset.

DataStartTime -> (timestamp)

Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

DataEndTime -> (timestamp)

Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

SourceDatasetArn -> (string)

The Amazon Resource Name (ARN) of the source dataset from which the data used for the data ingestion job was imported from.