[ aws . quicksight ]

list-user-groups

Description

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-user-groups
--user-name <value>
--aws-account-id <value>
--namespace <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--user-name (string)

The Amazon QuickSight user name that you want to list group memberships for.

--aws-account-id (string)

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

--namespace (string)

The namespace. Currently, you should set this to default .

--next-token (string)

A pagination token that can be used in a subsequent request.

--max-results (integer)

The maximum number of results to return from this request.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

GroupList -> (list)

The list of groups the user is a member of.

(structure)

A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.

Arn -> (string)

The Amazon Resource Name (ARN) for the group.

GroupName -> (string)

The name of the group.

Description -> (string)

The group description.

PrincipalId -> (string)

The principal ID of the group.

NextToken -> (string)

A pagination token that can be used in a subsequent request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.