[ aws . sesv2 ]

list-contacts

Description

Lists the contacts present in a specific contact list.

See also: AWS API Documentation

Synopsis

  list-contacts
--contact-list-name <value>
[--filter <value>]
[--page-size <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--contact-list-name (string)

The name of the contact list.

--filter (structure)

A filter that can be applied to a list of contacts.

FilteredStatus -> (string)

The status by which you are filtering: OPT_IN or OPT_OUT .

TopicFilter -> (structure)

Used for filtering by a specific topic preference.

TopicName -> (string)

The name of a topic on which you wish to apply the filter.

UseDefaultIfPreferenceUnavailable -> (boolean)

Notes that the default subscription status should be applied to a contact because the contact has not noted their preference for subscribing to a topic.

Shorthand Syntax:

FilteredStatus=string,TopicFilter={TopicName=string,UseDefaultIfPreferenceUnavailable=boolean}

JSON Syntax:

{
  "FilteredStatus": "OPT_IN"|"OPT_OUT",
  "TopicFilter": {
    "TopicName": "string",
    "UseDefaultIfPreferenceUnavailable": true|false
  }
}

--page-size (integer)

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

--next-token (string)

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Contacts -> (list)

The contacts present in a specific contact list.

(structure)

A contact is the end-user who is receiving the email.

EmailAddress -> (string)

The contact’s email address.

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.

LastUpdatedTimestamp -> (timestamp)

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

NextToken -> (string)

A string token indicating that there might be additional contacts available to be listed. Copy this token to a subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.