get-export-job

Описание

Предоставляет информацию об задаче экспорта.

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

Синтаксис

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

Параметры

--job-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
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

on
off
auto

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

Вывод

JobId -> (строка)

Идентификатор задачи экспорта.

ExportSourceType -> (строка)

Тип источника задачи экспорта.

JobStatus -> (строка)

Статус задачи экспорта.

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

Назначение задачи экспорта.

DataFormat -> (строка)

Формат данных конечного файла задачи экспорта, может быть одним из следующих:

CSV - Файл значений, разделённых запятыми.
JSON - Файл в формате Json.

S3Url -> (строка)

Предзаписанный URL Amazon S3, указывающий на сгенерированный файл экспорта.

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

Источник данных задачи экспорта.

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

Объект, содержащий подробности о источнике данных для экспорта метрик.

Dimensions -> (карта)

Объект, содержащий сопоставление между MetricDimensionName и MetricDimensionValue для фильтрации метрик. Должен содержать как минимум 1 измерение, но не более 3 уникальных.

key -> (строка)

Имя измерения BatchGetMetricDataQuery. Может быть одним из следующих:

EMAIL_IDENTITY – Идентификатор электронной почты, используемый при отправке сообщений.
CONFIGURATION_SET – Набор конфигураций, используемый при отправке сообщений (если использовался).
ISP – ISP получателя (например, Gmail , Yahoo и т.д.).

value -> (список)

(строка)

Список значений, связанных с MetricDimensionName для фильтрации метрик. Может быть * в качестве универсального значения для всех значений или списком до 10 конкретных значений. Если у одного Dimension есть значение *, другие измерения могут содержать только одно значение.

Namespace -> (строка)

Пространство имен метрик - например, VDM .

Metrics -> (список)

Список объектов ExportMetric для экспорта.

(структура)

Объект, содержащий сопоставление между Metric и MetricAggregation.

Name -> (строка)

Метрика для экспорта, может быть одним из следующих:

SEND - Отправленные электронные письма, подходящие для отслеживания в панели мониторинга VDM. Это исключает письма, отправленные в симулятор почтового ящика и письма, адресованные более чем одному получателю.
COMPLAINT - Полученные жалобы для вашей учетной записи. Это исключает жалобы из симулятора почтового ящика, жалобы, исходящие из вашего списка подавления на уровне учетной записи (если он включен), и жалобы на письма, адресованные более чем одному получателю.
PERMANENT_BOUNCE - Постоянные возвратные сообщения - т.е. обратная связь, полученная за письма, отправленные в несуществующие почтовые ящики. Исключает возвратные сообщения из симулятора почтового ящика, возвратные сообщения, исходящие из вашего списка подавления на уровне учетной записи (если он включен), и возвратные сообщения для писем, адресованных более чем одному получателю.
TRANSIENT_BOUNCE - Временные возвратные сообщения - т.е. обратная связь, полученная за сбои доставки, исключая проблемы с несуществующими почтовыми ящиками. Исключает возвратные сообщения из симулятора почтового ящика и возвратные сообщения для писем, адресованных более чем одному получателю.
OPEN - Уникальные события открытия для писем, включая трекеры открытия. Исключает открытия для писем, адресованных более чем одному получателю.
CLICK - Уникальные события кликов для писем, включая связанные ссылки. Исключает клики для писем, адресованных более чем одному получателю.
DELIVERY - Успешная доставка для попыток отправки электронных писем. Исключает доставку в симулятор почтового ящика и письма, адресованные более чем одному получателю.
DELIVERY_OPEN - Успешная доставка для попыток отправки электронных писем. Исключает доставку в симулятор почтового ящика, письма, адресованные более чем одному получателю и письма без трекеров открытия.
DELIVERY_CLICK - Успешная доставка для попыток отправки электронных писем. Исключает доставку в симулятор почтового ящика, письма, адресованные более чем одному получателю и письма без трекеров кликов.
DELIVERY_COMPLAINT - Успешная доставка для попыток отправки электронных писем. Исключает доставку в симулятор почтового ящика, письма, адресованные более чем одному получателю, и письма, адресованные получателям, размещенным на серверах ISP, с которыми Amazon SES не имеет соглашения о цикле обратной связи.

Aggregation -> (строка)

Применение агрегации к метрике, может быть одним из следующих:

VOLUME - Объем событий для этой метрики.
RATE - Скорость этой метрики по отношению к объему метрики SEND.

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

Представляет начальную дату интервала экспорта в виде метки времени.

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

Представляет конечную дату интервала экспорта в виде метки времени.

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

Объект, содержащий фильтры, примененные при выполнении экспорта информации о сообщениях.

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

Представляет начальную дату интервала экспорта в виде метки времени. Начальная дата включена.

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

Представляет конечную дату интервала экспорта в виде метки времени. Конечная дата включена.

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

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

FromEmailAddress -> (список)

Адрес отправителя сообщения.

(строка)

Destination -> (список)

Адрес электронной почты получателя.

(строка)

Subject -> (список)

Тема сообщения.

(строка)

Isp -> (список)

ISP получателя (например, Gmail , Yahoo и т.д.).

(строка)

LastDeliveryEvent -> (список)

Последнее событие, связанное с доставкой электронного письма, где порядок следующий: SEND < BOUNCE < DELIVERY < COMPLAINT .

(строка)

Тип событий доставки:

SEND - Запрос отправки был успешным, и SES попытается доставить сообщение на сервер почты получателя. (Если используется подавление на уровне учетной записи или глобальное подавление, SES все равно посчитает это отправкой, но доставка будет подавлена.)
DELIVERY - SES успешно доставил электронное письмо на сервер почты получателя. Исключает доставку в симулятор почтового ящика и письма, адресованные более чем одному получателю.
TRANSIENT_BOUNCE - Обратная связь получена за сбои доставки, исключая проблемы с несуществующими почтовыми ящиками. Исключает возвратные сообщения из симулятора почтового ящика и возвратные сообщения для писем, адресованных более чем одному получателю.
PERMANENT_BOUNCE - Обратная связь получена за письма, отправленные в несуществующие почтовые ящики. Исключает возвратные сообщения из симулятора почтового ящика, возвратные сообщения, исходящие из вашего списка подавления на уровне учетной записи (если он включен), и возвратные сообщения для писем, адресованных более чем одному получателю.
UNDETERMINED_BOUNCE - SES не смог определить причину возврата.
COMPLAINT - Получена жалоба на электронное письмо. Это исключает жалобы из симулятора почтового ящика, жалобы, исходящие из вашего списка подавления на уровне учетной записи (если он включен), и жалобы на письма, адресованные более чем одному получателю.

LastEngagementEvent -> (список)

Последнее событие, связанное с вовлечением в электронное письмо, где порядок следующий: OPEN < CLICK .

События вовлечения доступны только при включенном отслеживании вовлечения.

(строка)

Тип событий доставки:

OPEN - Событие открытия для писем, включающих трекеры открытия. Исключает открытия для писем, адресованных более чем одному получателю.
CLICK - Событие клика для писем, включающих связанные ссылки. Исключает клики для писем, адресованных более чем одному получателю.

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

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

FromEmailAddress -> (список)

Адрес отправителя сообщения.

(строка)

Destination -> (список)

Адрес электронной почты получателя.

(строка)

Subject -> (список)

Тема сообщения.

(строка)

Isp -> (список)

ISP получателя (например, Gmail , Yahoo и т.д.).

(строка)

LastDeliveryEvent -> (список)

(строка)

Тип событий доставки:

SEND - Запрос отправки был успешным, и SES попытается доставить сообщение на сервер почты получателя. (Если используется подавление на уровне учетной записи или глобальное подавление, SES все равно посчитает это отправкой, но доставка будет подавлена.)
DELIVERY - SES успешно доставил электронное письмо на сервер почты получателя. Исключает доставку в симулятор почтового ящика и письма, адресованные более чем одному получателю.
TRANSIENT_BOUNCE - Обратная связь получена за сбои доставки, исключая проблемы с несуществующими почтовыми ящиками. Исключает возвратные сообщения из симулятора почтового ящика и возвратные сообщения для писем, адресованных более чем одному получателю.
PERMANENT_BOUNCE - Обратная связь получена за письма, отправленные в несуществующие почтовые ящики. Исключает возвратные сообщения из симулятора почтового ящика, возвратные сообщения, исходящие из вашего списка подавления на уровне учетной записи (если он включен), и возвратные сообщения для писем, адресованных более чем одному получателю.
UNDETERMINED_BOUNCE - SES не смог определить причину возврата.
COMPLAINT - Получена жалоба на электронное письмо. Это исключает жалобы из симулятора почтового ящика, жалобы, исходящие из вашего списка подавления на уровне учетной записи (если он включен), и жалобы на письма, адресованные более чем одному получателю.

LastEngagementEvent -> (список)

Последнее событие, связанное с вовлечением в электронное письмо, где порядок следующий: OPEN < CLICK .

События вовлечения доступны только при включенном отслеживании вовлечения.

(строка)

Тип событий доставки:

OPEN - Событие открытия для писем, включающих трекеры открытия. Исключает открытия для писем, адресованных более чем одному получателю.
CLICK - Событие клика для писем, включающих связанные ссылки. Исключает клики для писем, адресованных более чем одному получателю.

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

Максимальное количество результатов.

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

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

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

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

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

Подробности о сбое задания экспорта.

FailedRecordsS3Url -> (строка)

Предзаписанная URL-адрес Amazon S3, содержащая все необработанные записи и связанную информацию.

ErrorMessage -> (строка)

Сообщение о причине сбоя задания.

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

Статистика задания экспорта.

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

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

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

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

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