Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

create-export-job

Описание

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

Вы можете выполнить эту операцию не более одного раза в секунду.

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

Синопсис

  create-export-job
--export-data-source <value>
--export-destination <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-data-source (структура)

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

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

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

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 < BOUNCE < DELIVERY < COMPLAINT .

(строка)

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

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

LastEngagementEvent -> (список)

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

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

(строка)

Тип событий вовлеченности:

  • OPEN - Событие открытия электронного письма, включая отслеживание открытий. Исключает открытия электронных писем, адресованных более чем одному получателю.
  • CLICK - Событие клика по электронному письму, включая ссылки с обертками. Исключает клики по электронным письмам, адресованным более чем одному получателю.

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

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

Синтаксис JSON:

{
  "MetricsDataSource": {
    "Dimensions": {"EMAIL_IDENTITY"|"CONFIGURATION_SET"|"ISP": ["string", ...]
      ...},
    "Namespace": "VDM",
    "Metrics": [
      {
        "Name": "SEND"|"COMPLAINT"|"PERMANENT_BOUNCE"|"TRANSIENT_BOUNCE"|"OPEN"|"CLICK"|"DELIVERY"|"DELIVERY_OPEN"|"DELIVERY_CLICK"|"DELIVERY_COMPLAINT",
        "Aggregation": "RATE"|"VOLUME"
      }
      ...
    ],
    "StartDate": timestamp,
    "EndDate": timestamp
  },
  "MessageInsightsDataSource": {
    "StartDate": timestamp,
    "EndDate": timestamp,
    "Include": {
      "FromEmailAddress": ["string", ...],
      "Destination": ["string", ...],
      "Subject": ["string", ...],
      "Isp": ["string", ...],
      "LastDeliveryEvent": ["SEND"|"DELIVERY"|"TRANSIENT_BOUNCE"|"PERMANENT_BOUNCE"|"UNDETERMINED_BOUNCE"|"COMPLAINT", ...],
      "LastEngagementEvent": ["OPEN"|"CLICK", ...]
    },
    "Exclude": {
      "FromEmailAddress": ["string", ...],
      "Destination": ["string", ...],
      "Subject": ["string", ...],
      "Isp": ["string", ...],
      "LastDeliveryEvent": ["SEND"|"DELIVERY"|"TRANSIENT_BOUNCE"|"PERMANENT_BOUNCE"|"UNDETERMINED_BOUNCE"|"COMPLAINT", ...],
      "LastEngagementEvent": ["OPEN"|"CLICK", ...]
    },
    "MaxResults": integer
  }
}

--export-destination (структура)

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

DataFormat -> (строка)

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

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

S3Url -> (строка)

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

Краткая запись синтаксиса:

DataFormat=string,S3Url=string

Синтаксис JSON:

{
  "DataFormat": "CSV"|"JSON",
  "S3Url": "string"
}

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

Вывод

JobId -> (строка)

Строка, представляющая идентификатор задания экспорта.

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

Spec-Zone.ru

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