Amazon QuickSight Policies (identity-based)

With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. Amazon QuickSight supports specific actions, resources, and condition keys. To learn about all of the elements that you use in a JSON policy, see IAM JSON Policy Elements Reference in the IAM User Guide.

You can use AWS root credentials or IAM user credentials to create an Amazon QuickSight account. AWS root and administrator credentials already have all of the required permissions for managing Amazon QuickSight access to AWS resources.

However, we recommend that you protect your root credentials, and instead use IAM user credentials. To do this, you can create a policy and attach it to the IAM user and roles that you plan to use for Amazon QuickSight. The policy must include the appropriate statements for the Amazon QuickSight administrative tasks you need to perform, as described in the following sections.

Important

Be aware of the following when working with Amazon QuickSight and IAM policies:

• Avoid directly modifying a policy that was created by Amazon QuickSight. When you modify it yourself, Amazon QuickSight can't edit it. This inability can cause an issue with the policy. To fix this issue, delete the previously modified policy.

• If you get an error on permissions when you try to create an Amazon QuickSight account, see Actions Defined by Amazon QuickSight in the IAM User Guide.

• In some cases, you might have an Amazon QuickSight account that you can't access even from the root account (for example, if you accidentally deleted its directory service). In this case, you can delete your old Amazon QuickSight account, then recreate it. For more information, see Deleting your Amazon QuickSight subscription and closing the account.

Actions

Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions.

The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions.

Include actions in a policy to grant permissions to perform the associated operation.

Policy actions in Amazon QuickSight use the following prefix before the action: quicksight:. For example, to grant someone permission to run an Amazon EC2 instance with the Amazon EC2 RunInstances API operation, you include the ec2:RunInstances action in their policy. Policy statements must include either an Action or NotAction element. Amazon QuickSight defines its own set of actions that describe tasks that you can perform with this service.

To specify multiple actions in a single statement, separate them with commas as follows:

"Action": [
	      "quicksight:action1",
	      "quicksight:action2"]

You can specify multiple actions using wildcards (*). For example, to specify all actions that begin with the word Create, include the following action:

"Action": "quicksight:Create*"

Amazon QuickSight provides a number of AWS Identity and Access Management (IAM) actions. All Amazon QuickSight actions are prefixed with quicksight:, such as quicksight:Subscribe. For information about using Amazon QuickSight actions in an IAM policy, see IAM policy examples for Amazon QuickSight.

To see the most up-to-date list of Amazon QuickSight actions, see Actions Defined by Amazon QuickSight in the IAM User Guide.

Resources

Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions.

The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions.

For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources.

"Resource": "*"

Following is an example policy. It means that the caller with this policy attached, is able to invoke the CreateGroupMembership operation on any group, provided that the user name they are adding to the group is not user1.

{
    "Effect": "Allow",
    "Action": "quicksight:CreateGroupMembership",
    "Resource": "arn:aws:quicksight:us-east-1:aws-account-id:group/default/*",
    "Condition": {
        "StringNotEquals": {
            "quicksight:UserName": "user1"
        }
    }
}

Some Amazon QuickSight actions, such as those for creating resources, cannot be performed on a specific resource. In those cases, you must use the wildcard (*).

"Resource": "*"

Some API actions involve multiple resources. To specify multiple resources in a single statement, separate the ARNs with commas.

"Resource": [
	      "resource1",
	      "resource2"

To see a list of Amazon QuickSight resource types and their Amazon Resource Names (ARNs), see Resources Defined by Amazon QuickSight in the IAM User Guide. To learn with which actions you can specify the ARN of each resource, see Actions Defined by Amazon QuickSight.

Condition keys

Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions.

The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request.

If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted.

You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide.

AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide.

Amazon QuickSight does not provide any service-specific condition keys, but it does support using some global condition keys. To see all AWS global condition keys, see AWS Global Condition Context Keys in the IAM User Guide.

Examples

To view examples of Amazon QuickSight identity-based policies, see IAM identity-based policies for Amazon QuickSight.