- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateDataSourcePermissionsCommand
Updates the permissions to a data source.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, UpdateDataSourcePermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, UpdateDataSourcePermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // UpdateDataSourcePermissionsRequest
AwsAccountId: "STRING_VALUE", // required
DataSourceId: "STRING_VALUE", // required
GrantPermissions: [ // ResourcePermissionList
{ // ResourcePermission
Principal: "STRING_VALUE", // required
Actions: [ // ActionList // required
"STRING_VALUE",
],
},
],
RevokePermissions: [
{
Principal: "STRING_VALUE", // required
Actions: [ // required
"STRING_VALUE",
],
},
],
};
const command = new UpdateDataSourcePermissionsCommand(input);
const response = await client.send(command);
// { // UpdateDataSourcePermissionsResponse
// DataSourceArn: "STRING_VALUE",
// DataSourceId: "STRING_VALUE",
// RequestId: "STRING_VALUE",
// Status: Number("int"),
// };
UpdateDataSourcePermissionsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AwsAccountId Required | string | undefined | The Amazon Web Services account ID. |
DataSourceId Required | string | undefined | The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. |
GrantPermissions | ResourcePermission[] | undefined | A list of resource permissions that you want to grant on the data source. |
RevokePermissions | ResourcePermission[] | undefined | A list of resource permissions that you want to revoke on the data source. |
UpdateDataSourcePermissionsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
DataSourceArn | string | undefined | The Amazon Resource Name (ARN) of the data source. |
DataSourceId | string | undefined | The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. |
RequestId | string | undefined | The Amazon Web Services request ID for this operation. |
Status | number | undefined | The HTTP status of the request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | 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. |
ConflictException | client | Updating or deleting a resource can cause an inconsistent state. |
InternalFailureException | server | An internal failure occurred. |
InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
ResourceNotFoundException | client | One or more resources can't be found. |
ThrottlingException | client | Access is throttled. |
QuickSightServiceException | Base exception class for all service exceptions from QuickSight service. |