[ aws . quicksight ]

create-iam-policy-assignment

Description

Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-iam-policy-assignment
--aws-account-id <value>
--assignment-name <value>
--assignment-status <value>
[--policy-arn <value>]
[--identities <value>]
--namespace <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the Amazon Web Services account where you want to assign an IAMpolicy to Amazon QuickSight users or groups.

--assignment-name (string)

The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.

--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 IAMpolicy to apply to the Amazon QuickSight users and groups specified in this assignment.

--identities (map)

The Amazon 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", ...]
  ...}

--namespace (string)

The namespace that contains the assignment.

--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. This name must be unique within the Amazon Web Services account.

AssignmentId -> (string)

The ID for the assignment.

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.

PolicyArn -> (string)

The ARN for the IAMpolicy that is applied to the Amazon QuickSight users and groups specified in this assignment.

Identities -> (map)

The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.

key -> (string)

value -> (list)

(string)

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.