describe-receipt-rule-set

Описание

Возвращает детали указанного набора правил приема.

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

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

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

Синтаксис

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

Параметры

--rule-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
текст
таблица
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.

Вывод

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

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

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

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

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

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

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

Rules -> (список)

Список правил приема, принадлежащих указанному набору правил приема.

(структура)

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

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

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

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

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

Содержать только латинские буквы (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 для расшифровки. Этот клиент шифрования в настоящее время доступен только с SDK Amazon Web Services для Java и SDK Amazon Web Services для 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. Amazon WorkMail ARN используют следующий формат:

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.

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

Существует таймаут в 30 секунд для вызовов RequestResponse. В большинстве случаев необходимо использовать вызов 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