[ aws . lookoutequipment ]

describe-data-ingestion-job

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--job-id (string)

The job ID of the data ingestion job.

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

See ‘aws help’ for descriptions of global parameters.

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.

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.