[ aws . mailmanager ]
start-archive-search
Описание
Инициализирует поиск по электронной почте в указанном архиве.
См. также: Документация API AWS
Синтаксис
start-archive-search
--archive-id <value>
[--filters <value>]
--from-timestamp <value>
--max-results <value>
--to-timestamp <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]
Параметры
--archive-id (строка)
--filters (структура)
Критерии фильтрации электронных писем для включения в результаты поиска.
Include -> (список)
Условия фильтрации электронных писем для включения.
(структура помеченного объединения)
Условие фильтрации для включения или исключения электронных писем при экспорте или поиске в архиве.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:BooleanExpression, StringExpression.BooleanExpression -> (структура)
Булево выражение для оценки по атрибутам электронных писем.
Evaluate -> (структура помеченного объединения)
Значение атрибута электронной почты для оценки.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:Attribute.Attribute -> (строка)
Operator -> (строка)
StringExpression -> (структура)
Строковое выражение для оценки по атрибутам электронных писем.
Evaluate -> (структура помеченного объединения)
Атрибут электронной почты для оценки.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:Attribute.Attribute -> (строка)
Operator -> (строка)
Values -> (список)
Список строковых значений для оценки атрибута электронной почты.
(строка)
Unless -> (список)
Условия фильтрации электронных писем для исключения.
(структура помеченного объединения)
Условие фильтрации для включения или исключения электронных писем при экспорте или поиске в архиве.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:BooleanExpression, StringExpression.BooleanExpression -> (структура)
Булево выражение для оценки по атрибутам электронных писем.
Evaluate -> (структура помеченного объединения)
Значение атрибута электронной почты для оценки.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:Attribute.Attribute -> (строка)
Operator -> (строка)
StringExpression -> (структура)
Строковое выражение для оценки по атрибутам электронных писем.
Evaluate -> (структура помеченного объединения)
Атрибут электронной почты для оценки.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:Attribute.Attribute -> (строка)
Operator -> (строка)
Values -> (список)
Список строковых значений для оценки атрибута электронной почты.
(строка)
Синтаксис JSON:
{
"Include": [
{
"BooleanExpression": {
"Evaluate": {
"Attribute": "HAS_ATTACHMENTS"
},
"Operator": "IS_TRUE"|"IS_FALSE"
},
"StringExpression": {
"Evaluate": {
"Attribute": "TO"|"FROM"|"CC"|"SUBJECT"|"ENVELOPE_TO"|"ENVELOPE_FROM"
},
"Operator": "CONTAINS",
"Values": ["string", ...]
}
}
...
],
"Unless": [
{
"BooleanExpression": {
"Evaluate": {
"Attribute": "HAS_ATTACHMENTS"
},
"Operator": "IS_TRUE"|"IS_FALSE"
},
"StringExpression": {
"Evaluate": {
"Attribute": "TO"|"FROM"|"CC"|"SUBJECT"|"ENVELOPE_TO"|"ENVELOPE_FROM"
},
"Operator": "CONTAINS",
"Values": ["string", ...]
}
}
...
]
}
--from-timestamp (метка времени)
--max-results (целое число)
--to-timestamp (метка времени)
--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-auto-prompt (логическое значение)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров CLI.
Вывод
SearchId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|