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

CreateDataset

Creates a new FinSpace Dataset.

Request Syntax


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

{
   "alias": "string",
   "clientToken": "string",
   "datasetDescription": "string",
   "datasetTitle": "string",
   "kind": "string",
   "ownerInfo": { 
      "email": "string",
      "name": "string",
      "phoneNumber": "string"
   },
   "permissionGroupParams": { 
      "datasetPermissions": [ 
         { 
            "permission": "string"
         }
      ],
      "permissionGroupId": "string"
   },
   "schemaDefinition": { 
      "tabularSchemaConfig": { 
         "columns": [ 
            { 
               "columnDescription": "string",
               "columnName": "string",
               "dataType": "string"
            }
         ],
         "primaryKeyColumns": [ "string" ]
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

datasetTitle

Display title for a FinSpace Dataset.

Type: String

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

Pattern: .*\S.*

Required: Yes

kind

The format in which Dataset data is structured.

TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.

Type: String

Valid Values: TABULAR | NON_TABULAR

Required: Yes

permissionGroupParams

Permission group parameters for Dataset permissions.

Type: PermissionGroupParams object

Required: Yes

alias

The unique resource identifier for a Dataset.

Type: String

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

Pattern: ^alias\/\S+

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

datasetDescription

Description of a Dataset.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\s\S]*

Required: No

ownerInfo

Contact information for a Dataset owner.

Type: DatasetOwnerInfo object

Required: No

schemaDefinition

Definition for a schema on a tabular Dataset.

Type: SchemaUnion object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "datasetId": "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 for the created Dataset.

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.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

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