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

DescribeDashboardPermissions

Describes read and write permissions for a dashboard.

Request Syntax


GET /accounts/AwsAccountId/dashboards/DashboardId/permissions HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account that contains the dashboard that you're describing permissions for.

Length Constraints: Fixed length of 12.

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

Required: Yes

DashboardId

The ID for the dashboard, also added to the IAM policy.

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

Pattern: [\w\-]+

Required: Yes

Request Body

The request does not have a request body.

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

A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.

Type: LinkSharingConfiguration object

Permissions

A structure that contains the permissions for the dashboard.

Type: Array of ResourcePermission objects

Array Members: Maximum number of 100 items.

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.

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

UnsupportedUserEditionException

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

HTTP Status Code: 403