Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSampleData

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

Request Syntax


POST /GetSampleData HTTP/1.1
Content-type: application/json

{
   "S3SourceConfig": { 
      "FileFormatDescriptor": { 
         "CsvFormatDescriptor": { 
            "Charset": "string",
            "ContainsHeader": boolean,
            "Delimiter": "string",
            "FileCompression": "string",
            "HeaderList": [ "string" ],
            "QuoteSymbol": "string"
         },
         "JsonFormatDescriptor": { 
            "Charset": "string",
            "FileCompression": "string"
         }
      },
      "HistoricalDataPathList": [ "string" ],
      "RoleArn": "string",
      "TemplatedPathList": [ "string" ]
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

S3SourceConfig

A datasource bucket in Amazon S3.

Type: SampleDataS3SourceConfig object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "HeaderValues": [ "string" ],
   "SampleRows": [ 
      [ "string" ]
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

HeaderValues

A list of header labels for the records.

Type: Array of strings

SampleRows

A list of records.

Type: Array of arrays of strings

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found. Check the ARN of the resource and try again.

HTTP Status Code: 400

TooManyRequestsException

The request was denied due to too many requests being submitted at the same time.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.

HTTP Status Code: 400