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

UpdateDataSetPermissions

Updates the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

Request Syntax


POST /accounts/AwsAccountId/data-sets/DataSetId/permissions HTTP/1.1
Content-type: application/json

{
   "GrantPermissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "RevokePermissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The AWS account ID.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

DataSetId

The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.

Required: Yes

Request Body

The request accepts the following data in JSON format.

GrantPermissions

The resource permissions that you want to grant to the dataset.

Type: Array of ResourcePermission objects

Array Members: Minimum number of 1 item. Maximum number of 64 items.

Required: No

RevokePermissions

The resource permissions that you want to revoke from the dataset.

Type: Array of ResourcePermission objects

Array Members: Minimum number of 1 item. Maximum number of 64 items.

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "DataSetArn": "string",
   "DataSetId": "string",
   "RequestId": "string"
}

Response Elements

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

Status: The HTTP status of the request.

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

DataSetArn

The Amazon Resource Name (ARN) of the dataset.

Type: String

DataSetId

The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.

Type: String

RequestId

The AWS request ID for this operation.

Type: String

Errors

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

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

Examples

Example

This example illustrates one usage of UpdateDataSetPermissions.

Sample Request


POST /accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions HTTP/1.1
Content-type: application/json