list-contacts
Описание
Отображает контакты, присутствующие в определённом списке контактов.
См. также: Документацию API AWS
Синтаксис
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]
Параметры
--contact-list-name (строка)
--filter (структура)
Фильтр, который можно применить к списку контактов.
FilteredStatus -> (строка)
OPT_IN или OPT_OUT.TopicFilter -> (структура)
Используется для фильтрации по определённому предпочтению темы.
TopicName -> (строка)
UseDefaultIfPreferenceUnavailable -> (логическое значение)
Сокращённый синтаксис:
FilteredStatus=string,TopicFilter={TopicName=string,UseDefaultIfPreferenceUnavailable=boolean}
Синтаксис JSON:
{
"FilteredStatus": "OPT_IN"|"OPT_OUT",
"TopicFilter": {
"TopicName": "string",
"UseDefaultIfPreferenceUnavailable": true|false
}
}
--page-size (целое число)
NextToken отправляется в ответе. Используйте значение NextToken в последующих запросах для получения дополнительных контактов.--next-token (строка)
ListContacts с теми же параметрами, чтобы получить следующую страницу контактов.--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного через JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или со значением input, выводится пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включает отладочную запись журнала.
--endpoint-url (строка)
Переопределяет URL по умолчанию команды заданным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.
--no-paginate (логическое значение)
Отключает автоматическую постраничную обработку. Если автоматическая постраничная обработка отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определённого профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- вкл
- выкл
- авто
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, который используется для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, который соответствует двоичному блоку, fileb:// всегда будет рассматриваться как двоичный и будет использовать содержимое файла напрямую, независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного формата cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить вывод пейджера CLI.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров CLI.
Вывод
Contacts -> (список)
Контакты, присутствующие в определённом списке контактов.
(структура)
Контакт — это конечный пользователь, получающий электронное письмо.
EmailAddress -> (строка)
TopicPreferences -> (список)
Предпочтения контакта по подписке на тему или отказу от неё.
(структура)
Предпочтения контакта по подписке на тему или отказу от неё.
TopicName -> (строка)
SubscriptionStatus -> (строка)
OPT_IN или OPT_OUT.TopicDefaultPreferences -> (список)
Предпочтения тем по умолчанию, применённые к контакту.
(структура)
Предпочтения контакта по подписке на тему или отказу от неё.
TopicName -> (строка)
SubscriptionStatus -> (строка)
OPT_IN или OPT_OUT.UnsubscribeAll -> (логическое значение)
LastUpdatedTimestamp -> (метка времени)
NextToken -> (строка)
ListContacts с теми же параметрами, чтобы получить следующую страницу контактов.
© Copyright 2025, Amazon Web Services. Created using Sphinx.