Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FinSpaceData.UpdateUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the details of the specified user account. You cannot update the userId for a user.

Synopsis

data UpdateUser = UpdateUser' {
- apiAccess :: Maybe ApiAccess
- apiAccessPrincipalArn :: Maybe Text
- clientToken :: Maybe Text
- firstName :: Maybe (Sensitive Text)
- lastName :: Maybe (Sensitive Text)
- type' :: Maybe UserType
- userId :: Text
}
newUpdateUser :: Text -> UpdateUser
updateUser_apiAccess :: Lens' UpdateUser (Maybe ApiAccess)
updateUser_apiAccessPrincipalArn :: Lens' UpdateUser (Maybe Text)
updateUser_clientToken :: Lens' UpdateUser (Maybe Text)
updateUser_firstName :: Lens' UpdateUser (Maybe Text)
updateUser_lastName :: Lens' UpdateUser (Maybe Text)
updateUser_type :: Lens' UpdateUser (Maybe UserType)
updateUser_userId :: Lens' UpdateUser Text
data UpdateUserResponse = UpdateUserResponse' {
- userId :: Maybe Text
- httpStatus :: Int
}
newUpdateUserResponse :: Int -> UpdateUserResponse
updateUserResponse_userId :: Lens' UpdateUserResponse (Maybe Text)
updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int

Creating a Request

data UpdateUser Source #

See: newUpdateUser smart constructor.

Constructors

UpdateUser'

Fields

apiAccess :: Maybe ApiAccess
The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
- ENABLED – The user has permissions to use the APIs.
- DISABLED – The user does not have permissions to use any APIs.
apiAccessPrincipalArn :: Maybe Text
The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
clientToken :: Maybe Text
A token that ensures idempotency. This token expires in 10 minutes.
firstName :: Maybe (Sensitive Text)
The first name of the user.
lastName :: Maybe (Sensitive Text)
The last name of the user.
type' :: Maybe UserType
The option to indicate 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 :: Text
The unique identifier for the user account to update.

Instances

Instances details

ToJSON UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods toJSON :: UpdateUser -> Value # toEncoding :: UpdateUser -> Encoding # toJSONList :: [UpdateUser] -> Value # toEncodingList :: [UpdateUser] -> Encoding #
ToHeaders UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods toHeaders :: UpdateUser -> [Header] #
ToPath UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods toPath :: UpdateUser -> ByteString #
ToQuery UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods toQuery :: UpdateUser -> QueryString #
AWSRequest UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Associated Types type AWSResponse UpdateUser # Methods request :: (Service -> Service) -> UpdateUser -> Request UpdateUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateUser))) #
Generic UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Associated Types type Rep UpdateUser :: Type -> Type # Methods from :: UpdateUser -> Rep UpdateUser x # to :: Rep UpdateUser x -> UpdateUser #
Show UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods showsPrec :: Int -> UpdateUser -> ShowS # show :: UpdateUser -> String # showList :: [UpdateUser] -> ShowS #
NFData UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods rnf :: UpdateUser -> () #
Eq UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods (==) :: UpdateUser -> UpdateUser -> Bool # (/=) :: UpdateUser -> UpdateUser -> Bool #
Hashable UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods hashWithSalt :: Int -> UpdateUser -> Int # hash :: UpdateUser -> Int #
type AWSResponse UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser type AWSResponse UpdateUser = UpdateUserResponse
type Rep UpdateUser Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser type Rep UpdateUser = D1 ('MetaData "UpdateUser" "Amazonka.FinSpaceData.UpdateUser" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "UpdateUser'" '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 "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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 "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserType)) :: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateUser Source #

Arguments

:: Text	`UpdateUser`
-> UpdateUser

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

UpdateUser, updateUser_apiAccess - The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

ENABLED – The user has permissions to use the APIs.
DISABLED – The user does not have permissions to use any APIs.

UpdateUser, updateUser_apiAccessPrincipalArn - The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

$sel:clientToken:UpdateUser', updateUser_clientToken - A token that ensures idempotency. This token expires in 10 minutes.

UpdateUser, updateUser_firstName - The first name of the user.

UpdateUser, updateUser_lastName - The last name of the user.

UpdateUser, updateUser_type - The option to indicate 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.

UpdateUser, updateUser_userId - The unique identifier for the user account to update.

Request Lenses

updateUser_apiAccess :: Lens' UpdateUser (Maybe ApiAccess) Source #

The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

ENABLED – The user has permissions to use the APIs.
DISABLED – The user does not have permissions to use any APIs.

updateUser_apiAccessPrincipalArn :: Lens' UpdateUser (Maybe Text) Source #

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

updateUser_clientToken :: Lens' UpdateUser (Maybe Text) Source #

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

updateUser_firstName :: Lens' UpdateUser (Maybe Text) Source #

The first name of the user.

updateUser_lastName :: Lens' UpdateUser (Maybe Text) Source #

The last name of the user.

updateUser_type :: Lens' UpdateUser (Maybe UserType) Source #

The option to indicate 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.

updateUser_userId :: Lens' UpdateUser Text Source #

The unique identifier for the user account to update.

Destructuring the Response

data UpdateUserResponse Source #

See: newUpdateUserResponse smart constructor.

Constructors

UpdateUserResponse'
Fields userId :: Maybe Text The unique identifier of the updated user account. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Associated Types type Rep UpdateUserResponse :: Type -> Type # Methods from :: UpdateUserResponse -> Rep UpdateUserResponse x # to :: Rep UpdateUserResponse x -> UpdateUserResponse #
Read UpdateUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods readsPrec :: Int -> ReadS UpdateUserResponse # readList :: ReadS [UpdateUserResponse] # readPrec :: ReadPrec UpdateUserResponse # readListPrec :: ReadPrec [UpdateUserResponse] #
Show UpdateUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods showsPrec :: Int -> UpdateUserResponse -> ShowS # show :: UpdateUserResponse -> String # showList :: [UpdateUserResponse] -> ShowS #
NFData UpdateUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods rnf :: UpdateUserResponse -> () #
Eq UpdateUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser Methods (==) :: UpdateUserResponse -> UpdateUserResponse -> Bool # (/=) :: UpdateUserResponse -> UpdateUserResponse -> Bool #
type Rep UpdateUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.UpdateUser type Rep UpdateUserResponse = D1 ('MetaData "UpdateUserResponse" "Amazonka.FinSpaceData.UpdateUser" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "UpdateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateUserResponse'`
-> UpdateUserResponse

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

UpdateUser, updateUserResponse_userId - The unique identifier of the updated user account.

$sel:httpStatus:UpdateUserResponse', updateUserResponse_httpStatus - The response's http status code.

Response Lenses

updateUserResponse_userId :: Lens' UpdateUserResponse (Maybe Text) Source #

The unique identifier of the updated user account.

updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #

The response's http status code.