Spec-Zone.ru › AWS CLI v2

[ aws . mailmanager ]

get-archive-export

Описание

Получает подробности и текущий статус определенной задачи экспорта архива электронной почты.

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

Синтаксис

  get-archive-export
--export-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]

Параметры

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

Вывод

ArchiveId -> (строка)

Идентификатор архива, из которого был выполнен экспорт электронной почты.

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

Место, куда будут доставлены экспортированные письма.

Примечание

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

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

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

S3Location -> (строка)

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

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 -> (список)

Список строковых значений для проверки атрибута электронной почты.

(строка)

FromTimestamp -> (метка времени)

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

MaxResults -> (целое число)

Максимальное количество писем, включенных в экспорт.

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

Текущий статус задачи экспорта.

CompletionTimestamp -> (метка времени)

Метка времени завершения задачи экспорта (если она завершена).

ErrorMessage -> (строка)

Сообщение об ошибке, если задача экспорта завершилась неудачно.

State -> (строка)

Текущее состояние задачи экспорта.

SubmissionTimestamp -> (метка времени)

Метка времени отправки задачи экспорта.

ToTimestamp -> (метка времени)

Конец диапазона дат, охватываемого экспортированными письмами.

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

Spec-Zone.ru

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