[ aws . finspace-data ]

list-permission-groups-by-user

Description

Lists all the permission groups that are associated with a specific user account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-permission-groups-by-user
--user-id <value>
[--next-token <value>]
--max-results <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--user-id (string)

The unique identifier for the user.

--next-token (string)

A token that indicates where a results page should begin.

--max-results (integer)

The maximum number of results per page.

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

permissionGroups -> (list)

A list of returned permission groups.

(structure)

The structure of a permission group associated with a user account.

permissionGroupId -> (string)

The unique identifier for the permission group.

name -> (string)

The name of the permission group.

membershipStatus -> (string)

Indicates the status of the user account within a permission group.

• ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.

• ADDITION_SUCCESS – The user account is successfully added to the permission group.

• REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

nextToken -> (string)

A token that indicates where a results page should begin.