[ aws . finspace-data ]

list-permission-groups

Description

Lists all available permission groups in FinSpace.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-permission-groups is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: permissionGroups

Synopsis

  list-permission-groups
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 all the permission groups.

(structure)

The structure for a permission group.

permissionGroupId -> (string)

The unique identifier for the permission group.

name -> (string)

The name of the permission group.

description -> (string)

A brief description for the permission group.

applicationPermissions -> (list)

Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

Warning

When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment’s application. It should only be granted to trusted users.

• CreateDataset – Group members can create new datasets.

• ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.

• ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.

• ManageAttributeSets – Group members can manage attribute sets.

• ViewAuditData – Group members can view audit data.

• AccessNotebooks – Group members will have access to FinSpace notebooks.

• GetTemporaryCredentials – Group members can get temporary API credentials.

(string)

createTime -> (long)

The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.

lastModifiedTime -> (long)

Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.

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.