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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new user in FinSpace.

Synopsis

data CreateUser = CreateUser' {
- apiAccess :: Maybe ApiAccess
- apiAccessPrincipalArn :: Maybe Text
- clientToken :: Maybe Text
- firstName :: Maybe (Sensitive Text)
- lastName :: Maybe (Sensitive Text)
- emailAddress :: Sensitive Text
- type' :: UserType
}
newCreateUser :: Text -> UserType -> CreateUser
createUser_apiAccess :: Lens' CreateUser (Maybe ApiAccess)
createUser_apiAccessPrincipalArn :: Lens' CreateUser (Maybe Text)
createUser_clientToken :: Lens' CreateUser (Maybe Text)
createUser_firstName :: Lens' CreateUser (Maybe Text)
createUser_lastName :: Lens' CreateUser (Maybe Text)
createUser_emailAddress :: Lens' CreateUser Text
createUser_type :: Lens' CreateUser UserType
data CreateUserResponse = CreateUserResponse' {
- userId :: Maybe Text
- httpStatus :: Int
}
newCreateUserResponse :: Int -> CreateUserResponse
createUserResponse_userId :: Lens' CreateUserResponse (Maybe Text)
createUserResponse_httpStatus :: Lens' CreateUserResponse Int

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser'

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 that you want to register.
lastName :: Maybe (Sensitive Text)
The last name of the user that you want to register.
emailAddress :: Sensitive Text
The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
type' :: UserType
The option to indicate the type of user. Use one of the following options to specify this parameter:
- 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.

Instances

Instances details

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

newCreateUser Source #

Arguments

:: Text	`CreateUser`
-> UserType	`CreateUser`
-> CreateUser

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

CreateUser, createUser_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.

CreateUser, createUser_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:CreateUser', createUser_clientToken - A token that ensures idempotency. This token expires in 10 minutes.

CreateUser, createUser_firstName - The first name of the user that you want to register.

CreateUser, createUser_lastName - The last name of the user that you want to register.

CreateUser, createUser_emailAddress - The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

CreateUser, createUser_type - The option to indicate the type of user. Use one of the following options to specify this parameter:

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.

Request Lenses

createUser_apiAccess :: Lens' CreateUser (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.

createUser_apiAccessPrincipalArn :: Lens' CreateUser (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.

createUser_clientToken :: Lens' CreateUser (Maybe Text) Source #

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

createUser_firstName :: Lens' CreateUser (Maybe Text) Source #

The first name of the user that you want to register.

createUser_lastName :: Lens' CreateUser (Maybe Text) Source #

The last name of the user that you want to register.

createUser_emailAddress :: Lens' CreateUser Text Source #

The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

createUser_type :: Lens' CreateUser UserType Source #

The option to indicate the type of user. Use one of the following options to specify this parameter:

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.

Destructuring the Response

data CreateUserResponse Source #

See: newCreateUserResponse smart constructor.

Constructors

CreateUserResponse'
Fields userId :: Maybe Text The unique identifier for the user. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateUserResponse Source #

Arguments

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

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

CreateUserResponse, createUserResponse_userId - The unique identifier for the user.

$sel:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.

Response Lenses

createUserResponse_userId :: Lens' CreateUserResponse (Maybe Text) Source #

The unique identifier for the user.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.