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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new user within the specified identity store.

Synopsis

data CreateUser = CreateUser' {
- addresses :: Maybe (NonEmpty Address)
- displayName :: Maybe (Sensitive Text)
- emails :: Maybe (NonEmpty Email)
- locale :: Maybe (Sensitive Text)
- name :: Maybe Name
- nickName :: Maybe (Sensitive Text)
- phoneNumbers :: Maybe (NonEmpty PhoneNumber)
- preferredLanguage :: Maybe (Sensitive Text)
- profileUrl :: Maybe (Sensitive Text)
- timezone :: Maybe (Sensitive Text)
- title :: Maybe (Sensitive Text)
- userName :: Maybe (Sensitive Text)
- userType :: Maybe (Sensitive Text)
- identityStoreId :: Text
}
newCreateUser :: Text -> CreateUser
createUser_addresses :: Lens' CreateUser (Maybe (NonEmpty Address))
createUser_displayName :: Lens' CreateUser (Maybe Text)
createUser_emails :: Lens' CreateUser (Maybe (NonEmpty Email))
createUser_locale :: Lens' CreateUser (Maybe Text)
createUser_name :: Lens' CreateUser (Maybe Name)
createUser_nickName :: Lens' CreateUser (Maybe Text)
createUser_phoneNumbers :: Lens' CreateUser (Maybe (NonEmpty PhoneNumber))
createUser_preferredLanguage :: Lens' CreateUser (Maybe Text)
createUser_profileUrl :: Lens' CreateUser (Maybe Text)
createUser_timezone :: Lens' CreateUser (Maybe Text)
createUser_title :: Lens' CreateUser (Maybe Text)
createUser_userName :: Lens' CreateUser (Maybe Text)
createUser_userType :: Lens' CreateUser (Maybe Text)
createUser_identityStoreId :: Lens' CreateUser Text
data CreateUserResponse = CreateUserResponse' {
- httpStatus :: Int
- userId :: Text
- identityStoreId :: Text
}
newCreateUserResponse :: Int -> Text -> Text -> CreateUserResponse
createUserResponse_httpStatus :: Lens' CreateUserResponse Int
createUserResponse_userId :: Lens' CreateUserResponse Text
createUserResponse_identityStoreId :: Lens' CreateUserResponse Text

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser'

Fields

addresses :: Maybe (NonEmpty Address)
A list of Address objects containing addresses associated with the user.
displayName :: Maybe (Sensitive Text)
A string containing the user's name. This value is typically formatted for display when the user is referenced. For example, "John Doe."
emails :: Maybe (NonEmpty Email)
A list of Email objects containing email addresses associated with the user.
locale :: Maybe (Sensitive Text)
A string containing the user's geographical region or location.
name :: Maybe Name
An object containing the user's name.
nickName :: Maybe (Sensitive Text)
A string containing an alternate name for the user.
phoneNumbers :: Maybe (NonEmpty PhoneNumber)
A list of PhoneNumber objects containing phone numbers associated with the user.
preferredLanguage :: Maybe (Sensitive Text)
A string containing the preferred language of the user. For example, "American English" or "en-us."
profileUrl :: Maybe (Sensitive Text)
A string containing a URL that may be associated with the user.
timezone :: Maybe (Sensitive Text)
A string containing the user's time zone.
title :: Maybe (Sensitive Text)
A string containing the user's title. Possible values are left unspecified given that they depend on each customer's specific needs.
userName :: Maybe (Sensitive Text)
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
userType :: Maybe (Sensitive Text)
A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
identityStoreId :: Text
The globally unique identifier for the identity store.

Instances

Instances details

ToJSON CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods toJSON :: CreateUser -> Value # toEncoding :: CreateUser -> Encoding # toJSONList :: [CreateUser] -> Value # toEncodingList :: [CreateUser] -> Encoding #
ToHeaders CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods toHeaders :: CreateUser -> [Header] #
ToPath CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods toPath :: CreateUser -> ByteString #
ToQuery CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods toQuery :: CreateUser -> QueryString #
AWSRequest CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.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.IdentityStore.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.IdentityStore.CreateUser Methods showsPrec :: Int -> CreateUser -> ShowS # show :: CreateUser -> String # showList :: [CreateUser] -> ShowS #
NFData CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods rnf :: CreateUser -> () #
Eq CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods (==) :: CreateUser -> CreateUser -> Bool # (/=) :: CreateUser -> CreateUser -> Bool #
Hashable CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods hashWithSalt :: Int -> CreateUser -> Int # hash :: CreateUser -> Int #
type AWSResponse CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser type AWSResponse CreateUser = CreateUserResponse
type Rep CreateUser Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.IdentityStore.CreateUser" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Address))) :: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "emails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Email))))) :: ((S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Name))) :: (S1 ('MetaSel ('Just "nickName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "phoneNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty PhoneNumber)))))) :: ((S1 ('MetaSel ('Just "preferredLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "profileUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "userType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateUser Source #

Arguments

:: Text	`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_addresses - A list of Address objects containing addresses associated with the user.

CreateUser, createUser_displayName - A string containing the user's name. This value is typically formatted for display when the user is referenced. For example, "John Doe."

CreateUser, createUser_emails - A list of Email objects containing email addresses associated with the user.

CreateUser, createUser_locale - A string containing the user's geographical region or location.

CreateUser, createUser_name - An object containing the user's name.

CreateUser, createUser_nickName - A string containing an alternate name for the user.

CreateUser, createUser_phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.

CreateUser, createUser_preferredLanguage - A string containing the preferred language of the user. For example, "American English" or "en-us."

CreateUser, createUser_profileUrl - A string containing a URL that may be associated with the user.

CreateUser, createUser_timezone - A string containing the user's time zone.

CreateUser, createUser_title - A string containing the user's title. Possible values are left unspecified given that they depend on each customer's specific needs.

CreateUser, createUser_userName - A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

CreateUser, createUser_userType - A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.

CreateUser, createUser_identityStoreId - The globally unique identifier for the identity store.

Request Lenses

createUser_addresses :: Lens' CreateUser (Maybe (NonEmpty Address)) Source #

A list of Address objects containing addresses associated with the user.

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

A string containing the user's name. This value is typically formatted for display when the user is referenced. For example, "John Doe."

createUser_emails :: Lens' CreateUser (Maybe (NonEmpty Email)) Source #

A list of Email objects containing email addresses associated with the user.

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

A string containing the user's geographical region or location.

createUser_name :: Lens' CreateUser (Maybe Name) Source #

An object containing the user's name.

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

A string containing an alternate name for the user.

createUser_phoneNumbers :: Lens' CreateUser (Maybe (NonEmpty PhoneNumber)) Source #

A list of PhoneNumber objects containing phone numbers associated with the user.

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

A string containing the preferred language of the user. For example, "American English" or "en-us."

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

A string containing a URL that may be associated with the user.

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

A string containing the user's time zone.

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

A string containing the user's title. Possible values are left unspecified given that they depend on each customer's specific needs.

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

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

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

A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.

createUser_identityStoreId :: Lens' CreateUser Text Source #

The globally unique identifier for the identity store.

Destructuring the Response

data CreateUserResponse Source #

See: newCreateUserResponse smart constructor.

Constructors

CreateUserResponse'
Fields httpStatus :: Int The response's http status code. userId :: Text The identifier of the newly created user in the identity store. identityStoreId :: Text The globally unique identifier for the identity store.

Instances

Instances details

Generic CreateUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.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.IdentityStore.CreateUser Methods readsPrec :: Int -> ReadS CreateUserResponse # readList :: ReadS [CreateUserResponse] # readPrec :: ReadPrec CreateUserResponse # readListPrec :: ReadPrec [CreateUserResponse] #
Show CreateUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods showsPrec :: Int -> CreateUserResponse -> ShowS # show :: CreateUserResponse -> String # showList :: [CreateUserResponse] -> ShowS #
NFData CreateUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods rnf :: CreateUserResponse -> () #
Eq CreateUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser Methods (==) :: CreateUserResponse -> CreateUserResponse -> Bool # (/=) :: CreateUserResponse -> CreateUserResponse -> Bool #
type Rep CreateUserResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateUser type Rep CreateUserResponse = D1 ('MetaData "CreateUserResponse" "Amazonka.IdentityStore.CreateUser" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "CreateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateUserResponse'`
-> Text	`CreateUserResponse`
-> Text	`CreateUser`
-> 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:

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

CreateUserResponse, createUserResponse_userId - The identifier of the newly created user in the identity store.

CreateUser, createUserResponse_identityStoreId - The globally unique identifier for the identity store.

Response Lenses

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.

createUserResponse_userId :: Lens' CreateUserResponse Text Source #

The identifier of the newly created user in the identity store.

createUserResponse_identityStoreId :: Lens' CreateUserResponse Text Source #

The globally unique identifier for the identity store.