Spec-Zone.ru › AWS CLI v2

[ aws . xray ]

обновить-группу

Описание

Обновляет ресурс группы.

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

Синтаксис

  update-group
[--group-name <value>]
[--group-arn <value>]
[--filter-expression <value>]
[--insights-configuration <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]

Параметры

--group-name (строка)

Имя группы, чувствительное к регистру.

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

ARN, сгенерированный при создании.

--filter-expression (строка)

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

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

Структура, содержащая настройки, связанные с инсайтами.

  • Логическое значение InsightsEnabled можно установить в значение true, чтобы включить инсайты для группы, или в значение false, чтобы отключить инсайты для группы.
  • Логическое значение NotificationsEnabled можно установить в значение true, чтобы включить уведомления об инсайтах для группы. Уведомления можно включить только для группы с InsightsEnabled, установленным в значение true.

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

Установите значение InsightsEnabled в true, чтобы включить инсайты, или в false, чтобы отключить инсайты.

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

Установите значение NotificationsEnabled в true, чтобы включить уведомления об инсайтах. Уведомления можно включить только для группы с InsightsEnabled, установленным в значение true.

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

InsightsEnabled=boolean,NotificationsEnabled=boolean

Синтаксис JSON:

{
  "InsightsEnabled": true|false,
  "NotificationsEnabled": true|false
}

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Обновление группы

В следующем update-group примере обновляются критерии принятия трассировок в группу с именем AdminGroup. Желаемую группу можно указать, используя либо имя группы, либо ARN группы.

aws xray update-group \
    --group-name "AdminGroup" \
    --group-arn "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789" \
    --filter-expression "service(\"mydomain.com\") {fault}"

Вывод:

{
    "GroupName": "AdminGroup",
    "GroupARN": "arn:aws:xray:us-east-2:123456789012:group/AdminGroup/123456789",
    "FilterExpression": "service(\"mydomain.com\") {fault}"
}

Для получения дополнительной информации см. Настройка выборочного отбора, групп и настроек шифрования с помощью API AWS X-Ray в руководстве разработчика AWS X-Ray.

Вывод

Группа -> (структура)

Обновлённая группа. Содержит имя обновлённой группы, ARN обновлённой группы, обновлённое выражение фильтра и обновлённые настройки инсайтов, назначенные группе.

ИмяГруппы -> (строка)

Уникальное имя группы, чувствительное к регистру.

ARNГруппы -> (строка)

Amazon Resource Name (ARN) группы, сгенерированный на основе ИмениГруппы.

ВыражениеФильтра -> (строка)

Выражение фильтра, определяющее параметры для включения трассировок.

НастройкиИнсайтов -> (структура)

Структура, содержащая настройки, связанные с инсайтами.

  • Логическое значение InsightsEnabled можно установить в значение true, чтобы включить инсайты для группы, или в значение false, чтобы отключить инсайты для группы.
  • Логическое значение NotificationsEnabled можно установить в значение true, чтобы включить уведомления об инсайтах через Amazon EventBridge для группы.

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

Установите значение InsightsEnabled в true, чтобы включить инсайты, или в false, чтобы отключить инсайты.

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

Установите значение NotificationsEnabled в true, чтобы включить уведомления об инсайтах. Уведомления можно включить только для группы с InsightsEnabled, установленным в значение true.

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

Spec-Zone.ru

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