get-rule-set

Описание

Получение атрибутов набора правил.

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

Синтаксис

  get-rule-set
--rule-set-id <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-id (строка)

Идентификатор существующего набора правил для получения.

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

Вывод

CreatedDate -> (временная метка)

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

LastModificationDate -> (временная метка)

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

RuleSetArn -> (строка)

Amazon Resource Name (ARN) ресурса набора правил.

RuleSetId -> (строка)

Идентификатор ресурса набора правил.

RuleSetName -> (строка)

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

Rules -> (список)

Правила, содержащиеся в наборе правил.

(структура)

Правило содержит условия, «условия исключения» и действия. Для каждого получателя электронной почты, если все условия совпадают, и ни одно из «условий исключения» не совпадает, все действия выполняются последовательно. Если условия не заданы, правило всегда применяется, и действия неявно выполняются. Если указаны только «условия исключения», правило применяется, если электронное письмо не соответствует оценке «условий исключения».

Actions -> (список)

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

(структура помеченного объединения)

Действие, которое должно выполнить правило. Может быть установлено только одно из содержащихся действий.

Примечание

Это структура помеченного объединения. Может быть задано только одно из следующих значений верхнего уровня: AddHeader, Archive, DeliverToMailbox, DeliverToQBusiness, Drop, PublishToSns, Relay, ReplaceRecipient, Send, WriteToS3.

AddHeader -> (структура)

Это действие добавляет заголовок. Это можно использовать для добавления произвольных заголовков электронной почты.

HeaderName -> (строка)

Имя заголовка, который нужно добавить к электронному письму. Заголовок должен начинаться с «X-». Заголовки добавляются независимо от того, существовал ли заголовок с таким именем ранее в электронном письме.

HeaderValue -> (строка)

Значение заголовка, которое нужно добавить к электронному письму.

Archive -> (структура)

Это действие архивирует электронное письмо. Это можно использовать для доставки электронного письма в архив.

ActionFailurePolicy -> (строка)

Политика, определяющая, что делать в случае сбоя. Действие завершится ошибкой, если имеются ошибки конфигурации. Например, указанный архив был удален.

TargetArchive -> (строка)

Идентификатор архива, в который нужно отправить электронное письмо.

DeliverToMailbox -> (структура)

Это действие доставляет электронное письмо в почтовый ящик WorkMail.

ActionFailurePolicy -> (строка)

Политика, определяющая, что делать в случае сбоя. Действие завершится ошибкой, если имеются ошибки конфигурации. Например, почтовый ящик ARN больше недоступен.

MailboxArn -> (строка)

Amazon Resource Name (ARN) организации WorkMail, в которую нужно доставить электронное письмо.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которая будет использоваться для выполнения этого действия. Роль должна иметь доступ к API workmail:DeliverToMailbox.

DeliverToQBusiness -> (структура)

Это действие доставляет электронное письмо в приложение Amazon Q Business для включения в его базу знаний.

ActionFailurePolicy -> (строка)

Политика, определяющая, что делать в случае сбоя. Действие завершится ошибкой, если имеются ошибки конфигурации. Например, указанное приложение было удалено или роль не имеет необходимых разрешений для вызова API qbusiness:BatchPutDocument.

ApplicationId -> (строка)

Уникальный идентификатор экземпляра приложения Amazon Q Business, в котором будет доставлено содержимое электронного письма.

IndexId -> (строка)

Идентификатор индекса базы знаний в приложении Amazon Q Business, где содержимое электронного письма будет храниться и индексироваться.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которая будет использоваться при доставке в Amazon Q Business. Эта роль должна иметь доступ к API qbusiness:BatchPutDocument для данного приложения и индекса.

Drop -> (структура)

Это действие прерывает оценку правил в наборе правил.

PublishToSns -> (структура)

Это действие публикует содержимое электронного письма в тему Amazon SNS.

ActionFailurePolicy -> (строка)

Политика, определяющая, что делать в случае сбоя. Действие завершится ошибкой, если имеются ошибки конфигурации. Например, указанная тема SNS была удалена или роль не имеет необходимых разрешений для вызова API sns:Publish.

Encoding -> (строка)

Кодировка, используемая для электронного письма в уведомлении Amazon SNS. Значение по умолчанию — UTF-8. Используйте BASE64, если необходимо сохранить все специальные символы, особенно если исходное сообщение использует другой формат кодировки.

PayloadType -> (строка)

Ожидаемый тип полезной нагрузки в уведомлении Amazon SNS. CONTENT пытается опубликовать все содержимое электронного письма с 20 КБ заголовков. HEADERS извлекает до 100 КБ заголовков для включения в уведомление, содержимое электронного письма не будет включено в уведомление. Значение по умолчанию — CONTENT.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которая будет использоваться при записи в Amazon SNS. Эта роль должна иметь доступ к API sns:Publish для данной темы.

TopicArn -> (строка)

Amazon Resource Name (ARN) темы Amazon SNS, в которую будет опубликовано уведомление о полученном электронном письме.

Relay -> (структура)

Это действие пересылает электронное письмо на другой SMTP-сервер.

ActionFailurePolicy -> (строка)

Политика, определяющая, что делать в случае сбоя. Действие завершится ошибкой, если имеются ошибки конфигурации. Например, указанный ретранслятор был удален.

MailFrom -> (строка)

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

Relay -> (строка)

Идентификатор ресурса ретрансляции, который будет использоваться при пересылке электронного письма.

ReplaceRecipient -> (структура)

Действие заменяет определенных или всех получателей на другой набор получателей.

ReplaceWith -> (список)

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

(строка)

Send -> (структура)

Это действие отправляет электронное письмо по интернету.

ActionFailurePolicy -> (строка)

Политика, определяющая, что делать в случае сбоя. Действие завершится ошибкой, если имеются ошибки конфигурации. Например, у вызывающего лица нет разрешений для вызова API sendRawEmail.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли, которая будет использоваться для этого действия. Эта роль должна иметь доступ к API ses:SendRawEmail.

WriteToS3 -> (структура)

Это действие записывает MIME-содержимое электронного письма в ведро S3.

ActionFailurePolicy -> (строка)

Политика, определяющая, что делать в случае сбоя. Действие завершится ошибкой, если имеются ошибки конфигурации. Например, указанное ведро было удалено.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которая будет использоваться при записи в S3. Эта роль должна иметь доступ к API s3:PutObject, kms:Encrypt и kms:GenerateDataKey для данного ведра.

S3Bucket -> (строка)

Имя ведра S3, в которое нужно записать.

S3Prefix -> (строка)

Префикс S3, используемый для записи в ведро S3.

S3SseKmsKeyId -> (строка)

Идентификатор ключа KMS, который будет использоваться для шифрования сообщения в S3.

Conditions -> (список)

Условия этой правила. Все условия должны соответствовать электронной почте, чтобы действия выполнялись. Пустой список условий означает, что все электронные письма соответствуют, но они по-прежнему подчиняются любым «условиям, за исключением»

(структура помеченного объединения)

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

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: BooleanExpression, DmarcExpression, IpExpression, NumberExpression, StringExpression, VerdictExpression.

BooleanExpression -> (структура)

Условие относится к булевому выражению, переданному в этом поле.

Evaluate -> (структура помеченного объединения)

Операнд, над которым следует выполнить операцию булевого условия.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: Analysis, Attribute, IsInAddressList.

Analysis -> (структура)

ARN расширения и возвращаемое им значение для оценки в булевом условном выражении.

Analyzer -> (строка)

Amazon Resource Name (ARN) расширения.

ResultField -> (строка)

Возвращаемое значение расширения.

Attribute -> (строка)

Тип Boolean, представляющий разрешенные типы атрибутов для электронного письма.

IsInAddressList -> (структура)

Структура, представляющая списки адресов и атрибут списка адресов, который будет использоваться при оценке булевого выражения.

AddressLists -> (список)

Списки адресов, которые будут использоваться для оценки.

(строка)

Attribute -> (строка)

Атрибут электронной почты, который необходимо оценить относительно списка адресов.

Operator -> (строка)

Оператор соответствия для булевого условного выражения.

DmarcExpression -> (структура)

Условие относится к выражению политики DMARC, переданному в этом поле.

Operator -> (строка)

Оператор, применяемый к политике DMARC входящего электронного письма.

Values -> (список)

Значения для использования для данного оператора политики DMARC. Для оператора РАВНО, если задано несколько значений, они оцениваются как ИЛИ. То есть, если какое-либо из заданных значений соответствует, условие считается соответствующим. Для оператора НЕ РАВНО, если задано несколько значений, они оцениваются как И. То есть, только если политика DMARC электронной почты не равна ни одному из заданных значений, то условие считается соответствующим.

(строка)

IpExpression -> (структура)

Условие относится к выражению IP-адреса, переданному в этом поле.

Evaluate -> (структура помеченного объединения)

IP-адрес для оценки в этом условии.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: Attribute.

Attribute -> (строка)

Атрибут электронной почты для оценки.

Operator -> (строка)

Оператор для оценки IP-адреса.

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 -> (строка)

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

Operator -> (строка)

Оператор числового условного выражения.

Value -> (double)

Значение для оценки в числовом условном выражении.

StringExpression -> (структура)

Условие относится к строковому выражению, переданному в этом поле.

Evaluate -> (структура помеченного объединения)

Строка для оценки в строковом условном выражении.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: Analysis, Attribute, MimeHeaderAttribute.

Analysis -> (структура)

ARN расширения и его возвращаемое значение для оценки в строковом условном выражении.

Analyzer -> (строка)

Amazon Resource Name (ARN) расширения.

ResultField -> (строка)

Возвращаемое значение расширения.

Attribute -> (строка)

Атрибут электронной почты для оценки в строковом условном выражении.

MimeHeaderAttribute -> (строка)

Атрибут заголовка MIME электронной почты X для оценки в строковом условном выражении.

Operator -> (строка)

Оператор соответствия для строкового условного выражения.

Values -> (список)

Строка(и) для оценки в строковом условном выражении. Для всех операторов, кроме NOT_EQUALS, если задано несколько значений, значения обрабатываются как ИЛИ. То есть, если какое-либо из значений соответствует строке электронной почты с помощью данного оператора, условие считается соответствующим. Однако для NOT_EQUALS условие считается соответствующим только в том случае, если ни одна из заданных строк не соответствует строке электронной почты.

(строка)

VerdictExpression -> (структура)

Условие относится к выражению вердикта, переданному в этом поле.

Evaluate -> (структура помеченного объединения)

Вердикт для оценки в условном выражении вердикта.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: Analysis, Attribute.

Analysis -> (структура)

ARN расширения и его возвращаемое значение для оценки в условном выражении вердикта.

Analyzer -> (строка)

Amazon Resource Name (ARN) расширения.

ResultField -> (строка)

Возвращаемое значение расширения.

Attribute -> (строка)

Атрибут вердикта электронной почты для оценки в строковом выражении вердикта.

Operator -> (строка)

Оператор соответствия для условного выражения вердикта.

Values -> (список)

Значения для сопоставления с вердиктом электронной почты с использованием данного оператора. Для оператора РАВНО, если задано несколько значений, условие считается соответствующим, если какое-либо из заданных значений соответствует вердикту электронной почты. Для оператора НЕ РАВНО, если задано несколько значений, условие считается соответствующим, если ни один из заданных вердиктов не соответствует вердикту электронной почты.

(строка)

Name -> (строка)

Наименование правила, понятное пользователю.

Unless -> (список)

«Условия, за исключением» данного правила. Ни одно из условий не должно соответствовать электронной почте для выполнения действий. Если какое-либо из этих условий соответствует электронной почте, действия не выполняются.

(структура помеченного объединения)

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

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: BooleanExpression, DmarcExpression, IpExpression, NumberExpression, StringExpression, VerdictExpression.

BooleanExpression -> (структура)

Условие относится к булевому выражению, переданному в этом поле.

Evaluate -> (структура помеченного объединения)

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

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: Analysis, Attribute, IsInAddressList.

Analysis -> (структура)

ARN дочернего модуля и возвращаемое им значение для оценки в булевом условном выражении.

Analyzer -> (строка)

Amazon Resource Name (ARN) дочернего модуля.

ResultField -> (строка)

Возвращаемое значение дочернего модуля.

Attribute -> (строка)

Тип boolean, представляющий разрешенные типы атрибутов для электронной почты.

IsInAddressList -> (структура)

Структура, представляющая списки адресов и атрибут списка адресов, которые будут использоваться при оценке булева выражения.

AddressLists -> (список)

Списки адресов, которые будут использоваться для оценки.

(строка)

Attribute -> (строка)

Атрибут электронной почты, который необходимо оценить по отношению к списку адресов.

Operator -> (строка)

Оператор соответствия для булева условного выражения.

DmarcExpression -> (структура)

Условие относится к выражению политики DMARC, переданному в этом поле.

Operator -> (строка)

Оператор, применяемый к политике DMARC входящей электронной почты.

Values -> (список)

Значения, которые следует использовать для данного оператора политики DMARC. Для оператора РАВНО, если указано несколько значений, они оцениваются как ИЛИ. То есть, если какое-либо из заданных значений соответствует, условие считается соответствующим. Для оператора НЕ РАВНО, если указано несколько значений, они оцениваются как И. То есть, только если политика DMARC электронной почты не равна ни одному из заданных значений, условие считается соответствующим.

(строка)

IpExpression -> (структура)

Условие относится к выражению IP-адреса, переданному в этом поле.

Evaluate -> (структура помеченного объединения)

IP-адрес для оценки в этом условии.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: Attribute.

Attribute -> (строка)

Атрибут электронной почты для оценки.

Operator -> (строка)

Оператор для оценки IP-адреса.

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 -> (строка)

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

Operator -> (строка)

Оператор для числового условного выражения.

Value -> (double)

Значение для оценки в числовом условном выражении.

StringExpression -> (структура)

Условие относится к строковому выражению, переданному в этом поле.

Evaluate -> (структура помеченного объединения)

Строка для оценки в строковом условном выражении.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: Analysis, Attribute, MimeHeaderAttribute.

Analysis -> (структура)

ARN дочернего модуля и возвращаемое им значение для оценки в строковом условном выражении.

Analyzer -> (строка)

Amazon Resource Name (ARN) дочернего модуля.

ResultField -> (строка)

Возвращаемое значение дочернего модуля.

Attribute -> (строка)

Атрибут электронной почты для оценки в строковом условном выражении.

MimeHeaderAttribute -> (строка)

Атрибут MIME X-заголовка электронной почты для оценки в строковом условном выражении.

Operator -> (строка)

Оператор соответствия для строкового условного выражения.

Values -> (список)

Строка(и) для оценки в строковом условном выражении. Для всех операторов, кроме НЕ РАВНО, если указано несколько значений, значения обрабатываются как ИЛИ. То есть, если какое-либо из значений соответствует строке электронной почты с использованием данного оператора, условие считается соответствующим. Однако для НЕ РАВНО условие считается соответствующим только в том случае, если ни одна из заданных строк не соответствует строке электронной почты.

(строка)

VerdictExpression -> (структура)

Условие относится к выражению вердикта, переданному в этом поле.

Evaluate -> (структура помеченного объединения)

Вердикт для оценки в условном выражении вердикта.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: Analysis, Attribute.

Analysis -> (структура)

ARN дочернего модуля и возвращаемое им значение для оценки в условном выражении вердикта.

Analyzer -> (строка)

Amazon Resource Name (ARN) дочернего модуля.

ResultField -> (строка)

Возвращаемое значение дочернего модуля.

Attribute -> (строка)

Атрибут вердикта электронной почты для оценки в строковом выражении вердикта.

Operator -> (строка)

Оператор соответствия для условного выражения вердикта.

Values -> (список)

Значения для сопоставления с вердиктом электронной почты с помощью заданного оператора. Для оператора РАВНО, если указано несколько значений, условие считается соответствующим, если какой-либо из заданных вердиктов соответствует вердикту электронной почты. Для оператора НЕ РАВНО, если указано несколько значений, условие считается соответствующим, если ни один из заданных вердиктов не соответствует вердикту электронной почты.

(строка)

END_OF_DOCUMENT_MARKER