---
title: "POST /GetSampleData"
method: POST
path: "/GetSampleData"
---

# POST /GetSampleData

`POST /GetSampleData`

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

## Request body

- object
  - `S3SourceConfig` object — Contains information about the source configuration in Amazon S3.
    - `RoleArn` string — The Amazon Resource Name (ARN) of the role.
    - `TemplatedPathList` TemplatedPath[] — An array of strings containing the list of templated paths.
    - `HistoricalDataPathList` HistoricalDataPath[] — An array of strings containing the historical set of data paths.
    - `FileFormatDescriptor` FileFormatDescriptor — Contains information about a source file's formatting.
      - `CsvFormatDescriptor` object — Contains information about how a source CSV data file should be analyzed.
        - `FileCompression` 'NONE' | 'GZIP' — 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` ColumnName[] — A list of the source CSV file's headers, if any.
        - `QuoteSymbol` string — The character used as a quote character.
      - `JsonFormatDescriptor` object — Contains information about how a source JSON data file should be analyzed.
        - `FileCompression` 'NONE' | 'GZIP' — The level of compression of the source CSV file.
        - `Charset` string — The character set in which the source JSON file is written.

## Response `200`

Success

- GetSampleDataResponse
  - `HeaderValues` HeaderValue[] — A list of header labels for the records.
  - `SampleRows` SampleRow[] — A list of records.
    - DataItem[]

## Other responses

- `480` — ValidationException
- `481` — ResourceNotFoundException
- `482` — AccessDeniedException
- `483` — TooManyRequestsException
- `484` — InternalServerException

---

[API](https://skmtc.net/aws/apis/lookoutmetrics.md) · [All operations](https://skmtc.net/aws/apis/lookoutmetrics/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/lookoutmetrics/versions/aace1e573660/schema)