update-receipt-rule

Описание

Обновляет правило получения сообщений.

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

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

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

Синтаксис

  update-receipt-rule
--rule-set-name <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 (строка)

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

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

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

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

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

Содержать только латинские буквы (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 и 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. 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.

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

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

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

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

Вывод

Нет