Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

Description

Provides a JSON description of the data that is in each time series dataset, including names, column names, and data types.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-dataset
--dataset-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--dataset-name (string)

The name of the dataset to be described.

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

See 'aws help' for descriptions of global parameters.

Output

DatasetName -> (string)

The name of the dataset being described.

DatasetArn -> (string)

The Amazon Resource Name (ARN) of the dataset being described.

CreatedAt -> (timestamp)

Specifies the time the dataset was created in Amazon Lookout for Equipment.

LastUpdatedAt -> (timestamp)

Specifies the time the dataset was last updated, if it was.

Status -> (string)

Indicates the status of the dataset.

Schema -> (string)

A JSON description of the data that is in each time series dataset, including names, column names, and data types.

ServerSideKmsKeyId -> (string)

Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

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.