describe-receipt-rule

Описание

Возвращает детали указанного правила получения сообщений.

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

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

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

Синтаксис

  describe-receipt-rule
--rule-set-name <value>
--rule-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]

Параметры

--rule-set-name (строка)

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

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

Вывод

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

Структура данных, содержащая имя указанного правила получения сообщений, действия, получателей, домены, состояние включения, состояние сканирования и политику Transport Layer Security (TLS).

Name -> (строка)

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

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

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

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

TlsPolicy -> (строка)

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

Recipients -> (список)

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

(строка)

Actions -> (список)

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

(структура)

Действие, которое 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 SNS.

TopicArn -> (строка)

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

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

OrganizationArn -> (строка)

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

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 .