describe-active-receipt-rule-set

Описание

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

Дополнительную информацию о настройке наборов правил приема см. в руководстве разработчика Amazon SES.

Вы можете выполнить эту операцию не более одного раза в секунду.

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

Синтаксис

  describe-active-receipt-rule-set
[--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]

Параметры

--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-auto-prompt (логическое)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматический запрос параметров ввода CLI.

Вывод

Метаданные -> (структура)

Метаданные для текущего активного набора правил приема. Метаданные включают имя набора правил и метку времени создания набора правил.

Имя -> (строка)

Имя набора правил приема. Имя должно соответствовать следующим требованиям:

Содержит только буквы ASCII (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
Начинается и заканчивается буквой или цифрой.
Содержит не более 64 символов.

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

Дата и время создания набора правил приема.

Правила -> (список)

Правила приема, относящиеся к активному набору правил.

(структура)

Правила приема позволяют указать, какие действия должен предпринять Amazon SES при получении почты от одного или нескольких адресов электронной почты или доменов, которые вам принадлежат.

Каждое правило приема определяет набор адресов электронной почты или доменов, к которым оно применяется. Если адреса электронной почты или домены соответствуют хотя бы одному получателю сообщения, Amazon SES выполнит все действия правила приема для сообщения.

Дополнительную информацию о настройке правил приема см. в руководстве разработчика Amazon SES.

Имя -> (строка)

Имя правила приема. Имя должно соответствовать следующим требованиям:

Содержит только буквы ASCII (a-z, A-Z), цифры (0-9), символы подчеркивания (_), дефисы (-) или точки (.).
Начинается и заканчивается буквой или цифрой.
Содержит не более 64 символов.

Включено -> (логическое)

Если true, правило приема активно. Значение по умолчанию - false.

TlsPolicy -> (строка)

Указывает, должно ли требовать Amazon SES, чтобы входящая электронная почта доставлялась по шифрованному соединению с помощью Transport Layer Security (TLS). Если этот параметр установлен в Require, Amazon SES возвращает письма, которые не получены по TLS. По умолчанию — Optional.

Получатели -> (список)

Домены получателей и адреса электронной почты, к которым применяется правило приема. Если этот параметр не указан, это правило соответствует всем получателям во всех проверенных доменах.

(строка)

Действия -> (список)

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

(структура)

Действие, которое Amazon SES может выполнить при получении электронного письма от имени одного или нескольких адресов электронной почты или доменов, которые вам принадлежат. Экземпляр этого типа данных может представлять только одно действие.

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

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

Сохраняет полученное сообщение в ведре Amazon Simple Storage Service (Amazon S3) и, необязательно, публикует уведомление в Amazon SNS.

TopicArn -> (строка)

ARN темы Amazon SNS для уведомления при сохранении сообщения в ведре Amazon S3. ARN темы можно найти с помощью операции ListTopics в Amazon SNS.

Дополнительную информацию о темах Amazon SNS см. в руководстве разработчика Amazon SNS .

BucketName -> (строка)

Имя ведра Amazon S3 для входящей электронной почты.

ObjectKeyPrefix -> (строка)

Префикс ключа ведра Amazon S3. Префикс ключа похож на имя каталога, что позволяет хранить похожие данные в одном каталоге в ведре.

KmsKeyArn -> (строка)

Ключ, управляемый клиентом, который Amazon SES должен использовать для шифрования ваших электронных писем перед сохранением их в ведре Amazon S3. Вы можете использовать управляемый Amazon Web Services ключ или ключ, управляемый клиентом, который вы создали в Amazon Web Services KMS следующим образом:

Чтобы использовать управляемый Amazon Web Services ключ, укажите ARN в формате arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses . Например, если ваш идентификатор учетной записи Amazon Web Services — 123456789012, и вы хотите использовать управляемый Amazon Web Services ключ в регионе США Запад (Орегон), ARN управляемого Amazon Web Services ключа будет arn:aws:kms:us-west-2:123456789012:alias/aws/ses . Если вы используете управляемый Amazon Web Services ключ, вам не нужно выполнять дополнительные действия для предоставления Amazon SES разрешения на использование ключа.
Чтобы использовать управляемый клиентом ключ, который вы создали в Amazon Web Services KMS, укажите ARN управляемого клиентом ключа и убедитесь, что вы добавили в политику ключа утверждение для предоставления Amazon SES разрешения на его использование. Дополнительную информацию о предоставлении разрешений см. в руководстве разработчика Amazon SES .

Дополнительную информацию о политиках ключей см. в руководстве разработчика Amazon Web Services KMS . Если вы не укажете ключ Amazon Web Services KMS, Amazon SES не будет шифровать ваши письма.

Предупреждение

Ваше письмо шифруется Amazon SES с помощью клиента шифрования Amazon S3 перед отправкой письма в Amazon S3 для хранения. Оно не шифруется с помощью шифрования на стороне сервера Amazon S3. Это означает, что вам необходимо использовать клиент шифрования Amazon S3 для расшифровки письма после его извлечения из Amazon S3, так как служба не имеет доступа к использованию ваших ключей Amazon Web Services KMS для расшифровки. Этот клиент шифрования в настоящее время доступен только с помощью Amazon Web Services SDK для Java и Amazon Web Services SDK для Ruby. Дополнительную информацию о шифровании на стороне клиента с использованием управляемых ключей Amazon Web Services KMS см. в руководстве разработчика Amazon S3 .

IamRoleArn -> (строка)

ARN роли IAM, которая будет использоваться Amazon Simple Email Service при записи в ведро Amazon S3, необязательно шифруя ваше письмо с помощью предоставленного управляемого клиентом ключа и публикации в теме Amazon SNS. Эта роль должна иметь доступ к следующим API:

s3:PutObject , kms:Encrypt и kms:GenerateDataKey для указанного ведра Amazon S3.
kms:GenerateDataKey для указанного управляемого клиентом ключа Amazon Web Services KMS.
sns:Publish для указанной темы Amazon SNS.

Примечание

Если указан ARN роли IAM, роль (и только роль) используется для доступа ко всем указанным ресурсам (ведро Amazon S3, управляемый клиентом ключ Amazon Web Services KMS и тема Amazon SNS). Поэтому настройка отдельных разрешений на доступ к ресурсам не требуется.

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

Отклоняет полученное электронное письмо, возвращая ответ о возврате отправителю и, необязательно, публикует уведомление в Amazon Simple Notification Service (Amazon SNS).

TopicArn -> (строка)

Amazon Resource Name (ARN) темы Amazon SNS для уведомления при выполнении действия возврата. ARN темы можно найти с помощью операции ListTopics в Amazon SNS.

Дополнительную информацию о темах Amazon SNS см. в руководстве разработчика Amazon SNS .

SmtpReplyCode -> (строка)

Код ответа SMTP, как определено в RFC 5321 .

StatusCode -> (строка)

Расширенный код состояния SMTP, как определено в RFC 3463 .

Message -> (строка)

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

Sender -> (строка)

Адрес электронной почты отправителя возвращенного письма. Это адрес, с которого отправляется сообщение о возврате.

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

Вызывает Amazon WorkMail и, необязательно, публикует уведомление в Amazon Amazon SNS.

TopicArn -> (строка)

Amazon Resource Name (ARN) темы Amazon SNS для уведомления при вызове действия WorkMail. ARN темы можно найти с помощью операции ListTopics в Amazon SNS.

Дополнительную информацию о темах Amazon SNS см. в руководстве разработчика Amazon SNS .

OrganizationArn -> (строка)

Amazon Resource Name (ARN) организации Amazon WorkMail. ARNs Amazon WorkMail имеют следующий формат:

arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>

Идентификатор вашей организации можно найти с помощью операции ListOrganizations в Amazon WorkMail. Идентификаторы организаций Amazon WorkMail начинаются с «m- », за которым следует строка символов в алфавитно-цифровом формате.

Дополнительную информацию об организациях Amazon WorkMail см. в руководстве администратора Amazon WorkMail .

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

Вызывает функцию Amazon Web Services Lambda и, необязательно, публикует уведомление в Amazon SNS.

TopicArn -> (строка)

Amazon Resource Name (ARN) темы Amazon SNS для уведомления при выполнении действия Lambda. ARN темы можно найти с помощью операции ListTopics в Amazon SNS.

Дополнительную информацию о темах Amazon SNS см. в руководстве разработчика Amazon SNS .

FunctionArn -> (строка)

Amazon Resource Name (ARN) функции Amazon Web Services Lambda. Пример ARN функции Amazon Web Services Lambda: arn:aws:lambda:us-west-2:account-id:function:MyFunction . Дополнительную информацию о функции Amazon Web Services Lambda см. в руководстве разработчика Amazon Web Services Lambda .

InvocationType -> (строка)

Тип вызова функции Amazon Web Services Lambda. Тип вызова RequestResponse означает, что выполнение функции сразу приводит к ответу, а значение Event означает, что функция вызывается асинхронно. Значение по умолчанию — Event . Сведения о типах вызова Amazon Web Services Lambda см. в руководстве разработчика Amazon Web Services Lambda .

Предупреждение

На вызовы RequestResponse установлено ограничение по времени в 30 секунд. В большинстве случаев следует использовать вызов Event . Используйте RequestResponse только для принятия решений о потоке почты, таких как остановка правила получения или набора правил получения.

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

Прерывает оценку набора правил получения и, необязательно, публикует уведомление в Amazon SNS.

Scope -> (строка)

Область действия StopAction. Единственное допустимое значение — RuleSet .

TopicArn -> (строка)

Amazon Resource Name (ARN) темы Amazon SNS для уведомления при выполнении действия остановки. ARN темы можно найти с помощью операции ListTopics Amazon SNS.

Дополнительную информацию о темах Amazon SNS см. в руководстве разработчика Amazon SNS .

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

Добавляет заголовок к полученному электронному письму.

HeaderName -> (строка)

Имя заголовка, добавляемого к входящему сообщению. Имя должно содержать не менее одного символа и не более 50 символов. Оно состоит из буквенно-цифровых символов (a–z, A–Z, 0–9) и дефисов.

HeaderValue -> (строка)

Содержимое, включаемое в заголовок. Это значение может содержать до 2048 символов. Оно не может содержать символы новой строки (\n ) или возврата каретки (\r ).

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

Опубликует содержимое электронного письма в уведомление Amazon SNS.

TopicArn -> (строка)

Amazon Resource Name (ARN) темы Amazon SNS для уведомления. ARN темы можно найти с помощью операции ListTopics в Amazon SNS.

Дополнительную информацию о темах Amazon SNS см. в руководстве разработчика Amazon SNS .

Encoding -> (строка)

Кодировка, используемая для электронного письма в уведомлении Amazon SNS. UTF-8 проще в использовании, но может не сохранить все специальные символы, когда сообщение было закодировано с использованием другого формата кодировки. Base64 сохраняет все специальные символы. Значение по умолчанию — UTF-8.

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

Анализирует полученное сообщение и начинает контакт по электронной почте в Amazon Connect от вашего имени.

InstanceARN -> (строка)

Amazon Resource Name (ARN) для экземпляра Amazon Connect, с которым Amazon SES интегрирован для начала контактов по электронной почте.

Дополнительную информацию об экземплярах Amazon Connect см. в руководстве администратора Amazon Connect

IAMRoleARN -> (строка)

Amazon Resource Name (ARN) роли IAM, которая будет использоваться Amazon Simple Email Service при начале контактов по электронной почте с экземпляром Amazon Connect. Эта роль должна иметь разрешение на вызов connect:StartEmailContact для указанного экземпляра Amazon Connect.

ScanEnabled -> (булево)

Если true , то сообщения, к которым применяется это правило получения, проверяются на спам и вирусы. Значение по умолчанию — false .

END_OF_DOCUMENT_MARKER