[ aws . quicksight ]

describe-analysis-permissions

Description

Provides the read and write permissions for an analysis.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-analysis-permissions
--aws-account-id <value>
--analysis-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the AWS account that contains the analysis whose permissions you’re describing. You must be using the AWS account that the analysis is in.

--analysis-id (string)

The ID of the analysis whose permissions you’re describing. The ID is part of the analysis URL.

--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.

See ‘aws help’ for descriptions of global parameters.

Output

AnalysisId -> (string)

The ID of the analysis whose permissions you’re describing.

AnalysisArn -> (string)

The Amazon Resource Name (ARN) of the analysis whose permissions you’re describing.

Permissions -> (list)

A structure that describes the principals and the resource-level permissions on an analysis.

(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 AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS 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 AWS request ID for this operation.