[ aws . quicksight ]

update-dashboard-permissions

Description

Updates read and write permissions on a dashboard.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-dashboard-permissions
--aws-account-id <value>
--dashboard-id <value>
[--grant-permissions <value>]
[--revoke-permissions <value>]
[--grant-link-permissions <value>]
[--revoke-link-permissions <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 whose permissions you’re updating.

--dashboard-id (string)

The ID for the dashboard.

--grant-permissions (list)

The permissions that you want to grant on this resource.

(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)

Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--revoke-permissions (list)

The permissions that you want to revoke from this resource.

(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)

Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--grant-link-permissions (list)

Grants link permissions to all users in a defined namespace.

(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)

Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--revoke-link-permissions (list)

Revokes link permissions from all users in a defined namespace.

(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)

Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

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

DashboardArn -> (string)

The Amazon Resource Name (ARN) of the dashboard.

DashboardId -> (string)

The ID for the dashboard.

Permissions -> (list)

Information about the permissions on 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)

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.

LinkSharingConfiguration -> (structure)

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

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)