Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

get-contact-list

Описание

Возвращает метаданные списка контактов. Он не возвращает никакой информации о контактах, присутствующих в списке.

См. также: Документацию API AWS

Синтаксис

  get-contact-list
--contact-list-name <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 (строка)

Имя списка контактов.

--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
  • text
  • таблица
  • 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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Вывод

ContactListName -> (строка)

Имя списка контактов.

Topics -> (список)

Группа интересов, тема или метка в списке. Список контактов может содержать несколько тем.

(структура)

Группа интересов, тема или метка в списке. В списке могут быть несколько тем.

TopicName -> (строка)

Имя темы.

DisplayName -> (строка)

Имя темы, которое увидит контакт.

Description -> (строка)

Описание темы, которое увидит контакт.

DefaultSubscriptionStatus -> (строка)

Стандартный статус подписки, который будет применен к контакту, если контакт не указал свои предпочтения для подписки на тему.

Description -> (строка)

Описание списка контактов.

CreatedTimestamp -> (метка времени)

Метка времени создания списка контактов.

LastUpdatedTimestamp -> (метка времени)

Метка времени последнего обновления списка контактов.

Tags -> (список)

Метки, связанные со списком контактов.

(структура)

Объект, определяющий метки, связанные с ресурсом. Метка — это метка, которую вы можете по желанию определить и связать с ресурсом. Метки могут помочь вам категоризировать и управлять ресурсами различными способами, например, по назначению, владельцу, среде или другим критериям. Ресурс может иметь до 50 меток.

Каждая метка состоит из обязательного ключа метки и связанного значения метки, которые вы определяете. Ключ метки — это общая метка, которая действует как категория для более конкретного значения метки. Значение метки действует как описание в пределах ключа метки. Ключ метки может содержать до 128 символов. Значение метки может содержать до 256 символов. Символы могут быть буквами, цифрами, пробелами Unicode или одним из следующих символов: _ . : / = + -. К меткам также применяются следующие дополнительные ограничения:

  • Ключи и значения меток регистрозависимы.
  • Для каждого связанного ресурса каждый ключ метки должен быть уникальным и иметь только одно значение.
  • Префикс aws: зарезервирован для использования Amazon Web Services; вы не можете использовать его ни в каких ключах или значениях меток, которые вы определяете. Кроме того, вы не можете редактировать или удалять ключи или значения меток, использующие этот префикс. Метки, использующие этот префикс, не учитываются в лимите в 50 меток на ресурс.
  • Вы можете связывать метки с общедоступными или общими ресурсами, но метки доступны только для вашей учетной записи Amazon Web Services, а не для каких-либо других учетных записей, которые разделяют ресурс. Кроме того, метки доступны только для ресурсов, расположенных в указанном регионе Amazon Web Services для вашей учетной записи Amazon Web Services.

Key -> (строка)

Часть пары «ключ-значение», определяющей метку. Максимальная длина ключа метки — 128 символов. Минимальная длина — 1 символ.

Value -> (строка)

Необязательная часть пары «ключ-значение», определяющей метку. Максимальная длина значения метки — 256 символов. Минимальная длина — 0 символов. Если вы не хотите, чтобы у ресурса было конкретное значение метки, не указывайте значение для этого параметра. Если вы не укажете значение, Amazon SES установит значение в пустую строку.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API