Spec-Zone.ru › AWS CLI v2

[ aws . rum ]

получение-определений-метрики-rum-в-пачке

Описание

Получает список метрик и измерений, которые монитор приложений RUM отправляет в один пункт назначения.

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

batch-get-rum-metric-definitions — это операция с постраничной передачей. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей аргумент --query должен извлекать данные из результатов следующих выражений запроса: MetricDefinitions

Синтаксис

  batch-get-rum-metric-definitions
--app-monitor-name <value>
--destination <value>
[--destination-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--app-monitor-name (строка)

Имя монитора приложений CloudWatch RUM, который отправляет метрики.

--destination (строка)

Тип пункта назначения, для которого вы хотите просмотреть метрики. Допустимые значения: CloudWatch и Evidently.

Возможные значения:

  • CloudWatch
  • Evidently

--destination-arn (строка)

Этот параметр обязателен, если Destination равен Evidently. Если Destination равен CloudWatch, этот параметр не используйте.

Этот параметр указывает ARN эксперимента Evidently, соответствующего пункту назначения.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставляемому --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в формате JSON. Передать произвольные двоичные значения с помощью предоставленного значения JSON невозможно, так как строка будет взята дословно. Этот параметр не может быть указан вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания начальной точки для постраничной передачи. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничная передача в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная передача в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной передачи укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую за пределами AWS CLI.

Примеры использования см. в разделе Постраничная передача в Руководстве пользователя AWS Command Line Interface.

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

Вывод

MetricDefinitions -> (список)

Массив структур, отображающих информацию о метриках, отправленных указанным монитором приложения в указанный пункт назначения.

(структура)

Структура, отображающая определение одной расширенной метрики, которую RUM отправляет в CloudWatch или CloudWatch Evidently. Дополнительную информацию см. в разделе Дополнительные метрики, которые вы можете отправить в CloudWatch и CloudWatch Evidently.

DimensionKeys -> (карта)

Это поле является картой путей к полям и именам измерений. Оно определяет измерения, которые следует связать с этой метрикой в CloudWatch. Значение этого поля используется только в случае, если пункт назначения метрики — CloudWatch. Если пункт назначения метрики — Evidently, значение DimensionKeys игнорируется.

ключ -> (строка)

значение -> (строка)

EventPattern -> (строка)

Шаблон, определяющий метрику. RUM проверяет события, происходящие в сессии пользователя, на соответствие шаблону. События, соответствующие шаблону, отправляются в пункт назначения метрики.

Если пунктом назначения метрики является CloudWatch, и событие также соответствует значению в DimensionKeys, метрика публикуется со значениями указанных измерений.

MetricDefinitionId -> (строка)

Идентификатор этого определения метрики.

Name -> (строка)

Имя метрики, определённой в этой структуре.

Namespace -> (строка)

Если это определение метрики относится к пользовательской метрике, а не расширенной метрике, это поле отображает пространство имен метрики, в которое публикуется пользовательская метрика.

UnitLabel -> (строка)

Используйте это поле только если вы отправляете метрику в CloudWatch. Оно определяет единицу измерения метрики CloudWatch, в которой измеряется эта метрика.

ValueKey -> (строка)

Поле в объекте события, из которого берётся значение метрики.

NextToken -> (строка)

Токен, который можно использовать в последующей операции для получения следующего набора результатов.

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

Spec-Zone.ru

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