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.CustomerProfiles.CreateProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a standard profile.

A standard profile represents the following attributes for a customer profile in a domain.

Synopsis

data CreateProfile = CreateProfile' {
- accountNumber :: Maybe Text
- additionalInformation :: Maybe Text
- address :: Maybe Address
- attributes :: Maybe (HashMap Text Text)
- billingAddress :: Maybe Address
- birthDate :: Maybe Text
- businessEmailAddress :: Maybe Text
- businessName :: Maybe Text
- businessPhoneNumber :: Maybe Text
- emailAddress :: Maybe Text
- firstName :: Maybe Text
- gender :: Maybe Gender
- genderString :: Maybe Text
- homePhoneNumber :: Maybe Text
- lastName :: Maybe Text
- mailingAddress :: Maybe Address
- middleName :: Maybe Text
- mobilePhoneNumber :: Maybe Text
- partyType :: Maybe PartyType
- partyTypeString :: Maybe Text
- personalEmailAddress :: Maybe Text
- phoneNumber :: Maybe Text
- shippingAddress :: Maybe Address
- domainName :: Text
}
newCreateProfile :: Text -> CreateProfile
createProfile_accountNumber :: Lens' CreateProfile (Maybe Text)
createProfile_additionalInformation :: Lens' CreateProfile (Maybe Text)
createProfile_address :: Lens' CreateProfile (Maybe Address)
createProfile_attributes :: Lens' CreateProfile (Maybe (HashMap Text Text))
createProfile_billingAddress :: Lens' CreateProfile (Maybe Address)
createProfile_birthDate :: Lens' CreateProfile (Maybe Text)
createProfile_businessEmailAddress :: Lens' CreateProfile (Maybe Text)
createProfile_businessName :: Lens' CreateProfile (Maybe Text)
createProfile_businessPhoneNumber :: Lens' CreateProfile (Maybe Text)
createProfile_emailAddress :: Lens' CreateProfile (Maybe Text)
createProfile_firstName :: Lens' CreateProfile (Maybe Text)
createProfile_gender :: Lens' CreateProfile (Maybe Gender)
createProfile_genderString :: Lens' CreateProfile (Maybe Text)
createProfile_homePhoneNumber :: Lens' CreateProfile (Maybe Text)
createProfile_lastName :: Lens' CreateProfile (Maybe Text)
createProfile_mailingAddress :: Lens' CreateProfile (Maybe Address)
createProfile_middleName :: Lens' CreateProfile (Maybe Text)
createProfile_mobilePhoneNumber :: Lens' CreateProfile (Maybe Text)
createProfile_partyType :: Lens' CreateProfile (Maybe PartyType)
createProfile_partyTypeString :: Lens' CreateProfile (Maybe Text)
createProfile_personalEmailAddress :: Lens' CreateProfile (Maybe Text)
createProfile_phoneNumber :: Lens' CreateProfile (Maybe Text)
createProfile_shippingAddress :: Lens' CreateProfile (Maybe Address)
createProfile_domainName :: Lens' CreateProfile Text
data CreateProfileResponse = CreateProfileResponse' {
- httpStatus :: Int
- profileId :: Text
}
newCreateProfileResponse :: Int -> Text -> CreateProfileResponse
createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int
createProfileResponse_profileId :: Lens' CreateProfileResponse Text

Creating a Request

data CreateProfile Source #

See: newCreateProfile smart constructor.

Constructors

CreateProfile'

Fields

accountNumber :: Maybe Text
A unique account number that you have given to the customer.
additionalInformation :: Maybe Text
Any additional information relevant to the customer’s profile.
address :: Maybe Address
A generic address associated with the customer that is not mailing, shipping, or billing.
attributes :: Maybe (HashMap Text Text)
A key value pair of attributes of a customer profile.
billingAddress :: Maybe Address
The customer’s billing address.
birthDate :: Maybe Text
The customer’s birth date.
businessEmailAddress :: Maybe Text
The customer’s business email address.
businessName :: Maybe Text
The name of the customer’s business.
businessPhoneNumber :: Maybe Text
The customer’s business phone number.
emailAddress :: Maybe Text
The customer’s email address, which has not been specified as a personal or business address.
firstName :: Maybe Text
The customer’s first name.
gender :: Maybe Gender
The gender with which the customer identifies.
genderString :: Maybe Text
An alternative to Gender which accepts any string as input.
homePhoneNumber :: Maybe Text
The customer’s home phone number.
lastName :: Maybe Text
The customer’s last name.
mailingAddress :: Maybe Address
The customer’s mailing address.
middleName :: Maybe Text
The customer’s middle name.
mobilePhoneNumber :: Maybe Text
The customer’s mobile phone number.
partyType :: Maybe PartyType
The type of profile used to describe the customer.
partyTypeString :: Maybe Text
An alternative to PartyType which accepts any string as input.
personalEmailAddress :: Maybe Text
The customer’s personal email address.
phoneNumber :: Maybe Text
The customer’s phone number, which has not been specified as a mobile, home, or business number.
shippingAddress :: Maybe Address
The customer’s shipping address.
domainName :: Text
The unique name of the domain.

Instances

Instances details

ToJSON CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Methods toJSON :: CreateProfile -> Value # toEncoding :: CreateProfile -> Encoding # toJSONList :: [CreateProfile] -> Value # toEncodingList :: [CreateProfile] -> Encoding #
ToHeaders CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Methods toHeaders :: CreateProfile -> [Header] #
ToPath CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Methods toPath :: CreateProfile -> ByteString #
ToQuery CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Methods toQuery :: CreateProfile -> QueryString #
AWSRequest CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Associated Types type AWSResponse CreateProfile # Methods request :: (Service -> Service) -> CreateProfile -> Request CreateProfile # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProfile))) #
Generic CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Associated Types type Rep CreateProfile :: Type -> Type # Methods from :: CreateProfile -> Rep CreateProfile x # to :: Rep CreateProfile x -> CreateProfile #
Read CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Methods readsPrec :: Int -> ReadS CreateProfile # readList :: ReadS [CreateProfile] # readPrec :: ReadPrec CreateProfile # readListPrec :: ReadPrec [CreateProfile] #
Show CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Methods showsPrec :: Int -> CreateProfile -> ShowS # show :: CreateProfile -> String # showList :: [CreateProfile] -> ShowS #
NFData CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Methods rnf :: CreateProfile -> () #
Eq CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Methods (==) :: CreateProfile -> CreateProfile -> Bool # (/=) :: CreateProfile -> CreateProfile -> Bool #
Hashable CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile Methods hashWithSalt :: Int -> CreateProfile -> Int # hash :: CreateProfile -> Int #
type AWSResponse CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile type AWSResponse CreateProfile = CreateProfileResponse
type Rep CreateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateProfile type Rep CreateProfile = D1 ('MetaData "CreateProfile" "Amazonka.CustomerProfiles.CreateProfile" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "CreateProfile'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accountNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "additionalInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Address)))) :: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "billingAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Address)) :: S1 ('MetaSel ('Just "birthDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "businessEmailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "businessName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "businessPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "firstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Gender)))))) :: (((S1 ('MetaSel ('Just "genderString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "homePhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "mailingAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Address)) :: (S1 ('MetaSel ('Just "middleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "mobilePhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "partyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PartyType)) :: (S1 ('MetaSel ('Just "partyTypeString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "personalEmailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "shippingAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Address)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateProfile Source #

Arguments

:: Text	`CreateProfile`
-> CreateProfile

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

CreateProfile, createProfile_accountNumber - A unique account number that you have given to the customer.

CreateProfile, createProfile_additionalInformation - Any additional information relevant to the customer’s profile.

CreateProfile, createProfile_address - A generic address associated with the customer that is not mailing, shipping, or billing.

CreateProfile, createProfile_attributes - A key value pair of attributes of a customer profile.

CreateProfile, createProfile_billingAddress - The customer’s billing address.

CreateProfile, createProfile_birthDate - The customer’s birth date.

CreateProfile, createProfile_businessEmailAddress - The customer’s business email address.

CreateProfile, createProfile_businessName - The name of the customer’s business.

CreateProfile, createProfile_businessPhoneNumber - The customer’s business phone number.

CreateProfile, createProfile_emailAddress - The customer’s email address, which has not been specified as a personal or business address.

CreateProfile, createProfile_firstName - The customer’s first name.

CreateProfile, createProfile_gender - The gender with which the customer identifies.

$sel:genderString:CreateProfile', createProfile_genderString - An alternative to Gender which accepts any string as input.

CreateProfile, createProfile_homePhoneNumber - The customer’s home phone number.

CreateProfile, createProfile_lastName - The customer’s last name.

CreateProfile, createProfile_mailingAddress - The customer’s mailing address.

CreateProfile, createProfile_middleName - The customer’s middle name.

CreateProfile, createProfile_mobilePhoneNumber - The customer’s mobile phone number.

CreateProfile, createProfile_partyType - The type of profile used to describe the customer.

$sel:partyTypeString:CreateProfile', createProfile_partyTypeString - An alternative to PartyType which accepts any string as input.

CreateProfile, createProfile_personalEmailAddress - The customer’s personal email address.

CreateProfile, createProfile_phoneNumber - The customer’s phone number, which has not been specified as a mobile, home, or business number.

CreateProfile, createProfile_shippingAddress - The customer’s shipping address.

CreateProfile, createProfile_domainName - The unique name of the domain.

Request Lenses

createProfile_accountNumber :: Lens' CreateProfile (Maybe Text) Source #

A unique account number that you have given to the customer.

createProfile_additionalInformation :: Lens' CreateProfile (Maybe Text) Source #

Any additional information relevant to the customer’s profile.

createProfile_address :: Lens' CreateProfile (Maybe Address) Source #

A generic address associated with the customer that is not mailing, shipping, or billing.

createProfile_attributes :: Lens' CreateProfile (Maybe (HashMap Text Text)) Source #

A key value pair of attributes of a customer profile.

createProfile_billingAddress :: Lens' CreateProfile (Maybe Address) Source #

The customer’s billing address.

createProfile_birthDate :: Lens' CreateProfile (Maybe Text) Source #

The customer’s birth date.

createProfile_businessEmailAddress :: Lens' CreateProfile (Maybe Text) Source #

The customer’s business email address.

createProfile_businessName :: Lens' CreateProfile (Maybe Text) Source #

The name of the customer’s business.

createProfile_businessPhoneNumber :: Lens' CreateProfile (Maybe Text) Source #

The customer’s business phone number.

createProfile_emailAddress :: Lens' CreateProfile (Maybe Text) Source #

The customer’s email address, which has not been specified as a personal or business address.

createProfile_firstName :: Lens' CreateProfile (Maybe Text) Source #

The customer’s first name.

createProfile_gender :: Lens' CreateProfile (Maybe Gender) Source #

The gender with which the customer identifies.

createProfile_genderString :: Lens' CreateProfile (Maybe Text) Source #

An alternative to Gender which accepts any string as input.

createProfile_homePhoneNumber :: Lens' CreateProfile (Maybe Text) Source #

The customer’s home phone number.

createProfile_lastName :: Lens' CreateProfile (Maybe Text) Source #

The customer’s last name.

createProfile_mailingAddress :: Lens' CreateProfile (Maybe Address) Source #

The customer’s mailing address.

createProfile_middleName :: Lens' CreateProfile (Maybe Text) Source #

The customer’s middle name.

createProfile_mobilePhoneNumber :: Lens' CreateProfile (Maybe Text) Source #

The customer’s mobile phone number.

createProfile_partyType :: Lens' CreateProfile (Maybe PartyType) Source #

The type of profile used to describe the customer.

createProfile_partyTypeString :: Lens' CreateProfile (Maybe Text) Source #

An alternative to PartyType which accepts any string as input.

createProfile_personalEmailAddress :: Lens' CreateProfile (Maybe Text) Source #

The customer’s personal email address.

createProfile_phoneNumber :: Lens' CreateProfile (Maybe Text) Source #

The customer’s phone number, which has not been specified as a mobile, home, or business number.

createProfile_shippingAddress :: Lens' CreateProfile (Maybe Address) Source #

The customer’s shipping address.

createProfile_domainName :: Lens' CreateProfile Text Source #

The unique name of the domain.

Destructuring the Response

data CreateProfileResponse Source #

See: newCreateProfileResponse smart constructor.

Constructors

CreateProfileResponse'
Fields httpStatus :: Int The response's http status code. profileId :: Text The unique identifier of a customer profile.

Instances

Instances details

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

newCreateProfileResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateProfileResponse'`
-> Text	`CreateProfileResponse`
-> CreateProfileResponse

Create a value of CreateProfileResponse 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:CreateProfileResponse', createProfileResponse_httpStatus - The response's http status code.

CreateProfileResponse, createProfileResponse_profileId - The unique identifier of a customer profile.

Response Lenses

createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int Source #

The response's http status code.

createProfileResponse_profileId :: Lens' CreateProfileResponse Text Source #

The unique identifier of a customer profile.