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

UpdateDashboardPermissions

Updates read and write permissions on a dashboard.

Request Syntax


PUT /accounts/AwsAccountId/dashboards/DashboardId/permissions HTTP/1.1
Content-type: application/json

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

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the Amazon account that contains the dashboard whose permissions you're updating.

Length Constraints: Fixed length of 12.

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

Required: Yes

DashboardId

The ID for the dashboard.

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

Pattern: [\w\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

GrantLinkPermissions

Grants link permissions to all users in a defined namespace.

Type: Array of ResourcePermission objects

Array Members: Maximum number of 100 items.

Required: No

GrantPermissions

The permissions that you want to grant on this resource.

Type: Array of ResourcePermission objects

Array Members: Maximum number of 100 items.

Required: No

RevokeLinkPermissions

Revokes link permissions from all users in a defined namespace.

Type: Array of ResourcePermission objects

Array Members: Maximum number of 100 items.

Required: No

RevokePermissions

The permissions that you want to revoke from this resource.

Type: Array of ResourcePermission objects

Array Members: Maximum number of 100 items.

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "DashboardArn": "string",
   "DashboardId": "string",
   "LinkSharingConfiguration": { 
      "Permissions": [ 
         { 
            "Actions": [ "string" ],
            "Principal": "string"
         }
      ]
   },
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "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.

DashboardArn

The Amazon Resource Name (ARN) of the dashboard.

Type: String

DashboardId

The ID for the dashboard.

Type: String

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

Pattern: [\w\-]+

LinkSharingConfiguration

Updates the permissions of a shared link to an Quick Sight dashboard.

Type: LinkSharingConfiguration object

Permissions

Information about the permissions on the dashboard.

Type: Array of ResourcePermission objects

Array Members: Maximum number of 100 items.

RequestId

The Amazon request ID for this operation.

Type: String

Errors

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

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

RequestId: The Amazon request ID for this request.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

RequestId: The Amazon request ID for this request.
ResourceType: Limit exceeded.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 403