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

CreateDataSet

This operation creates a data set.

Request Syntax


POST /v1/data-sets HTTP/1.1
Content-type: application/json

{
   "AssetType": "string",
   "Description": "string",
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AssetType

The type of asset that is added to a data set.

Type: String

Valid Values: S3_SNAPSHOT | REDSHIFT_DATA_SHARE | API_GATEWAY_API | S3_DATA_ACCESS | LAKE_FORMATION_DATA_PERMISSION

Required: Yes

Description

A description for the data set. This value can be up to 16,348 characters long.

Type: String

Required: Yes

Name

The name of the data set.

Type: String

Required: Yes

Tags

A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "Arn": "string",
   "AssetType": "string",
   "CreatedAt": "string",
   "Description": "string",
   "Id": "string",
   "Name": "string",
   "Origin": "string",
   "OriginDetails": { 
      "DataGrantId": "string",
      "ProductId": "string"
   },
   "SourceId": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UpdatedAt": "string"
}

Response Elements

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

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

Arn

The ARN for the data set.

Type: String

AssetType

The type of asset that is added to a data set.

Type: String

Valid Values: S3_SNAPSHOT | REDSHIFT_DATA_SHARE | API_GATEWAY_API | S3_DATA_ACCESS | LAKE_FORMATION_DATA_PERMISSION

CreatedAt

The date and time that the data set was created, in ISO 8601 format.

Type: Timestamp

Description

The description for the data set.

Type: String

Id

The unique identifier for the data set.

Type: String

Name

The name of the data set.

Type: String

Origin

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

Type: String

Valid Values: OWNED | ENTITLED

OriginDetails

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

Type: OriginDetails object

SourceId

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

Type: String

Tags

The tags for the data set.

Type: String to string map

UpdatedAt

The date and time that the data set was last updated, in ISO 8601 format.

Type: Timestamp

Errors

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

AccessDeniedException

Access to the resource is denied.

HTTP Status Code: 403

InternalServerException

An exception occurred with the service.

HTTP Status Code: 500

ServiceLimitExceededException

The request has exceeded the quotas imposed by the service.

HTTP Status Code: 402

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request was invalid.

HTTP Status Code: 400