Spec-Zone.ru › AWS CLI v2

[ aws . rum ]

обновить-монитор-приложения

Описание

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

Вы не можете использовать эту операцию для изменения тегов существующего монитора приложения. Чтобы изменить теги существующего монитора приложения, используйте TagResource .

Чтобы создать новый монитор приложения, используйте CreateAppMonitor .

После обновления монитора приложения войдите в консоль CloudWatch RUM, чтобы получить обновленный фрагмент кода JavaScript для добавления в ваше веб-приложение. Дополнительную информацию см. в разделе Как найти уже сгенерированный фрагмент кода?

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

Синтаксис

  update-app-monitor
[--app-monitor-configuration <value>]
[--custom-events <value>]
[--cw-log-enabled | --no-cw-log-enabled]
[--deobfuscation-configuration <value>]
[--domain <value>]
[--domain-list <value>]
--name <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]

Параметры

--app-monitor-configuration (структура)

Структура, содержащая большую часть данных конфигурации для монитора приложения. Если вы используете Amazon Cognito для авторизации, вы должны включить эту структуру в свой запрос, и она должна содержать идентификатор пула идентификации Amazon Cognito, используемого для авторизации. Если вы не включите AppMonitorConfiguration , вы должны настроить собственный метод авторизации. Дополнительную информацию см. в разделе Авторизуйте ваше приложение для отправки данных в Amazon Web Services .

AllowCookies -> (логическое значение)

Если вы установите это значение на true , веб-клиент RUM устанавливает два cookie: cookie сессии и cookie пользователя. Cookie позволяют веб-клиенту RUM собирать данные, относящиеся к количеству пользователей приложения и поведению приложения в последовательности событий. Cookie хранятся в домене верхнего уровня текущей страницы.

EnableXRay -> (логическое значение)

Если вы установите это значение на true , RUM включает трассировку X-Ray для сеансов пользователей, которые RUM отбирает. RUM добавляет заголовок трассировки X-Ray к разрешенным HTTP-запросам. Он также записывает сегмент X-Ray для разрешенных HTTP-запросов. Вы можете просмотреть трассировки и сегменты этих сеансов пользователей в консоли X-Ray и консоли CloudWatch ServiceLens. Дополнительную информацию см. в разделе Что такое X-Ray?

ExcludedPages -> (список)

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

Вы не можете включить как ExcludedPages , так и IncludedPages в одной операции.

(строка)

FavoritePages -> (список)

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

(строка)

GuestRoleArn -> (строка)

ARN гостевой роли IAM, которая прикреплена к пулу идентификации Amazon Cognito, используемому для авторизации отправки данных в RUM.

Примечание

Возможно, что у монитора приложения нет значения для GuestRoleArn . Например, это может произойти, когда вы используете консоль для создания монитора приложения и разрешаете CloudWatch RUM создать новый пул идентификации для авторизации. В этом случае, GuestRoleArn отсутствует в ответе GetAppMonitor, потому что он не хранится службой.

Если эта проблема вас затрагивает, вы можете выполнить один из следующих шагов:

  • Используйте Cloud Development Kit (CDK) для создания пула идентификации и связанной роли IAM и используйте его для своего монитора приложения.
  • Выполните отдельный вызов GetIdentityPoolRoles к Amazon Cognito, чтобы получить GuestRoleArn .

IdentityPoolId -> (строка)

Идентификатор пула идентификации Amazon Cognito, используемого для авторизации отправки данных в RUM.

IncludedPages -> (список)

Если этот монитор приложения должен собирать данные только с определенных страниц вашего приложения, эта структура перечисляет эти страницы.

Вы не можете включить как ExcludedPages , так и IncludedPages в одной операции.

(строка)

SessionSampleRate -> (двойное значение)

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

Диапазон этого значения от 0 до 1 включительно. Установка этого значения в 1 означает, что отбираются 100% сеансов пользователей, а установка его в 0,1 означает, что отбирается 10% сеансов пользователей.

Если вы опустите этот параметр, будет использовано значение по умолчанию 0,1, и будет отобрано 10% сеансов.

Telemetries -> (список)

Массив, перечисляющий типы телеметрии, которые должен собирать этот монитор приложения.

  • errors указывает, что RUM собирает данные об ошибках JavaScript, необработанных вашим приложением.
  • performance указывает, что RUM собирает данные производительности о том, как ваше приложение и его ресурсы загружаются и отображаются. Это включает в себя Core Web Vitals.
  • http указывает, что RUM собирает данные об HTTP-ошибках, выброшенных вашим приложением.

(строка)

Упрощённый синтаксис:

AllowCookies=boolean,EnableXRay=boolean,ExcludedPages=string,string,FavoritePages=string,string,GuestRoleArn=string,IdentityPoolId=string,IncludedPages=string,string,SessionSampleRate=double,Telemetries=string,string

Синтаксис JSON:

{
  "AllowCookies": true|false,
  "EnableXRay": true|false,
  "ExcludedPages": ["string", ...],
  "FavoritePages": ["string", ...],
  "GuestRoleArn": "string",
  "IdentityPoolId": "string",
  "IncludedPages": ["string", ...],
  "SessionSampleRate": double,
  "Telemetries": ["errors"|"performance"|"http", ...]
}

--custom-events (структура)

Указывает, разрешает ли этот монитор приложения веб-клиенту определять и отправлять пользовательские события. По умолчанию пользовательские события DISABLED .

Дополнительную информацию о пользовательских событиях см. в разделе Отправка пользовательских событий .

Status -> (строка)

Указывает, разрешает ли этот монитор приложения веб-клиенту определять и отправлять пользовательские события. По умолчанию пользовательские события DISABLED .

Упрощённый синтаксис:

Status=string

Синтаксис JSON:

{
  "Status": "ENABLED"|"DISABLED"
}

--cw-log-enabled | --no-cw-log-enabled (логическое значение)

Данные, собранные RUM, хранятся RUM в течение 30 дней, а затем удаляются. Этот параметр указывает, отправляет ли RUM копию этих данных телеметрии в Amazon CloudWatch Logs в вашем аккаунте. Это позволяет хранить данные телеметрии более 30 дней, но влечёт за собой расходы на Amazon CloudWatch Logs.

--deobfuscation-configuration (структура)

Структура, содержащая конфигурацию для того, как монитор приложения может деобфусцировать трассировки стека.

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

Структура, содержащая конфигурацию для того, как монитор приложения может разминировать трассировки стеков ошибок JavaScript с помощью карт исходного кода.

S3Uri -> (строка)

S3Uri ведра или папки, где хранятся файлы карт исходного кода. Требуется, если состояние ENABLED.

Status -> (строка)

Указывает, должны ли трассировки стека ошибок JavaScript быть разминированы для этого монитора приложения. По умолчанию разминирование трассировок стека ошибок JavaScript DISABLED .

Упрощённый синтаксис:

JavaScriptSourceMaps={S3Uri=string,Status=string}

Синтаксис JSON:

{
  "JavaScriptSourceMaps": {
    "S3Uri": "string",
    "Status": "ENABLED"|"DISABLED"
  }
}

--domain (строка)

Домен верхнего уровня в интернете, за который ваше приложение имеет административные полномочия.

--domain-list (список)

Список доменных имён, за которые ваше приложение имеет административные полномочия. UpdateAppMonitor позволяет использовать как домен, так и список доменов.

(строка)

Синтаксис:

"string" "string" ...

--name (строка)

Имя монитора приложения, который нужно обновить.

--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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение по умолчанию по проверке сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

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

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

Нет

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

Spec-Zone.ru

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