describe-configuration-set
Описание
Возвращает сведения о заданном наборе конфигурации. Сведения об использовании наборов конфигурации см. в руководстве разработчика Amazon SES .
Вы можете выполнить эту операцию не более одного раза в секунду.
См. также: Документация API AWS
Синтаксис
describe-configuration-set
--configuration-set-name <value>
[--configuration-set-attribute-names <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 (строка)
--configuration-set-attribute-names (список)
Список атрибутов набора конфигурации, которые требуется вернуть.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
eventDestinations
trackingOptions
deliveryOptions
reputationOptions
--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 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.
Вывод
ConfigurationSet -> (структура)
Объект набора конфигураций, связанный с указанным набором конфигураций.
Имя -> (строка)
Имя набора конфигураций. Имя должно соответствовать следующим требованиям:
- Содержать только буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
- Содержать не более 64 символов.
EventDestinations -> (список)
Список пунктов назначения событий, связанных с набором конфигураций.
(структура)
Содержит информацию о пункте назначения события.
Примечание
При создании или обновлении пункта назначения события необходимо указать один и только один пункт назначения. Пункт назначения может быть Amazon CloudWatch, Amazon Kinesis Firehose или Amazon Simple Notification Service (Amazon SNS).Пункты назначения событий связаны с наборами конфигураций, что позволяет публиковать события отправки электронной почты в Amazon CloudWatch, Amazon Kinesis Firehose или Amazon Simple Notification Service (Amazon SNS). Дополнительная информация о использовании наборов конфигураций приведена в руководстве разработчика Amazon SES.
Имя -> (строка)
Имя пункта назначения события. Имя должно соответствовать следующим требованиям:
- Содержать только ASCII-буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
- Содержать не более 64 символов.
Включено -> (булево)
true, чтобы включить публикацию в этот пункт назначения; установите значение в false, чтобы предотвратить публикацию в этот пункт назначения. Значение по умолчанию — false.MatchingEventTypes -> (список)
Тип событий отправки электронной почты, которые необходимо опубликовать в пункт назначения события.
-
send— Вызов был успешным, и Amazon SES пытается доставить электронное письмо. -
reject— Amazon SES определил, что электронное письмо содержит вирус, и отклонил его. -
bounce— Сервер электронной почты получателя постоянно отклонил электронное письмо. Это соответствует твердому отказу. -
complaint— Получатель пометил электронное письмо как спам. -
delivery— Amazon SES успешно доставил электронное письмо на сервер электронной почты получателя. -
open— Получатель получил электронное письмо и открыл его в своем клиенте электронной почты. -
click— Получатель нажал на одну или несколько ссылок в электронном письме. -
renderingFailure— Amazon SES не отправил электронное письмо из-за проблемы с рендерингом шаблона.
(строка)
KinesisFirehoseDestination -> (структура)
Объект, содержащий ARN потока доставки и ARN роли IAM, связанной с пунктом назначения события Amazon Kinesis Firehose.
IAMRoleARN -> (строка)
DeliveryStreamARN -> (строка)
CloudWatchDestination -> (структура)
Объект, содержащий имена, значения по умолчанию и источники измерений, связанные с пунктом назначения события Amazon CloudWatch.
DimensionConfigurations -> (список)
Список измерений, по которым следует категоризировать электронные письма при публикации событий отправки электронных писем в Amazon CloudWatch.
(структура)
Содержит конфигурацию измерения, используемую при публикации событий отправки электронных писем в Amazon CloudWatch.
Дополнительная информация о публикации событий отправки электронных писем в Amazon CloudWatch приведена в руководстве разработчика Amazon SES.
DimensionName -> (строка)
Имя измерения Amazon CloudWatch, связанного с метрикой отправки электронной почты. Имя должно соответствовать следующим требованиям:
- Содержать только ASCII-буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_), дефисы (-), или двоеточия (:).
- Содержать не более 256 символов.
DimensionValueSource -> (строка)
X-SES-MESSAGE-TAGS или параметра API SendEmail/SendRawEmail, укажите messageTag. Для использования собственных заголовков электронной почты укажите emailHeader. Для добавления пользовательского тега к любой ссылке, включенной в электронное письмо, укажите linkTag.DefaultDimensionValue -> (строка)
Значение измерения по умолчанию, которое публикуется в Amazon CloudWatch, если вы не предоставили значение измерения при отправке электронного письма. Значение по умолчанию должно соответствовать следующим требованиям:
- Содержать только ASCII-буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_), дефисы (-), знаки "@" или точки (.).
- Содержать не более 256 символов.
SNSDestination -> (структура)
Объект, содержащий ARN темы, связанной с пунктом назначения события Amazon Simple Notification Service (Amazon SNS).
TopicARN -> (строка)
ARN темы Amazon SNS для событий отправки электронных писем. Вы можете найти ARN темы, используя операцию ListTopics Amazon SNS.
Дополнительная информация о темах Amazon SNS приведена в руководстве разработчика Amazon SNS.
TrackingOptions -> (структура)
Имя настраиваемого домена отслеживания открытия и кликов, связанного с набором конфигураций.
CustomRedirectDomain -> (строка)
DeliveryOptions -> (структура)
Указывает, требуется ли для сообщений, использующих набор конфигураций, использовать Transport Layer Security (TLS).
TlsPolicy -> (строка)
Require, сообщения доставляются только при установлении подключения TLS. Если значение равно Optional, сообщения могут быть доставлены в простом тексте, если подключение TLS установить нельзя.ReputationOptions -> (структура)
Объект, представляющий настройки репутации для набора конфигураций.
SendingEnabled -> (булево)
true, Amazon SES отправляет электронные письма, использующие набор конфигураций. Если значение равно false, Amazon SES не отправляет электронные письма, использующие набор конфигураций. Значение по умолчанию — true. Это значение можно изменить с помощью UpdateConfigurationSetSendingEnabled.ReputationMetricsEnabled -> (булево)
Описывает, публикует ли Amazon SES метрики репутации для набора конфигураций, такие как коэффициенты отказов и жалоб, в Amazon CloudWatch.
Если значение равно true, метрики репутации публикуются. Если значение равно false, метрики репутации не публикуются. Значение по умолчанию — false.
LastFreshStart -> (метка времени)
Дата и время, когда метрики репутации для набора конфигураций были сброшены. Сброс этих метрик известен как новый старт.
При отключении отправки электронных писем для набора конфигураций с помощью UpdateConfigurationSetSendingEnabled и последующем его включении метрики репутации для набора конфигураций (но не для всего аккаунта Amazon SES) сбрасываются.
Если отправка электронных писем для набора конфигураций никогда не отключалась и затем включалась, значение этого атрибута — null.
© Copyright 2025, Amazon Web Services. Created using Sphinx.