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

CreateDataView

Creates a Dataview for a Dataset.

Request Syntax


POST /datasets/datasetId/dataviewsv2 HTTP/1.1
Content-type: application/json

{
   "asOfTimestamp": number,
   "autoUpdate": boolean,
   "clientToken": "string",
   "destinationTypeParams": { 
      "destinationType": "string",
      "s3DestinationExportFileFormat": "string",
      "s3DestinationExportFileFormatOptions": { 
         "string" : "string" 
      }
   },
   "partitionColumns": [ "string" ],
   "sortColumns": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

datasetId

The unique Dataset identifier that is used to create a Dataview.

Length Constraints: Minimum length of 1. Maximum length of 26.

Required: Yes

Request Body

The request accepts the following data in JSON format.

destinationTypeParams

Options that define the destination type for the Dataview.

Type: DataViewDestinationTypeParams object

Required: Yes

asOfTimestamp

Beginning time to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Type: Long

Required: No

autoUpdate

Flag to indicate Dataview should be updated automatically.

Type: Boolean

Required: No

clientToken

A token that ensures idempotency. This token expires in 10 minutes.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: No

partitionColumns

Ordered set of column names used to partition data.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\s\S]*\S[\s\S]*

Required: No

sortColumns

Columns to be used for sorting the data.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\s\S]*\S[\s\S]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "datasetId": "string",
   "dataViewId": "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.

datasetId

The unique identifier of the Dataset used for the Dataview.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

dataViewId

The unique identifier for the created Dataview.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Errors

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

ConflictException

The request conflicts with an existing resource.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

LimitExceededException

A limit has exceeded.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400