[ aws . iotanalytics ]

list-datasets

Description

Retrieves information about data sets.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-datasets is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: datasetSummaries

Synopsis

  list-datasets
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve information about datasets

The following list-datasets example lists summary information about available datasets.

aws iotanalytics list-datasets

Output:

{
    "datasetSummaries": [
        {
            "status": "ACTIVE",
            "datasetName": "mydataset",
            "lastUpdateTime": 1557859240.658,
            "triggers": [],
            "creationTime": 1557859240.658,
            "actions": [
                {
                    "actionName": "query_32",
                    "actionType": "QUERY"
                }
            ]
        }
    ]
}

For more information, see ListDatasets in the AWS IoT Analytics API Reference.

Output

datasetSummaries -> (list)

A list of “DatasetSummary” objects.

(structure)

A summary of information about a data set.

datasetName -> (string)

The name of the data set.

status -> (string)

The status of the data set.

creationTime -> (timestamp)

The time the data set was created.

lastUpdateTime -> (timestamp)

The last time the data set was updated.

triggers -> (list)

A list of triggers. A trigger causes data set content to be populated at a specified time interval or when another data set is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects

(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 Events User Guide.

dataset -> (structure)

The data set whose content creation triggers the creation of this data set’s contents.

name -> (string)

The name of the data set whose content generation triggers the new data set content generation.

actions -> (list)

A list of “DataActionSummary” objects.

(structure)

Information about the action which automatically creates the data set’s contents.

actionName -> (string)

The name of the action which automatically creates the data set’s contents.

actionType -> (string)

The type of action by which the data set’s contents are automatically created.

nextToken -> (string)

The token to retrieve the next set of results, or null if there are no more results.