Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

get-configuration-set

Описание

Получить информацию о существующем наборе конфигураций, включая выделенный пул IP-адресов, связанный с ним, включен ли он для отправки электронных писем и многое другое.

Наборы конфигураций — это группы правил, которые вы можете применять к отправляемым вами электронным письмам. Вы применяете набор конфигураций к электронному письму, включив ссылку на набор конфигураций в заголовки электронного письма. При применении набора конфигураций к электронному письму к этому письму применяются все правила из этого набора конфигураций.

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

Синтаксис

  get-configuration-set
--configuration-set-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]

Параметры

--configuration-set-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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из вашего файла с данными учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

ConfigurationSetName -> (строка)

Название набора конфигурации.

TrackingOptions -> (структура)

Объект, определяющий параметры отслеживания открытий и кликов для электронных писем, отправляемых с помощью набора конфигурации.

CustomRedirectDomain -> (строка)

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

HttpsPolicy -> (строка)

Политика HTTPS для отслеживания событий открытия и кликов.

DeliveryOptions -> (структура)

Объект, определяющий пул выделенных IP-адресов для отправки электронных писем с помощью набора конфигурации.

TlsPolicy -> (строка)

Указывает, требуется ли для сообщений, использующих набор конфигурации, использование Transport Layer Security (TLS). Если значение равно Require, сообщения будут доставлены только при установлении TLS-соединения. Если значение равно Optional, сообщения могут быть доставлены в текстовом формате, если TLS-соединение не может быть установлено.

SendingPoolName -> (строка)

Название пула выделенных IP-адресов, который нужно связать с набором конфигурации.

MaxDeliverySeconds -> (целое число)

Максимальное время в секундах, в течение которого Amazon SES API v2 будет пытаться доставить электронное письмо. Если указано, значение должно быть больше или равно 300 секундам (5 минутам) и меньше или равно 50400 секундам (84 минуты).

ReputationOptions -> (структура)

Объект, определяющий, собирает ли Amazon SES метрики репутации для отправляемых электронных писем, использующих набор конфигурации.

ReputationMetricsEnabled -> (логическое значение)

Если true, отслеживание метрик репутации включено для набора конфигурации. Если false, отслеживание метрик репутации отключено для набора конфигурации.

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

Дата и время (в формате Unix time) последнего сброса метрик репутации. Когда для вашей учетной записи выполняется сброс, метрики репутации рассчитываются начиная с даты сброса.

SendingOptions -> (структура)

Объект, определяющий, может ли Amazon SES отправлять электронные письма, использующие набор конфигурации.

SendingEnabled -> (логическое значение)

Если true, отправка электронной почты включена для набора конфигурации. Если false, отправка электронной почты отключена для набора конфигурации.

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 установит значение в пустую строку.

SuppressionOptions -> (структура)

Объект, содержащий информацию о настройках списка подавления для вашей учетной записи.

SuppressedReasons -> (список)

Список причин, по которым адреса электронной почты автоматически добавляются в список подавления для вашей учетной записи. В этот список могут входить любые или все из следующих:

  • COMPLAINT – Amazon SES добавляет адрес электронной почты в список подавления для вашей учетной записи, когда сообщение, отправленное на этот адрес, приводит к жалобе.
  • BOUNCE – Amazon SES добавляет адрес электронной почты в список подавления для вашей учетной записи, когда сообщение, отправленное на этот адрес, приводит к жесткому отказу.

(строка)

Причина добавления адреса в список подавления для вашей учетной записи. Значение может быть одним из следующих:

  • COMPLAINT – Amazon SES добавил адрес электронной почты в список подавления для вашей учетной записи, потому что сообщение, отправленное на этот адрес, привело к жалобе.
  • BOUNCE – Amazon SES добавил адрес электронной почты в список подавления для вашей учетной записи, потому что сообщение, отправленное на этот адрес, привело к жесткому отказу.

VdmOptions -> (структура)

Объект, содержащий информацию о настройках VDM для вашего набора конфигурации.

DashboardOptions -> (структура)

Указывает дополнительные параметры для вашей конфигурации VDM, применимые к панели мониторинга.

EngagementMetrics -> (строка)

Указывает статус сбора метрик вовлечения в вашем VDM. Может быть одним из следующих:

  • ENABLED – Amazon SES включает метрики вовлечения для набора конфигурации.
  • DISABLED – Amazon SES отключает метрики вовлечения для набора конфигурации.

GuardianOptions -> (структура)

Указывает дополнительные параметры для вашей конфигурации VDM, применимые к Guardian.

OptimizedSharedDelivery -> (строка)

Указывает статус оптимизированной совместной доставки вашего VDM. Может быть одним из следующих:

  • ENABLED – Amazon SES включает оптимизированную совместную доставку для набора конфигурации.
  • DISABLED – Amazon SES отключает оптимизированную совместную доставку для набора конфигурации.

ArchivingOptions -> (структура)

Объект, определяющий архив MailManager, где хранятся отправленные электронные письма, отправленные с помощью набора конфигурации.

ArchiveArn -> (строка)

Amazon Resource Name (ARN) архива MailManager, в котором Amazon SES API v2 будет архивировать отправленные электронные письма.

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

Spec-Zone.ru

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