Updates a contact’s preferences for a list. It is not necessary to specify all existing topic preferences in the TopicPreferences object, just the ones that need updating.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-contact
--contact-list-name <value>
--email-address <value>
[--topic-preferences <value>]
[--unsubscribe-all | --no-unsubscribe-all]
[--attributes-data <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--contact-list-name
(string)
The name of the contact list.
--email-address
(string)
The contact’s email addres.
--topic-preferences
(list)
The contact’s preference for being opted-in to or opted-out of a topic.
(structure)
The contact’s preference for being opted-in to or opted-out of a topic.
TopicName -> (string)
The name of the topic.
SubscriptionStatus -> (string)
The contact’s subscription status to a topic which is either
OPT_IN
orOPT_OUT
.
Shorthand Syntax:
TopicName=string,SubscriptionStatus=string ...
JSON Syntax:
[
{
"TopicName": "string",
"SubscriptionStatus": "OPT_IN"|"OPT_OUT"
}
...
]
--unsubscribe-all
| --no-unsubscribe-all
(boolean)
A boolean value status noting if the contact is unsubscribed from all contact list topics.
--attributes-data
(string)
The attribute data attached to a contact.
--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.
None