UpdateThemePermissions
Updates the resource permissions for a theme. Permissions apply to the action to grant or
revoke permissions on, for example "quicksight:DescribeTheme"
.
Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
-
User
-
"quicksight:DescribeTheme"
-
"quicksight:DescribeThemeAlias"
-
"quicksight:ListThemeAliases"
-
"quicksight:ListThemeVersions"
-
-
Owner
-
"quicksight:DescribeTheme"
-
"quicksight:DescribeThemeAlias"
-
"quicksight:ListThemeAliases"
-
"quicksight:ListThemeVersions"
-
"quicksight:DeleteTheme"
-
"quicksight:UpdateTheme"
-
"quicksight:CreateThemeAlias"
-
"quicksight:DeleteThemeAlias"
-
"quicksight:UpdateThemeAlias"
-
"quicksight:UpdateThemePermissions"
-
"quicksight:DescribeThemePermissions"
-
-
To specify no permissions, omit the permissions list.
Request Syntax
PUT /accounts/AwsAccountId
/themes/ThemeId
/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 ID of the AWS account that contains the theme.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$
Required: Yes
- ThemeId
-
The ID for the theme.
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.
- GrantPermissions
-
A list of resource permissions to be granted for the theme.
Type: Array of ResourcePermission objects
Array Members: Maximum number of 100 items.
Required: No
- RevokePermissions
-
A list of resource permissions to be revoked from the theme.
Type: Array of ResourcePermission objects
Array Members: Maximum number of 100 items.
Required: No
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"Permissions": [
{
"Actions": [ "string" ],
"Principal": "string"
}
],
"RequestId": "string",
"ThemeArn": "string",
"ThemeId": "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.
- Permissions
-
The resulting list of resource permissions for the theme.
Type: Array of ResourcePermission objects
Array Members: Minimum number of 1 item. Maximum number of 64 items.
- RequestId
-
The AWS request ID for this operation.
Type: String
- ThemeArn
-
The Amazon Resource Name (ARN) of the theme.
Type: String
- ThemeId
-
The ID for the theme.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+
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
- LimitExceededException
-
A limit is exceeded.
HTTP Status Code: 409
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: