[ aws . customer-profiles ]
update-profile¶
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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-profile
--domain-name <value>
--profile-id <value>
[--additional-information <value>]
[--account-number <value>]
[--party-type <value>]
[--business-name <value>]
[--first-name <value>]
[--middle-name <value>]
[--last-name <value>]
[--birth-date <value>]
[--gender <value>]
[--phone-number <value>]
[--mobile-phone-number <value>]
[--home-phone-number <value>]
[--business-phone-number <value>]
[--email-address <value>]
[--personal-email-address <value>]
[--business-email-address <value>]
[--address <value>]
[--shipping-address <value>]
[--mailing-address <value>]
[--billing-address <value>]
[--attributes <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--domain-name (string)
The unique name of the domain.
--profile-id (string)
The unique identifier of a customer profile.
--additional-information (string)
Any additional information relevant to the customer’s profile.
--account-number (string)
A unique account number that you have given to the customer.
--party-type (string)
The type of profile used to describe the customer.
Possible values:
INDIVIDUAL
BUSINESS
OTHER
--business-name (string)
The name of the customer’s business.
--first-name (string)
The customer’s first name.
--middle-name (string)
The customer’s middle name.
--last-name (string)
The customer’s last name.
--birth-date (string)
The customer’s birth date.
--gender (string)
The gender with which the customer identifies.
Possible values:
MALE
FEMALE
UNSPECIFIED
--phone-number (string)
The customer’s phone number, which has not been specified as a mobile, home, or business number.
--mobile-phone-number (string)
The customer’s mobile phone number.
--home-phone-number (string)
The customer’s home phone number.
--business-phone-number (string)
The customer’s business phone number.
--email-address (string)
The customer’s email address, which has not been specified as a personal or business address.
--personal-email-address (string)
The customer’s personal email address.
--business-email-address (string)
The customer’s business email address.
--address (structure)
A generic address associated with the customer that is not mailing, shipping, or billing.
Address1 -> (string)
The first line of a customer address.
Address2 -> (string)
The second line of a customer address.
Address3 -> (string)
The third line of a customer address.
Address4 -> (string)
The fourth line of a customer address.
City -> (string)
The city in which a customer lives.
County -> (string)
The county in which a customer lives.
State -> (string)
The state in which a customer lives.
Province -> (string)
The province in which a customer lives.
Country -> (string)
The country in which a customer lives.
PostalCode -> (string)
The postal code of a customer address.
Shorthand Syntax:
Address1=string,Address2=string,Address3=string,Address4=string,City=string,County=string,State=string,Province=string,Country=string,PostalCode=string
JSON Syntax:
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"Address4": "string",
"City": "string",
"County": "string",
"State": "string",
"Province": "string",
"Country": "string",
"PostalCode": "string"
}
--shipping-address (structure)
The customer’s shipping address.
Address1 -> (string)
The first line of a customer address.
Address2 -> (string)
The second line of a customer address.
Address3 -> (string)
The third line of a customer address.
Address4 -> (string)
The fourth line of a customer address.
City -> (string)
The city in which a customer lives.
County -> (string)
The county in which a customer lives.
State -> (string)
The state in which a customer lives.
Province -> (string)
The province in which a customer lives.
Country -> (string)
The country in which a customer lives.
PostalCode -> (string)
The postal code of a customer address.
Shorthand Syntax:
Address1=string,Address2=string,Address3=string,Address4=string,City=string,County=string,State=string,Province=string,Country=string,PostalCode=string
JSON Syntax:
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"Address4": "string",
"City": "string",
"County": "string",
"State": "string",
"Province": "string",
"Country": "string",
"PostalCode": "string"
}
--mailing-address (structure)
The customer’s mailing address.
Address1 -> (string)
The first line of a customer address.
Address2 -> (string)
The second line of a customer address.
Address3 -> (string)
The third line of a customer address.
Address4 -> (string)
The fourth line of a customer address.
City -> (string)
The city in which a customer lives.
County -> (string)
The county in which a customer lives.
State -> (string)
The state in which a customer lives.
Province -> (string)
The province in which a customer lives.
Country -> (string)
The country in which a customer lives.
PostalCode -> (string)
The postal code of a customer address.
Shorthand Syntax:
Address1=string,Address2=string,Address3=string,Address4=string,City=string,County=string,State=string,Province=string,Country=string,PostalCode=string
JSON Syntax:
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"Address4": "string",
"City": "string",
"County": "string",
"State": "string",
"Province": "string",
"Country": "string",
"PostalCode": "string"
}
--billing-address (structure)
The customer’s billing address.
Address1 -> (string)
The first line of a customer address.
Address2 -> (string)
The second line of a customer address.
Address3 -> (string)
The third line of a customer address.
Address4 -> (string)
The fourth line of a customer address.
City -> (string)
The city in which a customer lives.
County -> (string)
The county in which a customer lives.
State -> (string)
The state in which a customer lives.
Province -> (string)
The province in which a customer lives.
Country -> (string)
The country in which a customer lives.
PostalCode -> (string)
The postal code of a customer address.
Shorthand Syntax:
Address1=string,Address2=string,Address3=string,Address4=string,City=string,County=string,State=string,Province=string,Country=string,PostalCode=string
JSON Syntax:
{
"Address1": "string",
"Address2": "string",
"Address3": "string",
"Address4": "string",
"City": "string",
"County": "string",
"State": "string",
"Province": "string",
"Country": "string",
"PostalCode": "string"
}
--attributes (map)
A key value pair of attributes of a customer profile.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.