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

UpdateDataSet

This operation updates a data set.

Request Syntax


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

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

URI Request Parameters

The request uses the following URI parameters.

DataSetId

The unique identifier for a data set.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The description for the data set.

Type: String

Required: No

Name

The name of the data set.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
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",
   "UpdatedAt": "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.

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

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.

Message: Access to the resource is denied.

HTTP Status Code: 403

InternalServerException

An exception occurred with the service.

Message: The message identifying the service exception that occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found.

Message: The resource couldn't be found.
ResourceId: The unique identifier for the resource that couldn't be found.
ResourceType: The type of resource that couldn't be found.

HTTP Status Code: 404

ThrottlingException

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

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

HTTP Status Code: 429

ValidationException

The request was invalid.

ExceptionCause: The unique identifier for the resource that couldn't be found.
Message: The message that informs you about what was invalid about the request.

HTTP Status Code: 400