DescribeCustomPermissions
Describes a custom permissions profile.
Request Syntax
GET /accounts/AwsAccountId/custom-permissions/CustomPermissionsName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the AWS account that contains the custom permissions profile that you want described.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
- CustomPermissionsName
-
The name of the custom permissions profile to describe.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9+=,.@_-]+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CustomPermissions": {
"Arn": "string",
"Capabilities": {
"AddOrRunAnomalyDetectionForAnalyses": "string",
"CreateAndUpdateDashboardEmailReports": "string",
"CreateAndUpdateDatasets": "string",
"CreateAndUpdateDataSources": "string",
"CreateAndUpdateThemes": "string",
"CreateAndUpdateThresholdAlerts": "string",
"CreateSharedFolders": "string",
"CreateSPICEDataset": "string",
"ExportToCsv": "string",
"ExportToExcel": "string",
"RenameSharedFolders": "string",
"ShareAnalyses": "string",
"ShareDashboards": "string",
"ShareDatasets": "string",
"ShareDataSources": "string",
"SubscribeDashboardEmailReports": "string",
"ViewAccountSPICECapacity": "string"
},
"CustomPermissionsName": "string"
},
"RequestId": "string",
"Status": number
}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.
- CustomPermissions
-
The custom permissions profile.
Type: CustomPermissions object
- RequestId
-
The AWS request ID for this operation.
Type: String
- Status
-
The HTTP status of the request.
Type: Integer
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
- 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
- PreconditionNotMetException
-
One or more preconditions aren't met.
HTTP Status Code: 400
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ResourceUnavailableException
-
This resource is currently unavailable.
HTTP Status Code: 503
- ThrottlingException
-
Access is throttled.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
