Table Of Contents

Feedback

User Guide

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

[ aws . iotanalytics ]

describe-dataset

Description

Retrieves information about a data set.

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 data set whose information is retrieved.

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

dataset -> (structure)

An object that contains information about the data set.

name -> (string)

The name of the data set.

arn -> (string)

The ARN of the data set.

actions -> (list)

The "DatasetAction" objects that create the data set.

(structure)

A "DatasetAction" object specifying the query that creates the data set content.

actionName -> (string)

The name of the data set action.

queryAction -> (structure)

An "SqlQueryDatasetAction" object that contains the SQL query to modify the message.

sqlQuery -> (string)

An SQL query string.

triggers -> (list)

The "DatasetTrigger" objects that specify when the data set is automatically updated.

(structure)

The "DatasetTrigger" that specifies when the data set is automatically updated.

schedule -> (structure)

The "Schedule" when the trigger is initiated.

expression -> (string)

The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.

status -> (string)

The status of the data set.

creationTime -> (timestamp)

When the data set was created.

lastUpdateTime -> (timestamp)

The last time the data set was updated.