[ aws . sesv2 ]

get-contact

Description

Returns a contact from a contact list.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-contact
--contact-list-name <value>
--email-address <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--contact-list-name (string)

The name of the contact list to which the contact belongs.

--email-address (string)

The contact’s email addres.

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

Output

ContactListName -> (string)

The name of the contact list to which the contact belongs.

EmailAddress -> (string)

The contact’s email addres.

TopicPreferences -> (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 or OPT_OUT .

TopicDefaultPreferences -> (list)

The default topic preferences applied to the contact.

(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 or OPT_OUT .

UnsubscribeAll -> (boolean)

A boolean value status noting if the contact is unsubscribed from all contact list topics.

AttributesData -> (string)

The attribute data attached to a contact.

CreatedTimestamp -> (timestamp)

A timestamp noting when the contact was created.

LastUpdatedTimestamp -> (timestamp)

A timestamp noting the last time the contact’s information was updated.