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

Description

Modifies the details of a permission group. You cannot modify a permissionGroupID.

Synopsis

Creating a Request

data UpdatePermissionGroup Source #

See: newUpdatePermissionGroup smart constructor.

Constructors

UpdatePermissionGroup' 

Fields

  • applicationPermissions :: Maybe [ApplicationPermission]

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

    The name of the permission group.

  • permissionGroupId :: Text

    The unique identifier for the permission group to update.

Instances

Instances details
ToJSON UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

ToHeaders UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

ToPath UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

ToQuery UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

AWSRequest UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

Associated Types

type AWSResponse UpdatePermissionGroup #

Generic UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

Associated Types

type Rep UpdatePermissionGroup :: Type -> Type #

Show UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

NFData UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

Methods

rnf :: UpdatePermissionGroup -> () #

Eq UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

Hashable UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

type AWSResponse UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

type Rep UpdatePermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

type Rep UpdatePermissionGroup = D1 ('MetaData "UpdatePermissionGroup" "Amazonka.FinSpaceData.UpdatePermissionGroup" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "UpdatePermissionGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationPermissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApplicationPermission])) :*: 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 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "permissionGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdatePermissionGroup Source #

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

UpdatePermissionGroup, updatePermissionGroup_applicationPermissions - 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:clientToken:UpdatePermissionGroup', updatePermissionGroup_clientToken - A token that ensures idempotency. This token expires in 10 minutes.

UpdatePermissionGroup, updatePermissionGroup_description - A brief description for the permission group.

UpdatePermissionGroup, updatePermissionGroup_name - The name of the permission group.

UpdatePermissionGroup, updatePermissionGroup_permissionGroupId - The unique identifier for the permission group to update.

Request Lenses

updatePermissionGroup_applicationPermissions :: Lens' UpdatePermissionGroup (Maybe [ApplicationPermission]) Source #

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.

updatePermissionGroup_clientToken :: Lens' UpdatePermissionGroup (Maybe Text) Source #

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

updatePermissionGroup_description :: Lens' UpdatePermissionGroup (Maybe Text) Source #

A brief description for the permission group.

updatePermissionGroup_permissionGroupId :: Lens' UpdatePermissionGroup Text Source #

The unique identifier for the permission group to update.

Destructuring the Response

data UpdatePermissionGroupResponse Source #

See: newUpdatePermissionGroupResponse smart constructor.

Constructors

UpdatePermissionGroupResponse' 

Fields

Instances

Instances details
Generic UpdatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

Associated Types

type Rep UpdatePermissionGroupResponse :: Type -> Type #

Read UpdatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

Show UpdatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

NFData UpdatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

Eq UpdatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

type Rep UpdatePermissionGroupResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.UpdatePermissionGroup

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

newUpdatePermissionGroupResponse Source #

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

UpdatePermissionGroup, updatePermissionGroupResponse_permissionGroupId - The unique identifier for the updated permission group.

$sel:httpStatus:UpdatePermissionGroupResponse', updatePermissionGroupResponse_httpStatus - The response's http status code.

Response Lenses

updatePermissionGroupResponse_permissionGroupId :: Lens' UpdatePermissionGroupResponse (Maybe Text) Source #

The unique identifier for the updated permission group.