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

Description

 
Synopsis

Documentation

data UserByPermissionGroup Source #

The structure of a user account associated with a permission group.

See: newUserByPermissionGroup smart constructor.

Constructors

UserByPermissionGroup' 

Fields

  • apiAccess :: Maybe ApiAccess

    Indicates whether the user can access FinSpace API operations.

    • ENABLED – The user has permissions to use the API operations.
    • DISABLED – The user does not have permissions to use any API operations.
  • apiAccessPrincipalArn :: Maybe Text

    The IAM ARN identifier that is attached to FinSpace API calls.

  • emailAddress :: Maybe (Sensitive Text)

    The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

  • firstName :: Maybe (Sensitive Text)

    The first name of the user.

  • lastName :: Maybe (Sensitive Text)

    The last name of the user.

  • 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.
  • status :: Maybe UserStatus

    The current status of the user account.

    • CREATING – The user account creation is in progress.
    • ENABLED – The user account is created and is currently active.
    • DISABLED – The user account is currently inactive.
  • type' :: Maybe UserType

    Indicates the type of user.

    • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
  • userId :: Maybe Text

    The unique identifier for the user.

Instances

Instances details
FromJSON UserByPermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.UserByPermissionGroup

Methods

parseJSON :: Value -> Parser UserByPermissionGroup #

parseJSONList :: Value -> Parser [UserByPermissionGroup] #

Generic UserByPermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.UserByPermissionGroup

Associated Types

type Rep UserByPermissionGroup :: Type -> Type #

Methods

from :: UserByPermissionGroup -> Rep UserByPermissionGroup x #

to :: Rep UserByPermissionGroup x -> UserByPermissionGroup #

Show UserByPermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.UserByPermissionGroup

Methods

showsPrec :: Int -> UserByPermissionGroup -> ShowS #

show :: UserByPermissionGroup -> String #

showList :: [UserByPermissionGroup] -> ShowS #

NFData UserByPermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.UserByPermissionGroup

Methods

rnf :: UserByPermissionGroup -> () #

Eq UserByPermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.UserByPermissionGroup

Methods

(==) :: UserByPermissionGroup -> UserByPermissionGroup -> Bool #

(/=) :: UserByPermissionGroup -> UserByPermissionGroup -> Bool #

Hashable UserByPermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.UserByPermissionGroup

Methods

hashWithSalt :: Int -> UserByPermissionGroup -> Int #

hash :: UserByPermissionGroup -> Int #

type Rep UserByPermissionGroup Source # 
Instance details

Defined in Amazonka.FinSpaceData.Types.UserByPermissionGroup

type Rep UserByPermissionGroup = D1 ('MetaData "UserByPermissionGroup" "Amazonka.FinSpaceData.Types.UserByPermissionGroup" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "UserByPermissionGroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiAccess)) :*: S1 ('MetaSel ('Just "apiAccessPrincipalArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "firstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "lastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "membershipStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PermissionGroupMembershipStatus))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserStatus)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserType)) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newUserByPermissionGroup :: UserByPermissionGroup Source #

Create a value of UserByPermissionGroup 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:apiAccess:UserByPermissionGroup', userByPermissionGroup_apiAccess - Indicates whether the user can access FinSpace API operations.

  • ENABLED – The user has permissions to use the API operations.
  • DISABLED – The user does not have permissions to use any API operations.

$sel:apiAccessPrincipalArn:UserByPermissionGroup', userByPermissionGroup_apiAccessPrincipalArn - The IAM ARN identifier that is attached to FinSpace API calls.

$sel:emailAddress:UserByPermissionGroup', userByPermissionGroup_emailAddress - The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

$sel:firstName:UserByPermissionGroup', userByPermissionGroup_firstName - The first name of the user.

$sel:lastName:UserByPermissionGroup', userByPermissionGroup_lastName - The last name of the user.

$sel:membershipStatus:UserByPermissionGroup', userByPermissionGroup_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:status:UserByPermissionGroup', userByPermissionGroup_status - The current status of the user account.

  • CREATING – The user account creation is in progress.
  • ENABLED – The user account is created and is currently active.
  • DISABLED – The user account is currently inactive.

$sel:type':UserByPermissionGroup', userByPermissionGroup_type - Indicates the type of user.

  • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
  • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

$sel:userId:UserByPermissionGroup', userByPermissionGroup_userId - The unique identifier for the user.

userByPermissionGroup_apiAccess :: Lens' UserByPermissionGroup (Maybe ApiAccess) Source #

Indicates whether the user can access FinSpace API operations.

  • ENABLED – The user has permissions to use the API operations.
  • DISABLED – The user does not have permissions to use any API operations.

userByPermissionGroup_apiAccessPrincipalArn :: Lens' UserByPermissionGroup (Maybe Text) Source #

The IAM ARN identifier that is attached to FinSpace API calls.

userByPermissionGroup_emailAddress :: Lens' UserByPermissionGroup (Maybe Text) Source #

The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

userByPermissionGroup_firstName :: Lens' UserByPermissionGroup (Maybe Text) Source #

The first name of the user.

userByPermissionGroup_lastName :: Lens' UserByPermissionGroup (Maybe Text) Source #

The last name of the user.

userByPermissionGroup_membershipStatus :: Lens' UserByPermissionGroup (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.

userByPermissionGroup_status :: Lens' UserByPermissionGroup (Maybe UserStatus) Source #

The current status of the user account.

  • CREATING – The user account creation is in progress.
  • ENABLED – The user account is created and is currently active.
  • DISABLED – The user account is currently inactive.

userByPermissionGroup_type :: Lens' UserByPermissionGroup (Maybe UserType) Source #

Indicates the type of user.

  • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
  • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

userByPermissionGroup_userId :: Lens' UserByPermissionGroup (Maybe Text) Source #

The unique identifier for the user.