Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

batch-get-metric-data

Описание

Получение партий данных метрик, собранных на основе вашей отправленной активности.

Вы можете выполнять эту операцию не более 16 раз в секунду и не более чем с 160 запросами из партий в секунду (кумулятивно).

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

Синтаксис

  batch-get-metric-data
--queries <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]

Параметры

--queries (список)

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

(структура)

Представляет отдельный запрос данных метрики для включения в пакет.

Id -> (строка)

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

Namespace -> (строка)

Пространство имен запроса — например, VDM

Metric -> (строка)

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

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

Dimensions -> (карта)

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

key -> (строка)

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

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

value -> (строка)

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

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

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

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

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

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

Id=string,Namespace=string,Metric=string,Dimensions={KeyName1=string,KeyName2=string},StartDate=timestamp,EndDate=timestamp ...

Синтаксис JSON:

[
  {
    "Id": "string",
    "Namespace": "VDM",
    "Metric": "SEND"|"COMPLAINT"|"PERMANENT_BOUNCE"|"TRANSIENT_BOUNCE"|"OPEN"|"CLICK"|"DELIVERY"|"DELIVERY_OPEN"|"DELIVERY_CLICK"|"DELIVERY_COMPLAINT",
    "Dimensions": {"EMAIL_IDENTITY"|"CONFIGURATION_SET"|"ISP": "string"
      ...},
    "StartDate": timestamp,
    "EndDate": 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.

Вывод

Results -> (список)

Список успешно извлеченных MetricDataResult .

(структура)

Результат одного запроса данных метрики.

Id -> (строка)

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

Timestamps -> (список)

Список меток времени для результатов данных метрики.

(метка времени)

Values -> (список)

Список значений (кумулятивное/сумма) для результатов данных метрики.

(длинное целое число)

Errors -> (список)

Список MetricDataError, возникших при обработке вашего запроса на пакет данных метрики.

(структура)

Ошибка, соответствующая неудачной обработке одного запроса данных метрики.

Id -> (строка)

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

Code -> (строка)

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

  • INTERNAL_FAILURE — Amazon SES не смог обработать один из запросов.
  • ACCESS_DENIED — У вас недостаточно доступа для извлечения метрик на основе заданного запроса.

Message -> (строка)

Сообщение об ошибке, связанное с текущей ошибкой запроса.

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

Spec-Zone.ru

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