[ aws . lookoutequipment ]

create-dataset

Description

Creates a container for a collection of data being ingested for analysis. The dataset contains the metadata describing where the data is and what the data actually looks like. In other words, it contains the location of the data source, the data schema, and other information. A dataset also contains any tags associated with the ingested data.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-dataset
--dataset-name <value>
--dataset-schema <value>
[--server-side-kms-key-id <value>]
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataset-name (string)

The name of the dataset being created.

--dataset-schema (structure)

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

InlineDataSchema -> (string)

Shorthand Syntax:

InlineDataSchema=string

JSON Syntax:

{
  "InlineDataSchema": "string"
}

--server-side-kms-key-id (string)

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

--client-token (string)

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

--tags (list)

Any tags associated with the ingested data described in the dataset.

(structure)

A tag is a key-value pair that can be added to a resource as metadata.

Key -> (string)

The key for the specified tag.

Value -> (string)

The value for the specified tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

DatasetName -> (string)

The name of the dataset being created.

DatasetArn -> (string)

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

Status -> (string)

Indicates the status of the CreateDataset operation.