amazonka-finspace-data-2.0: Amazon FinSpace Public API SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FinSpaceData.Types.PermissionGroup

Description

 
Synopsis

Documentation

data PermissionGroup Source #

The structure for a permission group.

See: newPermissionGroup smart constructor.

Constructors

PermissionGroup' 

Fields

  • applicationPermissions :: Maybe [ApplicationPermission]

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

    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.
  • createTime :: Maybe Integer

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

  • description :: Maybe (Sensitive Text)

    A brief description for the permission group.

  • lastModifiedTime :: Maybe Integer

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

  • membershipStatus :: Maybe PermissionGroupMembershipStatus

    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.
  • name :: Maybe (Sensitive Text)

    The name of the permission group.

  • permissionGroupId :: Maybe Text

    The unique identifier for the permission group.

Instances

Instances details
FromJSON PermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.PermissionGroup

Generic PermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.PermissionGroup

Associated Types

type Rep PermissionGroup :: Type -> Type #

Show PermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.PermissionGroup

NFData PermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.PermissionGroup

Methods

rnf :: PermissionGroup -> () #

Eq PermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.PermissionGroup

Hashable PermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.PermissionGroup

type Rep PermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.PermissionGroup

type Rep PermissionGroup = D1 ('MetaData "PermissionGroup" "Amazonka.FinSpaceData.Types.PermissionGroup" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "PermissionGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationPermissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApplicationPermission])) :*: (S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "membershipStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PermissionGroupMembershipStatus))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "permissionGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newPermissionGroup :: PermissionGroup Source #

Create a value of PermissionGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:applicationPermissions:PermissionGroup', permissionGroup_applicationPermissions - Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

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.

$sel:createTime:PermissionGroup', permissionGroup_createTime - The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.

$sel:description:PermissionGroup', permissionGroup_description - A brief description for the permission group.

$sel:lastModifiedTime:PermissionGroup', permissionGroup_lastModifiedTime - Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.

$sel:membershipStatus:PermissionGroup', permissionGroup_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.

$sel:name:PermissionGroup', permissionGroup_name - The name of the permission group.

$sel:permissionGroupId:PermissionGroup', permissionGroup_permissionGroupId - The unique identifier for the permission group.

permissionGroup_applicationPermissions :: Lens' PermissionGroup (Maybe [ApplicationPermission]) Source #

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

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.

permissionGroup_createTime :: Lens' PermissionGroup (Maybe Integer) Source #

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

permissionGroup_description :: Lens' PermissionGroup (Maybe Text) Source #

A brief description for the permission group.

permissionGroup_lastModifiedTime :: Lens' PermissionGroup (Maybe Integer) Source #

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

permissionGroup_membershipStatus :: Lens' PermissionGroup (Maybe PermissionGroupMembershipStatus) Source #

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.

permissionGroup_name :: Lens' PermissionGroup (Maybe Text) Source #

The name of the permission group.

permissionGroup_permissionGroupId :: Lens' PermissionGroup (Maybe Text) Source #

The unique identifier for the permission group.