[ aws . iotanalytics ]

get-dataset-content

Description

Retrieves the contents of a dataset as presigned URIs.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-dataset-content
--dataset-name <value>
[--version-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataset-name (string)

The name of the dataset whose contents are retrieved.

--version-id (string)

The version of the dataset whose contents are retrieved. You can also use the strings “$LATEST” or “$LATEST_SUCCEEDED” to retrieve the contents of the latest or latest successfully completed dataset. If not specified, “$LATEST_SUCCEEDED” is the default.

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To retrieve the contents of a dataset

The following get-dataset-content example retrieves the contents of a dataset as presigned URIs.

aws iotanalytics get-dataset-content --dataset-name mydataset

Output:

{
    "status": {
        "state": "SUCCEEDED"
    },
    "timestamp": 1557863215.995,
    "entries": [
        {
            "dataURI": "https://aws-radiant-dataset-12345678-1234-1234-1234-123456789012.s3.us-west-2.amazonaws.com/results/12345678-e8b3-46ba-b2dd-efe8d86cf385.csv?X-Amz-Security-Token=...-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190628T173437Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Credential=...F20190628%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=..."
        }
    ]
}

For more information, see GetDatasetContent in the guide.

Output

entries -> (list)

A list of DatasetEntry objects.

(structure)

The reference to a dataset entry.

entryName -> (string)

The name of the dataset item.

dataURI -> (string)

The presigned URI of the dataset item.

timestamp -> (timestamp)

The time when the request was made.

status -> (structure)

The status of the dataset content.

state -> (string)

The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.

reason -> (string)

The reason the dataset contents are in this state.