[ aws . mailmanager ]
create-rule-set
Описание
Создать новый набор правил.
См. также: Документацию API AWS
Синтаксис
create-rule-set
[--client-token <value>]
--rule-set-name <value>
--rules <value>
[--tags <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]
Параметры
--client-token (строка)
--rule-set-name (строка)
--rules (список)
Условные правила, которые используются для определения действий по электронной почте.
(структура)
Правило содержит условия, «исключающие условия» и действия. Для каждого получателя электронного письма, если все условия соответствуют, а ни одно из «исключающих условий» не соответствует, то все действия выполняются последовательно. Если условия не указаны, правило всегда применяется, и действия выполняются неявно. Если указаны только «исключающие условия», правило применяется, если электронное письмо не соответствует оценке «исключающих условий».
Действия -> (список)
Список действий, которые необходимо выполнить, когда условия соответствуют входящему электронному письму, а ни одно из «исключающих условий» не соответствует.
(структура помеченного союза)
Действие, которое должно выполнить правило. Может быть установлен только один из указанных элементов.
Примечание
Это структура помеченного союза. Может быть установлен только один из следующих верхних ключей:AddHeader, Archive, DeliverToMailbox, DeliverToQBusiness, Drop, PublishToSns, Relay, ReplaceRecipient, Send, WriteToS3.AddHeader -> (структура)
Это действие добавляет заголовок. Это можно использовать для добавления произвольных заголовков электронной почты.
HeaderName -> (строка)
HeaderValue -> (строка)
Archive -> (структура)
Это действие архивирует электронное письмо. Это можно использовать для отправки электронного письма в архив.
ActionFailurePolicy -> (строка)
TargetArchive -> (строка)
DeliverToMailbox -> (структура)
Это действие доставляет электронное письмо в почтовый ящик WorkMail.
ActionFailurePolicy -> (строка)
MailboxArn -> (строка)
RoleArn -> (строка)
DeliverToQBusiness -> (структура)
Это действие доставляет электронное письмо в приложение Amazon Q Business для добавления в его базу знаний.
ActionFailurePolicy -> (строка)
qbusiness:BatchPutDocument.ApplicationId -> (строка)
IndexId -> (строка)
RoleArn -> (строка)
qbusiness:BatchPutDocument для данного приложения и индекса.Drop -> (структура)
PublishToSns -> (структура)
Это действие публикует содержимое электронного письма в тему Amazon SNS.
ActionFailurePolicy -> (строка)
sns:Publish.Encoding -> (строка)
UTF-8. Используйте BASE64, если необходимо сохранить все специальные символы, особенно если исходное сообщение использует другой формат кодирования.PayloadType -> (строка)
CONTENT пытается опубликовать все содержимое электронного письма с 20 КБ заголовков. HEADERS извлекает до 100 КБ заголовков для включения в уведомление, содержимое электронного письма не будет включено в уведомление. Значение по умолчанию — CONTENT.RoleArn -> (строка)
sns:Publish для данной темы.TopicArn -> (строка)
Relay -> (структура)
Это действие пересылает электронное письмо на другой SMTP-сервер.
ActionFailurePolicy -> (строка)
MailFrom -> (строка)
Relay -> (строка)
ReplaceRecipient -> (структура)
Действие заменяет определенных или всех получателей на другой набор получателей.
ReplaceWith -> (список)
Это действие указывает заменяющие адреса электронной почты получателей для вставки.
(строка)
Send -> (структура)
Это действие отправляет электронное письмо в Интернет.
ActionFailurePolicy -> (строка)
RoleArn -> (строка)
WriteToS3 -> (структура)
Это действие записывает MIME-содержимое электронного письма в ведро S3.
ActionFailurePolicy -> (строка)
RoleArn -> (строка)
S3Bucket -> (строка)
S3Prefix -> (строка)
S3SseKmsKeyId -> (строка)
Conditions -> (список)
Условия этой правила. Все условия должны соответствовать электронной почте для выполнения действий. Пустой список условий означает, что все электронные письма соответствуют, но все равно подчиняются любым «исключающим условиям»
(структура помеченного объединения)
Условное выражение, используемое для оценки электронного письма, чтобы определить, следует ли выполнять действие правила.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен:BooleanExpression, DmarcExpression, IpExpression, NumberExpression, StringExpression, VerdictExpression.BooleanExpression -> (структура)
Условие относится к булеву выражению, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
Операнд, над которым необходимо выполнить операцию булевого условия.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен:Analysis, Attribute, IsInAddressList.Analysis -> (структура)
ARN дополнения и его возвращаемое значение для оценки в булевом выражении условия.
Analyzer -> (строка)
ResultField -> (строка)
Attribute -> (строка)
IsInAddressList -> (структура)
Структура, представляющая списки адресов и атрибут списка адресов, которые будут использоваться для оценки булева выражения.
AddressLists -> (список)
Списки адресов, которые будут использоваться для оценки.
(строка)
Attribute -> (строка)
Operator -> (строка)
DmarcExpression -> (структура)
Условие относится к выражению политики DMARC, переданному в этом поле.
Operator -> (строка)
Values -> (список)
Значения для использования для данного оператора политики DMARC. Для оператора EQUALS, если указано несколько значений, они оцениваются как OR. То есть, если хотя бы одно из указанных значений совпадает, условие считается соответствующим. Для оператора NOT_EQUALS, если указано несколько значений, они оцениваются как AND. То есть, только если политика DMARC электронного письма не равна ни одному из заданных значений, условие считается соответствующим.
(строка)
IpExpression -> (структура)
Условие относится к выражению IP-адреса, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
IP-адрес для оценки в этом условии.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен:Attribute.Attribute -> (строка)
Operator -> (строка)
Values -> (список)
Блоки IP CIDR в формате «x.y.z.w/n» (например, 10.0.0.0/8) для сопоставления с IP-адресом электронного письма. Для оператора CIDR_MATCHES, если указано несколько значений, они оцениваются как OR. То есть, если IP-адрес содержится в любом из заданных диапазонов CIDR, условие считается соответствующим. Для NOT_CIDR_MATCHES, если указаны несколько диапазонов CIDR, условие считается соответствующим, если IP-адрес не содержится ни в одном из заданных диапазонов CIDR.
(строка)
NumberExpression -> (структура)
Условие относится к числовому выражению, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
Число для оценки в числовом выражении условия.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен:Attribute.Attribute -> (строка)
Operator -> (строка)
Value -> (double)
StringExpression -> (структура)
Условие относится к строковому выражению, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
Строка для оценки в строковом выражении условия.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен:Analysis, Attribute, MimeHeaderAttribute.Analysis -> (структура)
ARN дополнения и его возвращаемое значение для оценки в строковом выражении условия.
Analyzer -> (строка)
ResultField -> (строка)
Attribute -> (строка)
MimeHeaderAttribute -> (строка)
Operator -> (строка)
Values -> (список)
Строка(и) для оценки в строковом выражении условия. Для всех операторов, кроме NOT_EQUALS, если указано несколько значений, значения обрабатываются как OR. То есть, если хотя бы одно из значений соответствует строке электронного письма с использованием заданного оператора, условие считается соответствующим. Однако для NOT_EQUALS условие считается соответствующим только в том случае, если ни одна из заданных строк не соответствует строке электронного письма.
(строка)
VerdictExpression -> (структура)
Условие относится к выражению вердикта, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
Вердикт для оценки в выражении условия вердикта.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен:Analysis, Attribute.Analysis -> (структура)
ARN дополнения и его возвращаемое значение для оценки в выражении условия вердикта.
Analyzer -> (строка)
ResultField -> (строка)
Attribute -> (строка)
Operator -> (строка)
Values -> (список)
Значения для сопоставления с вердиктом электронного письма с использованием заданного оператора. Для оператора EQUALS, если указано несколько значений, условие считается соответствующим, если любой из заданных вердиктов совпадает с вердиктом электронного письма. Для оператора NOT_EQUALS, если указано несколько значений, условие считается соответствующим, если ни один из заданных вердиктов не совпадает с вердиктом электронного письма.
(строка)
Name -> (строка)
Unless -> (список)
Условия «если не» для этой правила. Ни одно из условий не должно совпадать с электронным письмом для выполнения действий. Если какое-либо из этих условий совпадает с электронным письмом, действия не выполняются.
(структура помеченного объединения)
Условное выражение, используемое для оценки электронного письма, чтобы определить, следует ли выполнить действие правила.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:BooleanExpression, DmarcExpression, IpExpression, NumberExpression, StringExpression, VerdictExpression.BooleanExpression -> (структура)
Условие применяется к булевому выражению, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
Операнд, над которым выполняется операция булевого условия.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:Analysis, Attribute, IsInAddressList.Analysis -> (структура)
ARN дочернего модуля и его возвращаемое значение для оценки в выражении булевого условия.
Analyzer -> (строка)
ResultField -> (строка)
Attribute -> (строка)
IsInAddressList -> (структура)
Структура, представляющая списки адресов и атрибут списка адресов, которые будут использоваться при оценке булевого выражения.
AddressLists -> (список)
Списки адресов, которые будут использоваться для оценки.
(строка)
Attribute -> (строка)
Operator -> (строка)
DmarcExpression -> (структура)
Условие применяется к выражению политики DMARC, переданному в этом поле.
Operator -> (строка)
Values -> (список)
Значения, которые нужно использовать для данного оператора политики DMARC. Для оператора РАВНО, если указано несколько значений, они оцениваются как ИЛИ. То есть, если какое-либо из заданных значений соответствует, условие считается соответствующим. Для оператора НЕ_РАВНО, если указано несколько значений, они оцениваются как И. То есть, только если политика DMARC электронного письма не равна ни одному из заданных значений, условие считается соответствующим.
(строка)
IpExpression -> (структура)
Условие применяется к выражению IP-адреса, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
IP-адрес для оценки в этом условии.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:Attribute.Attribute -> (строка)
Operator -> (строка)
Values -> (список)
Блоки IP CIDR в формате «x.y.z.w/n» (например, 10.0.0.0/8) для соответствия IP-адресу электронного письма. Для оператора CIDR_MATCHES, если указано несколько значений, они оцениваются как ИЛИ. То есть, если IP-адрес содержится в любом из заданных диапазонов CIDR, условие считается соответствующим. Для NOT_CIDR_MATCHES, если указаны несколько диапазонов CIDR, условие считается соответствующим, если IP-адрес не содержится ни в одном из заданных диапазонов CIDR.
(строка)
NumberExpression -> (структура)
Условие применяется к числовому выражению, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
Число для оценки в числовом выражении условия.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:Attribute.Attribute -> (строка)
Operator -> (строка)
Value -> (double)
StringExpression -> (структура)
Условие применяется к строковому выражению, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
Строка для оценки в строковом выражении условия.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:Analysis, Attribute, MimeHeaderAttribute.Analysis -> (структура)
ARN дочернего модуля и его возвращаемое значение для оценки в строковом выражении условия.
Analyzer -> (строка)
ResultField -> (строка)
Attribute -> (строка)
MimeHeaderAttribute -> (строка)
Operator -> (строка)
Values -> (список)
Строка(и) для оценки в строковом выражении условия. Для всех операторов, кроме НЕ_РАВНО, если указано несколько значений, значения обрабатываются как ИЛИ. То есть, если какое-либо из значений соответствует строке электронного письма с использованием данного оператора, условие считается соответствующим. Однако для НЕ_РАВНО условие считается соответствующим только в том случае, если ни одно из заданных строк не соответствует строке электронного письма.
(строка)
VerdictExpression -> (структура)
Условие применяется к выражению вердикта, переданному в этом поле.
Evaluate -> (структура помеченного объединения)
Вердикт для оценки в выражении условия вердикта.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:Analysis, Attribute.Analysis -> (структура)
ARN дочернего модуля и его возвращаемое значение для оценки в выражении условия вердикта.
Analyzer -> (строка)
ResultField -> (строка)
Attribute -> (строка)
Operator -> (строка)
Values -> (список)
Значения для сопоставления с вердиктом электронного письма с использованием указанного оператора. Для оператора РАВНО, если указано несколько значений, условие считается соответствующим, если какое-либо из заданных вердиктов соответствует вердикту электронного письма. Для оператора НЕ_РАВНО, если указано несколько значений, условие считается соответствующим, если ни один из заданных вердиктов не соответствует вердикту электронного письма.
(строка)
Синтаксис JSON:
[
{
"Actions": [
{
"AddHeader": {
"HeaderName": "string",
"HeaderValue": "string"
},
"Archive": {
"ActionFailurePolicy": "CONTINUE"|"DROP",
"TargetArchive": "string"
},
"DeliverToMailbox": {
"ActionFailurePolicy": "CONTINUE"|"DROP",
"MailboxArn": "string",
"RoleArn": "string"
},
"DeliverToQBusiness": {
"ActionFailurePolicy": "CONTINUE"|"DROP",
"ApplicationId": "string",
"IndexId": "string",
"RoleArn": "string"
},
"Drop": {
},
"PublishToSns": {
"ActionFailurePolicy": "CONTINUE"|"DROP",
"Encoding": "UTF-8"|"BASE64",
"PayloadType": "HEADERS"|"CONTENT",
"RoleArn": "string",
"TopicArn": "string"
},
"Relay": {
"ActionFailurePolicy": "CONTINUE"|"DROP",
"MailFrom": "REPLACE"|"PRESERVE",
"Relay": "string"
},
"ReplaceRecipient": {
"ReplaceWith": ["string", ...]
},
"Send": {
"ActionFailurePolicy": "CONTINUE"|"DROP",
"RoleArn": "string"
},
"WriteToS3": {
"ActionFailurePolicy": "CONTINUE"|"DROP",
"RoleArn": "string",
"S3Bucket": "string",
"S3Prefix": "string",
"S3SseKmsKeyId": "string"
}
}
...
],
"Conditions": [
{
"BooleanExpression": {
"Evaluate": {
"Analysis": {
"Analyzer": "string",
"ResultField": "string"
},
"Attribute": "READ_RECEIPT_REQUESTED"|"TLS"|"TLS_WRAPPED",
"IsInAddressList": {
"AddressLists": ["string", ...],
"Attribute": "RECIPIENT"|"MAIL_FROM"|"SENDER"|"FROM"|"TO"|"CC"
}
},
"Operator": "IS_TRUE"|"IS_FALSE"
},
"DmarcExpression": {
"Operator": "EQUALS"|"NOT_EQUALS",
"Values": ["NONE"|"QUARANTINE"|"REJECT", ...]
},
"IpExpression": {
"Evaluate": {
"Attribute": "SOURCE_IP"
},
"Operator": "CIDR_MATCHES"|"NOT_CIDR_MATCHES",
"Values": ["string", ...]
},
"NumberExpression": {
"Evaluate": {
"Attribute": "MESSAGE_SIZE"
},
"Operator": "EQUALS"|"NOT_EQUALS"|"LESS_THAN"|"GREATER_THAN"|"LESS_THAN_OR_EQUAL"|"GREATER_THAN_OR_EQUAL",
"Value": double
},
"StringExpression": {
"Evaluate": {
"Analysis": {
"Analyzer": "string",
"ResultField": "string"
},
"Attribute": "MAIL_FROM"|"HELO"|"RECIPIENT"|"SENDER"|"FROM"|"SUBJECT"|"TO"|"CC",
"MimeHeaderAttribute": "string"
},
"Operator": "EQUALS"|"NOT_EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS",
"Values": ["string", ...]
},
"VerdictExpression": {
"Evaluate": {
"Analysis": {
"Analyzer": "string",
"ResultField": "string"
},
"Attribute": "SPF"|"DKIM"
},
"Operator": "EQUALS"|"NOT_EQUALS",
"Values": ["PASS"|"FAIL"|"GRAY"|"PROCESSING_FAILED", ...]
}
}
...
],
"Name": "string",
"Unless": [
{
"BooleanExpression": {
"Evaluate": {
"Analysis": {
"Analyzer": "string",
"ResultField": "string"
},
"Attribute": "READ_RECEIPT_REQUESTED"|"TLS"|"TLS_WRAPPED",
"IsInAddressList": {
"AddressLists": ["string", ...],
"Attribute": "RECIPIENT"|"MAIL_FROM"|"SENDER"|"FROM"|"TO"|"CC"
}
},
"Operator": "IS_TRUE"|"IS_FALSE"
},
"DmarcExpression": {
"Operator": "EQUALS"|"NOT_EQUALS",
"Values": ["NONE"|"QUARANTINE"|"REJECT", ...]
},
"IpExpression": {
"Evaluate": {
"Attribute": "SOURCE_IP"
},
"Operator": "CIDR_MATCHES"|"NOT_CIDR_MATCHES",
"Values": ["string", ...]
},
"NumberExpression": {
"Evaluate": {
"Attribute": "MESSAGE_SIZE"
},
"Operator": "EQUALS"|"NOT_EQUALS"|"LESS_THAN"|"GREATER_THAN"|"LESS_THAN_OR_EQUAL"|"GREATER_THAN_OR_EQUAL",
"Value": double
},
"StringExpression": {
"Evaluate": {
"Analysis": {
"Analyzer": "string",
"ResultField": "string"
},
"Attribute": "MAIL_FROM"|"HELO"|"RECIPIENT"|"SENDER"|"FROM"|"SUBJECT"|"TO"|"CC",
"MimeHeaderAttribute": "string"
},
"Operator": "EQUALS"|"NOT_EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS",
"Values": ["string", ...]
},
"VerdictExpression": {
"Evaluate": {
"Analysis": {
"Analyzer": "string",
"ResultField": "string"
},
"Attribute": "SPF"|"DKIM"
},
"Operator": "EQUALS"|"NOT_EQUALS",
"Values": ["PASS"|"FAIL"|"GRAY"|"PROCESSING_FAILED", ...]
}
}
...
]
}
...
]
--tags (список)
Теги, используемые для организации, отслеживания или управления доступом к ресурсу. Например, { “метки”: {“ключ1”:”значение1”, “ключ2”:”значение2”} }.
(структура)
Пара ключ-значение (значение необязательно), которую можно определить и назначить ресурсам Amazon Web Services.
Key -> (строка)
Value -> (строка)
Сокращенный синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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 (boolean)
Включить отладовую регистрацию.
--endpoint-url (string)
Переопределить стандартный URL команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования для вывода команд.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла параметров.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Кредиты не будут загружены, если этот аргумент указан.
--ca-bundle (string)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (string)
Стиль форматирования для двоичных блоков. По умолчанию формат — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от cli-binary-format настройки. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Отключить постраничный вывод cli.
--cli-auto-prompt (boolean)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматический запрос параметров ввода CLI.
Вывод
RuleSetId -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.