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

Description

Creates a group of permissions for various actions that a user can perform in FinSpace.

Synopsis

Creating a Request

data CreatePermissionGroup Source #

See: newCreatePermissionGroup smart constructor.

Constructors

CreatePermissionGroup' 

Fields

  • clientToken :: Maybe Text

    A token that ensures idempotency. This token expires in 10 minutes.

  • description :: Maybe (Sensitive Text)

    A brief description for the permission group.

  • name :: Sensitive Text

    The name of the permission group.

  • applicationPermissions :: [ApplicationPermission]

    The option to indicate FinSpace application permissions that are granted to a specific group.

    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.

Instances

Instances details
ToJSON CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

ToHeaders CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

ToPath CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

ToQuery CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

AWSRequest CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Associated Types

type AWSResponse CreatePermissionGroup #

Generic CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Associated Types

type Rep CreatePermissionGroup :: Type -> Type #

Show CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

NFData CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

rnf :: CreatePermissionGroup -> () #

Eq CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Hashable CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

type AWSResponse CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

type Rep CreatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

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

newCreatePermissionGroup Source #

Create a value of CreatePermissionGroup 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:clientToken:CreatePermissionGroup', createPermissionGroup_clientToken - A token that ensures idempotency. This token expires in 10 minutes.

CreatePermissionGroup, createPermissionGroup_description - A brief description for the permission group.

CreatePermissionGroup, createPermissionGroup_name - The name of the permission group.

CreatePermissionGroup, createPermissionGroup_applicationPermissions - The option to indicate FinSpace application permissions that are granted to a specific group.

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.

Request Lenses

createPermissionGroup_clientToken :: Lens' CreatePermissionGroup (Maybe Text) Source #

A token that ensures idempotency. This token expires in 10 minutes.

createPermissionGroup_description :: Lens' CreatePermissionGroup (Maybe Text) Source #

A brief description for the permission group.

createPermissionGroup_applicationPermissions :: Lens' CreatePermissionGroup [ApplicationPermission] Source #

The option to indicate FinSpace application permissions that are granted to a specific group.

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.

Destructuring the Response

data CreatePermissionGroupResponse Source #

See: newCreatePermissionGroupResponse smart constructor.

Constructors

CreatePermissionGroupResponse' 

Fields

Instances

Instances details
Generic CreatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Associated Types

type Rep CreatePermissionGroupResponse :: Type -> Type #

Read CreatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Show CreatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

NFData CreatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Eq CreatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

type Rep CreatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

type Rep CreatePermissionGroupResponse = D1 ('MetaData "CreatePermissionGroupResponse" "Amazonka.FinSpaceData.CreatePermissionGroup" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "CreatePermissionGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "permissionGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreatePermissionGroupResponse Source #

Create a value of CreatePermissionGroupResponse 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:

CreatePermissionGroupResponse, createPermissionGroupResponse_permissionGroupId - The unique identifier for the permission group.

$sel:httpStatus:CreatePermissionGroupResponse', createPermissionGroupResponse_httpStatus - The response's http status code.

Response Lenses