[ aws . quicksight ]
describe-dashboard-permissions¶
Description¶
Describes read and write permissions for a dashboard.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-dashboard-permissions
--aws-account-id <value>
--dashboard-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--aws-account-id (string)
The ID of the Amazon Web Services account that contains the dashboard that you’re describing permissions for.
--dashboard-id (string)
The ID for the dashboard, also added to the IAM policy.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
DashboardId -> (string)
The ID for the dashboard.
DashboardArn -> (string)
The Amazon Resource Name (ARN) of the dashboard.
Permissions -> (list)
A structure that contains the permissions for the dashboard.
(structure)
Permission for the resource.
Principal -> (string)
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions -> (list)
The IAM action to grant or revoke permissions on.
(string)
Status -> (integer)
The HTTP status of the request.
RequestId -> (string)
The Amazon Web Services request ID for this operation.
LinkSharingConfiguration -> (structure)
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 .
Permissions -> (list)
A structure that contains the permissions of a shareable link.
(structure)
Permission for the resource.
Principal -> (string)
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions -> (list)
The IAM action to grant or revoke permissions on.
(string)