[ aws . lookoutmetrics ]

get-sample-data

Description

Returns a selection of sample records from an Amazon S3 datasource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-sample-data
[--s3-source-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--s3-source-config (structure)

A datasource bucket in Amazon S3.

RoleArn -> (string)

The Amazon Resource Name (ARN) of the role.

TemplatedPathList -> (list)

An array of strings containing the list of templated paths.

(string)

HistoricalDataPathList -> (list)

An array of strings containing the historical set of data paths.

(string)

FileFormatDescriptor -> (structure)

Contains information about a source file’s formatting.

CsvFormatDescriptor -> (structure)

Contains information about how a source CSV data file should be analyzed.

FileCompression -> (string)

The level of compression of the source CSV file.

Charset -> (string)

The character set in which the source CSV file is written.

ContainsHeader -> (boolean)

Whether or not the source CSV file contains a header.

Delimiter -> (string)

The character used to delimit the source CSV file.

HeaderList -> (list)

A list of the source CSV file’s headers, if any.

(string)

QuoteSymbol -> (string)

The character used as a quote character.

JsonFormatDescriptor -> (structure)

Contains information about how a source JSON data file should be analyzed.

FileCompression -> (string)

The level of compression of the source CSV file.

Charset -> (string)

The character set in which the source JSON file is written.

JSON Syntax:

{
  "RoleArn": "string",
  "TemplatedPathList": ["string", ...],
  "HistoricalDataPathList": ["string", ...],
  "FileFormatDescriptor": {
    "CsvFormatDescriptor": {
      "FileCompression": "NONE"|"GZIP",
      "Charset": "string",
      "ContainsHeader": true|false,
      "Delimiter": "string",
      "HeaderList": ["string", ...],
      "QuoteSymbol": "string"
    },
    "JsonFormatDescriptor": {
      "FileCompression": "NONE"|"GZIP",
      "Charset": "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

HeaderValues -> (list)

A list of header labels for the records.

(string)

SampleRows -> (list)

A list of records.

(list)

(string)