Spec-Zone.ru › AWS CLI v2

[ aws . mailmanager ]

start-archive-export

Описание

Инициализирует экспорт писем из указанного архива.

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

Синтаксис

  start-archive-export
--archive-id <value>
--export-destination-configuration <value>
[--filters <value>]
--from-timestamp <value>
[--include-metadata | --no-include-metadata]
[--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 (строка)

Идентификатор архива, из которого необходимо экспортировать письма.

--export-destination-configuration (структура помеченных союзов)

Подробная информация о том, куда доставить экспортированные данные о письмах.

Примечание

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

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

Настройка для доставки в ведро Amazon S3.

S3Location -> (строка)

Расположение в S3 для доставки экспортированных данных о письмах.

Сокращенный синтаксис:

S3={S3Location=string}

Синтаксис JSON:

{
  "S3": {
    "S3Location": "string"
  }
}

--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 (метка времени)

Начало диапазона меток времени, включающего письма.

--include-metadata | --no-include-metadata (булево)

Включать ли метаданные сообщения в формате JSON в экспорт.

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

ExportId -> (строка)

Уникальный идентификатор инициированной задачи экспорта.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API