[ aws . finspace-data ]

get-permission-group

Description

Retrieves the details of a specific permission group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-permission-group
--permission-group-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--permission-group-id (string)

The unique identifier for the permission group.

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

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