[ aws . quicksight ]

update-iam-policy-assignment

Description

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-iam-policy-assignment
--aws-account-id <value>
--assignment-name <value>
--namespace <value>
[--assignment-status <value>]
[--policy-arn <value>]
[--identities <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 IAM policy assignment.

--assignment-name (string)

The name of the assignment, also called a rule. This name must be unique within an AWS account.

--namespace (string)

The namespace of the assignment.

--assignment-status (string)

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn’t used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn’t used when creating the data source.

Possible values:

• ENABLED

• DRAFT

• DISABLED

--policy-arn (string)

The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.

--identities (map)

The QuickSight users, groups, or both that you want to assign the policy to.

key -> (string)

value -> (list)

(string)

Shorthand Syntax:

KeyName1=string,string,KeyName2=string,string

JSON Syntax:

{"string": ["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

AssignmentName -> (string)

The name of the assignment or rule.

AssignmentId -> (string)

The ID of the assignment.

PolicyArn -> (string)

The ARN for the IAM policy applied to the QuickSight users and groups specified in this assignment.

Identities -> (map)

The QuickSight users, groups, or both that the IAM policy is assigned to.

key -> (string)

value -> (list)

(string)

AssignmentStatus -> (string)

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn’t used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn’t used when creating the data source.

RequestId -> (string)

The AWS request ID for this operation.

Status -> (integer)

The HTTP status of the request.