Spec-Zone.ru › AWS CLI v2

[ aws . amp ]

update-workspace-configuration

Описание

Используйте эту операцию для создания или обновления наборов меток, ограничений наборов меток и периода хранения рабочей области.

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

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

Синтаксис

  update-workspace-configuration
[--client-token <value>]
[--limits-per-label-set <value>]
[--retention-period-in-days <value>]
--workspace-id <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]

Параметры

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

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

--limits-per-label-set (список)

Это массив структур, где каждая структура определяет набор меток для рабочей области и определяет лимит активных временных рядов для каждого из этих наборов меток. Каждое имя метки в наборе меток должно быть уникальным.

(структура)

Эта структура определяет один набор меток, используемый для применения ограничений на активные временные ряды для рабочей области, и определяет лимит для этого набора меток.

Набор меток — это уникальная комбинация пар имя-значение метки. Используйте их для управления ограничениями временных рядов и мониторинга использования определёнными группами меток. Примеры наборов меток могут быть team:finance или env:prod

labelSet -> (карта)

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

Значения меток принимают символы ASCII и должны содержать хотя бы один символ, не являющийся пробелом. Символы управления ASCII не принимаются. Если имя метки является меткой имени метрики __*name* __, то часть метрика имени должна соответствовать следующему шаблону: [a-zA-Z_:][a-zA-Z0-9_:]*

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

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

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

Эта структура содержит информацию об ограничениях, которые применяются к временным рядам, соответствующим этому набору меток.

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

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

Указание 0 приводит к тому, что ограничение набора меток не применяется, но это заставляет Amazon Managed Service for Prometheus передавать метрики набора меток в CloudWatch

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

labelSet={KeyName1=string,KeyName2=string},limits={maxSeries=long} ...

Синтаксис JSON:

[
  {
    "labelSet": {"string": "string"
      ...},
    "limits": {
      "maxSeries": long
    }
  }
  ...
]

--retention-period-in-days (целое число)

Указывает, сколько дней метрики будут храниться в рабочей области.

--workspace-id (строка)

Идентификатор рабочей области, которую вы хотите обновить. Чтобы найти идентификаторы своих рабочих областей, используйте операцию ListWorkspaces.

--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
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

Использовать определённый профиль из файла credentials.

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

Вывод

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

Статус конфигурации рабочей области.

statusCode -> (строка)

Текущий статус конфигурации рабочей области.

statusReason -> (строка)

Причина текущего статуса, если доступна.

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

Spec-Zone.ru

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