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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the properties of a profile. The ProfileId is required for updating a customer profile.

When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.

Synopsis

data UpdateProfile = UpdateProfile' {
- accountNumber :: Maybe Text
- additionalInformation :: Maybe Text
- address :: Maybe UpdateAddress
- attributes :: Maybe (HashMap Text Text)
- billingAddress :: Maybe UpdateAddress
- 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 UpdateAddress
- middleName :: Maybe Text
- mobilePhoneNumber :: Maybe Text
- partyType :: Maybe PartyType
- partyTypeString :: Maybe Text
- personalEmailAddress :: Maybe Text
- phoneNumber :: Maybe Text
- shippingAddress :: Maybe UpdateAddress
- domainName :: Text
- profileId :: Text
}
newUpdateProfile :: Text -> Text -> UpdateProfile
updateProfile_accountNumber :: Lens' UpdateProfile (Maybe Text)
updateProfile_additionalInformation :: Lens' UpdateProfile (Maybe Text)
updateProfile_address :: Lens' UpdateProfile (Maybe UpdateAddress)
updateProfile_attributes :: Lens' UpdateProfile (Maybe (HashMap Text Text))
updateProfile_billingAddress :: Lens' UpdateProfile (Maybe UpdateAddress)
updateProfile_birthDate :: Lens' UpdateProfile (Maybe Text)
updateProfile_businessEmailAddress :: Lens' UpdateProfile (Maybe Text)
updateProfile_businessName :: Lens' UpdateProfile (Maybe Text)
updateProfile_businessPhoneNumber :: Lens' UpdateProfile (Maybe Text)
updateProfile_emailAddress :: Lens' UpdateProfile (Maybe Text)
updateProfile_firstName :: Lens' UpdateProfile (Maybe Text)
updateProfile_gender :: Lens' UpdateProfile (Maybe Gender)
updateProfile_genderString :: Lens' UpdateProfile (Maybe Text)
updateProfile_homePhoneNumber :: Lens' UpdateProfile (Maybe Text)
updateProfile_lastName :: Lens' UpdateProfile (Maybe Text)
updateProfile_mailingAddress :: Lens' UpdateProfile (Maybe UpdateAddress)
updateProfile_middleName :: Lens' UpdateProfile (Maybe Text)
updateProfile_mobilePhoneNumber :: Lens' UpdateProfile (Maybe Text)
updateProfile_partyType :: Lens' UpdateProfile (Maybe PartyType)
updateProfile_partyTypeString :: Lens' UpdateProfile (Maybe Text)
updateProfile_personalEmailAddress :: Lens' UpdateProfile (Maybe Text)
updateProfile_phoneNumber :: Lens' UpdateProfile (Maybe Text)
updateProfile_shippingAddress :: Lens' UpdateProfile (Maybe UpdateAddress)
updateProfile_domainName :: Lens' UpdateProfile Text
updateProfile_profileId :: Lens' UpdateProfile Text
data UpdateProfileResponse = UpdateProfileResponse' {
- httpStatus :: Int
- profileId :: Text
}
newUpdateProfileResponse :: Int -> Text -> UpdateProfileResponse
updateProfileResponse_httpStatus :: Lens' UpdateProfileResponse Int
updateProfileResponse_profileId :: Lens' UpdateProfileResponse Text

Creating a Request

data UpdateProfile Source #

See: newUpdateProfile smart constructor.

Constructors

UpdateProfile'

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 UpdateAddress
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 UpdateAddress
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 UpdateAddress
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 UpdateAddress
The customer’s shipping address.
domainName :: Text
The unique name of the domain.
profileId :: Text
The unique identifier of a customer profile.

Instances

Instances details

ToJSON UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Methods toJSON :: UpdateProfile -> Value # toEncoding :: UpdateProfile -> Encoding # toJSONList :: [UpdateProfile] -> Value # toEncodingList :: [UpdateProfile] -> Encoding #
ToHeaders UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Methods toHeaders :: UpdateProfile -> [Header] #
ToPath UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Methods toPath :: UpdateProfile -> ByteString #
ToQuery UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Methods toQuery :: UpdateProfile -> QueryString #
AWSRequest UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Associated Types type AWSResponse UpdateProfile # Methods request :: (Service -> Service) -> UpdateProfile -> Request UpdateProfile # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateProfile))) #
Generic UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Associated Types type Rep UpdateProfile :: Type -> Type # Methods from :: UpdateProfile -> Rep UpdateProfile x # to :: Rep UpdateProfile x -> UpdateProfile #
Read UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Methods readsPrec :: Int -> ReadS UpdateProfile # readList :: ReadS [UpdateProfile] # readPrec :: ReadPrec UpdateProfile # readListPrec :: ReadPrec [UpdateProfile] #
Show UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Methods showsPrec :: Int -> UpdateProfile -> ShowS # show :: UpdateProfile -> String # showList :: [UpdateProfile] -> ShowS #
NFData UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Methods rnf :: UpdateProfile -> () #
Eq UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Methods (==) :: UpdateProfile -> UpdateProfile -> Bool # (/=) :: UpdateProfile -> UpdateProfile -> Bool #
Hashable UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile Methods hashWithSalt :: Int -> UpdateProfile -> Int # hash :: UpdateProfile -> Int #
type AWSResponse UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile type AWSResponse UpdateProfile = UpdateProfileResponse
type Rep UpdateProfile Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateProfile type Rep UpdateProfile = D1 ('MetaData "UpdateProfile" "Amazonka.CustomerProfiles.UpdateProfile" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "UpdateProfile'" '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 UpdateAddress)))) :: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "billingAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateAddress)) :: 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 UpdateAddress)) :: (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 UpdateAddress))) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newUpdateProfile Source #

Arguments

:: Text	`UpdateProfile`
-> Text	`UpdateProfile`
-> UpdateProfile

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

UpdateProfile, updateProfile_accountNumber - A unique account number that you have given to the customer.

UpdateProfile, updateProfile_additionalInformation - Any additional information relevant to the customer’s profile.

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

UpdateProfile, updateProfile_attributes - A key value pair of attributes of a customer profile.

UpdateProfile, updateProfile_billingAddress - The customer’s billing address.

UpdateProfile, updateProfile_birthDate - The customer’s birth date.

UpdateProfile, updateProfile_businessEmailAddress - The customer’s business email address.

UpdateProfile, updateProfile_businessName - The name of the customer’s business.

UpdateProfile, updateProfile_businessPhoneNumber - The customer’s business phone number.

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

UpdateProfile, updateProfile_firstName - The customer’s first name.

UpdateProfile, updateProfile_gender - The gender with which the customer identifies.

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

UpdateProfile, updateProfile_homePhoneNumber - The customer’s home phone number.

UpdateProfile, updateProfile_lastName - The customer’s last name.

UpdateProfile, updateProfile_mailingAddress - The customer’s mailing address.

UpdateProfile, updateProfile_middleName - The customer’s middle name.

UpdateProfile, updateProfile_mobilePhoneNumber - The customer’s mobile phone number.

UpdateProfile, updateProfile_partyType - The type of profile used to describe the customer.

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

UpdateProfile, updateProfile_personalEmailAddress - The customer’s personal email address.

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

UpdateProfile, updateProfile_shippingAddress - The customer’s shipping address.

UpdateProfile, updateProfile_domainName - The unique name of the domain.

UpdateProfile, updateProfile_profileId - The unique identifier of a customer profile.

Request Lenses

updateProfile_accountNumber :: Lens' UpdateProfile (Maybe Text) Source #

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

updateProfile_additionalInformation :: Lens' UpdateProfile (Maybe Text) Source #

Any additional information relevant to the customer’s profile.

updateProfile_address :: Lens' UpdateProfile (Maybe UpdateAddress) Source #

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

updateProfile_attributes :: Lens' UpdateProfile (Maybe (HashMap Text Text)) Source #

A key value pair of attributes of a customer profile.

updateProfile_billingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #

The customer’s billing address.

updateProfile_birthDate :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s birth date.

updateProfile_businessEmailAddress :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s business email address.

updateProfile_businessName :: Lens' UpdateProfile (Maybe Text) Source #

The name of the customer’s business.

updateProfile_businessPhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s business phone number.

updateProfile_emailAddress :: Lens' UpdateProfile (Maybe Text) Source #

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

updateProfile_firstName :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s first name.

updateProfile_gender :: Lens' UpdateProfile (Maybe Gender) Source #

The gender with which the customer identifies.

updateProfile_genderString :: Lens' UpdateProfile (Maybe Text) Source #

An alternative to Gender which accepts any string as input.

updateProfile_homePhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s home phone number.

updateProfile_lastName :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s last name.

updateProfile_mailingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #

The customer’s mailing address.

updateProfile_middleName :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s middle name.

updateProfile_mobilePhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s mobile phone number.

updateProfile_partyType :: Lens' UpdateProfile (Maybe PartyType) Source #

The type of profile used to describe the customer.

updateProfile_partyTypeString :: Lens' UpdateProfile (Maybe Text) Source #

An alternative to PartyType which accepts any string as input.

updateProfile_personalEmailAddress :: Lens' UpdateProfile (Maybe Text) Source #

The customer’s personal email address.

updateProfile_phoneNumber :: Lens' UpdateProfile (Maybe Text) Source #

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

updateProfile_shippingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #

The customer’s shipping address.

updateProfile_domainName :: Lens' UpdateProfile Text Source #

The unique name of the domain.

updateProfile_profileId :: Lens' UpdateProfile Text Source #

The unique identifier of a customer profile.

Destructuring the Response

data UpdateProfileResponse Source #

See: newUpdateProfileResponse smart constructor.

Constructors

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

Instances

Instances details

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

newUpdateProfileResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateProfileResponse'`
-> Text	`UpdateProfile`
-> UpdateProfileResponse

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

UpdateProfile, updateProfileResponse_profileId - The unique identifier of a customer profile.

Response Lenses

updateProfileResponse_httpStatus :: Lens' UpdateProfileResponse Int Source #

The response's http status code.

updateProfileResponse_profileId :: Lens' UpdateProfileResponse Text Source #

The unique identifier of a customer profile.