создать-правило-получения-писем

Описание

Создает правило получения писем.

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

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

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

Синтаксис

  create-receipt-rule
--rule-set-name <value>
[--after <value>]
--rule <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 (строка)

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

--after (строка)

Имя существующего правила, после которого размещается новое правило. Если этот параметр равен null, новое правило вставляется в начало списка правил.

--rule (структура)

Структура данных, содержащая имя правила, действия, получателей, домены, статус включения, статус сканирования и политику TLS.

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

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

Содержать только буквы 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 для расшифровки. Этот клиент шифрования в настоящее время доступен только с 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 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.

Синтаксис JSON:

{
  "Name": "string",
  "Enabled": true|false,
  "TlsPolicy": "Require"|"Optional",
  "Recipients": ["string", ...],
  "Actions": [
    {
      "S3Action": {
        "TopicArn": "string",
        "BucketName": "string",
        "ObjectKeyPrefix": "string",
        "KmsKeyArn": "string",
        "IamRoleArn": "string"
      },
      "BounceAction": {
        "TopicArn": "string",
        "SmtpReplyCode": "string",
        "StatusCode": "string",
        "Message": "string",
        "Sender": "string"
      },
      "WorkmailAction": {
        "TopicArn": "string",
        "OrganizationArn": "string"
      },
      "LambdaAction": {
        "TopicArn": "string",
        "FunctionArn": "string",
        "InvocationType": "Event"|"RequestResponse"
      },
      "StopAction": {
        "Scope": "RuleSet",
        "TopicArn": "string"
      },
      "AddHeaderAction": {
        "HeaderName": "string",
        "HeaderValue": "string"
      },
      "SNSAction": {
        "TopicArn": "string",
        "Encoding": "UTF-8"|"Base64"
      },
      "ConnectAction": {
        "InstanceARN": "string",
        "IAMRoleARN": "string"
      }
    }
    ...
  ],
  "ScanEnabled": true|false
}

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

Вывод

Нет