PermissionGroup - Amazon FinSpace

PermissionGroup

The structure for a permission group.

Contents

Note

In the following list, the required parameters are described first.

applicationPermissions

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

Important

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.

Type: Array of strings

Valid Values: CreateDataset | ManageClusters | ManageUsersAndGroups | ManageAttributeSets | ViewAuditData | AccessNotebooks | GetTemporaryCredentials

Required: No

createTime

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

Type: Long

Required: No

description

A brief description for the permission group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4000.

Pattern: [\s\S]*

Required: No

lastModifiedTime

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

Type: Long

Required: No

membershipStatus

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.

Type: String

Valid Values: ADDITION_IN_PROGRESS | ADDITION_SUCCESS | REMOVAL_IN_PROGRESS

Required: No

name

The name of the permission group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: .*\S.*

Required: No

permissionGroupId

The unique identifier for the permission group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: .*\S.*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: