[ aws . quicksight ]

update-theme-permissions

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-theme-permissions
--aws-account-id <value>
--theme-id <value>
[--grant-permissions <value>]
[--revoke-permissions <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--aws-account-id (string)

The ID of the AWS account that contains the theme.

--theme-id (string)

The ID for the theme.

--grant-permissions (list)

A list of resource permissions to be granted for the theme.

(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, group, or namespace. (This is most 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 action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--revoke-permissions (list)

A list of resource permissions to be revoked from the theme.

(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, group, or namespace. (This is most 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 action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ThemeId -> (string)

The ID for the theme.

ThemeArn -> (string)

The Amazon Resource Name (ARN) of the theme.

Permissions -> (list)

The resulting list of resource permissions for the theme.

(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, group, or namespace. (This is most 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 action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .

(string)

RequestId -> (string)

The AWS request ID for this operation.

Status -> (integer)

The HTTP status of the request.