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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves details for a specific user.

Synopsis

data GetUser = GetUser' {
- userId :: Text
}
newGetUser :: Text -> GetUser
getUser_userId :: Lens' GetUser Text
data GetUserResponse = GetUserResponse' {
- apiAccess :: Maybe ApiAccess
- apiAccessPrincipalArn :: Maybe Text
- createTime :: Maybe Integer
- emailAddress :: Maybe (Sensitive Text)
- firstName :: Maybe (Sensitive Text)
- lastDisabledTime :: Maybe Integer
- lastEnabledTime :: Maybe Integer
- lastLoginTime :: Maybe Integer
- lastModifiedTime :: Maybe Integer
- lastName :: Maybe (Sensitive Text)
- status :: Maybe UserStatus
- type' :: Maybe UserType
- userId :: Maybe Text
- httpStatus :: Int
}
newGetUserResponse :: Int -> GetUserResponse
getUserResponse_apiAccess :: Lens' GetUserResponse (Maybe ApiAccess)
getUserResponse_apiAccessPrincipalArn :: Lens' GetUserResponse (Maybe Text)
getUserResponse_createTime :: Lens' GetUserResponse (Maybe Integer)
getUserResponse_emailAddress :: Lens' GetUserResponse (Maybe Text)
getUserResponse_firstName :: Lens' GetUserResponse (Maybe Text)
getUserResponse_lastDisabledTime :: Lens' GetUserResponse (Maybe Integer)
getUserResponse_lastEnabledTime :: Lens' GetUserResponse (Maybe Integer)
getUserResponse_lastLoginTime :: Lens' GetUserResponse (Maybe Integer)
getUserResponse_lastModifiedTime :: Lens' GetUserResponse (Maybe Integer)
getUserResponse_lastName :: Lens' GetUserResponse (Maybe Text)
getUserResponse_status :: Lens' GetUserResponse (Maybe UserStatus)
getUserResponse_type :: Lens' GetUserResponse (Maybe UserType)
getUserResponse_userId :: Lens' GetUserResponse (Maybe Text)
getUserResponse_httpStatus :: Lens' GetUserResponse Int

Creating a Request

data GetUser Source #

See: newGetUser smart constructor.

Constructors

GetUser'
Fields userId :: Text The unique identifier of the user to get data for.

Instances

Instances details

ToHeaders GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods toHeaders :: GetUser -> [Header] #
ToPath GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods toPath :: GetUser -> ByteString #
ToQuery GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods toQuery :: GetUser -> QueryString #
AWSRequest GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Associated Types type AWSResponse GetUser # Methods request :: (Service -> Service) -> GetUser -> Request GetUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUser))) #
Generic GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Associated Types type Rep GetUser :: Type -> Type # Methods from :: GetUser -> Rep GetUser x # to :: Rep GetUser x -> GetUser #
Read GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods readsPrec :: Int -> ReadS GetUser # readList :: ReadS [GetUser] # readPrec :: ReadPrec GetUser # readListPrec :: ReadPrec [GetUser] #
Show GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods showsPrec :: Int -> GetUser -> ShowS # show :: GetUser -> String # showList :: [GetUser] -> ShowS #
NFData GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods rnf :: GetUser -> () #
Eq GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods (==) :: GetUser -> GetUser -> Bool # (/=) :: GetUser -> GetUser -> Bool #
Hashable GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods hashWithSalt :: Int -> GetUser -> Int # hash :: GetUser -> Int #
type AWSResponse GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser type AWSResponse GetUser = GetUserResponse
type Rep GetUser Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser type Rep GetUser = D1 ('MetaData "GetUser" "Amazonka.FinSpaceData.GetUser" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "GetUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetUser Source #

Arguments

:: Text	`GetUser`
-> GetUser

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

GetUser, getUser_userId - The unique identifier of the user to get data for.

Request Lenses

getUser_userId :: Lens' GetUser Text Source #

The unique identifier of the user to get data for.

Destructuring the Response

data GetUserResponse Source #

See: newGetUserResponse smart constructor.

Constructors

GetUserResponse'

Fields

apiAccess :: Maybe ApiAccess
Indicates 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.
createTime :: Maybe Integer
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
emailAddress :: Maybe (Sensitive Text)
The email address that is associated with the user.
firstName :: Maybe (Sensitive Text)
The first name of the user.
lastDisabledTime :: Maybe Integer
Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
lastEnabledTime :: Maybe Integer
Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
lastLoginTime :: Maybe Integer
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
lastModifiedTime :: Maybe Integer
Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
lastName :: Maybe (Sensitive Text)
The last name of the user.
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 account that is retrieved.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Associated Types type Rep GetUserResponse :: Type -> Type # Methods from :: GetUserResponse -> Rep GetUserResponse x # to :: Rep GetUserResponse x -> GetUserResponse #
Show GetUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods showsPrec :: Int -> GetUserResponse -> ShowS # show :: GetUserResponse -> String # showList :: [GetUserResponse] -> ShowS #
NFData GetUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods rnf :: GetUserResponse -> () #
Eq GetUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser Methods (==) :: GetUserResponse -> GetUserResponse -> Bool # (/=) :: GetUserResponse -> GetUserResponse -> Bool #
type Rep GetUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetUser type Rep GetUserResponse = D1 ('MetaData "GetUserResponse" "Amazonka.FinSpaceData.GetUser" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "GetUserResponse'" '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 "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((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 "lastDisabledTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "lastEnabledTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: ((S1 ('MetaSel ('Just "lastLoginTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "lastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((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)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetUserResponse Source #

Arguments

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

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

GetUserResponse, getUserResponse_apiAccess - Indicates 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.

GetUserResponse, getUserResponse_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.

GetUserResponse, getUserResponse_createTime - The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.

GetUserResponse, getUserResponse_emailAddress - The email address that is associated with the user.

GetUserResponse, getUserResponse_firstName - The first name of the user.

GetUserResponse, getUserResponse_lastDisabledTime - Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.

GetUserResponse, getUserResponse_lastEnabledTime - Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.

GetUserResponse, getUserResponse_lastLoginTime - Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

GetUserResponse, getUserResponse_lastModifiedTime - Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.

GetUserResponse, getUserResponse_lastName - The last name of the user.

GetUserResponse, getUserResponse_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.

GetUserResponse, getUserResponse_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.

GetUser, getUserResponse_userId - The unique identifier for the user account that is retrieved.

$sel:httpStatus:GetUserResponse', getUserResponse_httpStatus - The response's http status code.

Response Lenses

getUserResponse_apiAccess :: Lens' GetUserResponse (Maybe ApiAccess) Source #

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

getUserResponse_apiAccessPrincipalArn :: Lens' GetUserResponse (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.

getUserResponse_createTime :: Lens' GetUserResponse (Maybe Integer) Source #

The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.

getUserResponse_emailAddress :: Lens' GetUserResponse (Maybe Text) Source #

The email address that is associated with the user.

getUserResponse_firstName :: Lens' GetUserResponse (Maybe Text) Source #

The first name of the user.

getUserResponse_lastDisabledTime :: Lens' GetUserResponse (Maybe Integer) Source #

Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.

getUserResponse_lastEnabledTime :: Lens' GetUserResponse (Maybe Integer) Source #

Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.

getUserResponse_lastLoginTime :: Lens' GetUserResponse (Maybe Integer) Source #

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

getUserResponse_lastModifiedTime :: Lens' GetUserResponse (Maybe Integer) Source #

Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.

getUserResponse_lastName :: Lens' GetUserResponse (Maybe Text) Source #

The last name of the user.

getUserResponse_status :: Lens' GetUserResponse (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.

getUserResponse_type :: Lens' GetUserResponse (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.

getUserResponse_userId :: Lens' GetUserResponse (Maybe Text) Source #

The unique identifier for the user account that is retrieved.

getUserResponse_httpStatus :: Lens' GetUserResponse Int Source #

The response's http status code.