Amazonka.FinSpaceData.CreatePermissionGroup

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

Creating a Request

data CreatePermissionGroup

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

ToJSON CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

toJSON :: CreatePermissionGroup -> Value

toEncoding :: CreatePermissionGroup -> Encoding

toJSONList :: [CreatePermissionGroup] -> Value

toEncodingList :: [CreatePermissionGroup] -> Encoding

ToHeaders CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

toHeaders :: CreatePermissionGroup -> [Header]

ToPath CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

toPath :: CreatePermissionGroup -> ByteString

ToQuery CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

toQuery :: CreatePermissionGroup -> QueryString

AWSRequest CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Associated Types

type AWSResponse CreatePermissionGroup

Methods

request :: (Service -> Service) -> CreatePermissionGroup -> Request CreatePermissionGroup

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreatePermissionGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePermissionGroup)))

Generic CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Associated Types

type Rep CreatePermissionGroup :: Type -> Type

Methods

from :: CreatePermissionGroup -> Rep CreatePermissionGroup x

to :: Rep CreatePermissionGroup x -> CreatePermissionGroup

Show CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

showsPrec :: Int -> CreatePermissionGroup -> ShowS

show :: CreatePermissionGroup -> String

showList :: [CreatePermissionGroup] -> ShowS

NFData CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

rnf :: CreatePermissionGroup -> ()

Eq CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

(==) :: CreatePermissionGroup -> CreatePermissionGroup -> Bool

(/=) :: CreatePermissionGroup -> CreatePermissionGroup -> Bool

Hashable CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

hashWithSalt :: Int -> CreatePermissionGroup -> Int

hash :: CreatePermissionGroup -> Int

type AWSResponse CreatePermissionGroup

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

type AWSResponse CreatePermissionGroup = CreatePermissionGroupResponse

type Rep CreatePermissionGroup

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

Arguments

:: Text

CreatePermissionGroup

-> CreatePermissionGroup

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)

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

createPermissionGroup_description :: Lens' CreatePermissionGroup (Maybe Text)

A brief description for the permission group.

createPermissionGroup_name :: Lens' CreatePermissionGroup Text

The name of the permission group.

createPermissionGroup_applicationPermissions :: Lens' CreatePermissionGroup [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.

Destructuring the Response

data CreatePermissionGroupResponse

See: newCreatePermissionGroupResponse smart constructor.

Constructors

CreatePermissionGroupResponse'

Fields

• permissionGroupId :: Maybe Text

  The unique identifier for the permission group.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreatePermissionGroupResponse

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Associated Types

type Rep CreatePermissionGroupResponse :: Type -> Type

Methods

from :: CreatePermissionGroupResponse -> Rep CreatePermissionGroupResponse x

to :: Rep CreatePermissionGroupResponse x -> CreatePermissionGroupResponse

Read CreatePermissionGroupResponse

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

readsPrec :: Int -> ReadS CreatePermissionGroupResponse

readList :: ReadS [CreatePermissionGroupResponse]

readPrec :: ReadPrec CreatePermissionGroupResponse

readListPrec :: ReadPrec [CreatePermissionGroupResponse]

Show CreatePermissionGroupResponse

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

showsPrec :: Int -> CreatePermissionGroupResponse -> ShowS

show :: CreatePermissionGroupResponse -> String

showList :: [CreatePermissionGroupResponse] -> ShowS

NFData CreatePermissionGroupResponse

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

rnf :: CreatePermissionGroupResponse -> ()

Eq CreatePermissionGroupResponse

Defined in Amazonka.FinSpaceData.CreatePermissionGroup

Methods

(==) :: CreatePermissionGroupResponse -> CreatePermissionGroupResponse -> Bool

(/=) :: CreatePermissionGroupResponse -> CreatePermissionGroupResponse -> Bool

type Rep CreatePermissionGroupResponse

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

Arguments

:: Int

$sel:httpStatus:CreatePermissionGroupResponse'

-> CreatePermissionGroupResponse

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

createPermissionGroupResponse_permissionGroupId :: Lens' CreatePermissionGroupResponse (Maybe Text)

The unique identifier for the permission group.

createPermissionGroupResponse_httpStatus :: Lens' CreatePermissionGroupResponse Int

The response's http status code.