Spec-Zone.ru › AWS CLI v2

[ aws . cloudtrail ]

обновление-дашборда

Описание

Обновляет указанный дашборд.

Для установки расписания обновления CloudTrail необходимо предоставить разрешения на выполнение операции StartDashboardRefresh для обновления дашборда от вашего имени. Для предоставления разрешений выполните операцию PutResourcePolicy для добавления политики на основе ресурсов к дашборду. Дополнительную информацию см. в примере политики на основе ресурсов для дашборда в Руководстве пользователя CloudTrail.

CloudTrail выполняет запросы для заполнения виджетов дашборда во время ручного или запланированного обновления. CloudTrail необходимо предоставить разрешения на выполнение операции StartQuery от вашего имени. Для предоставления разрешений выполните операцию PutResourcePolicy для добавления политики на основе ресурсов к каждому хранилищу данных событий. Дополнительную информацию см. в примере: Разрешение CloudTrail для выполнения запросов для заполнения дашборда в Руководстве пользователя CloudTrail.

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

Синтаксис

  update-dashboard
--dashboard-id <value>
[--widgets <value>]
[--refresh-schedule <value>]
[--termination-protection-enabled | --no-termination-protection-enabled]
[--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]

Параметры

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

Имя или ARN дашборда.

--widgets (список)

Массив виджетов для дашборда. Пользовательский дашборд может содержать не более 10 виджетов.

Для добавления новых виджетов передайте массив, включающий существующие виджеты вместе с любыми новыми виджетами. Выполните операцию GetDashboard для получения списка виджетов дашборда.

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

(структура)

Содержит информацию о виджете на дашборде CloudTrail Lake.

QueryStatement -> (строка)

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

Примечание

Когда запрос использует ? с eventTime , ? должно быть заключено в одинарные кавычки следующим образом: '?' .

QueryParameters -> (список)

Необязательные параметры запроса. Следующие параметры запроса допустимы: $StartTime$ , $EndTime$ и $Period$ .

(строка)

ViewProperties -> (карта)

Свойства представления для виджета. Дополнительную информацию о свойствах представления см. в разделе Свойства представления для виджетов в Руководстве пользователя CloudTrail.

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

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

Краткая запись:

QueryStatement=string,QueryParameters=string,string,ViewProperties={KeyName1=string,KeyName2=string} ...

Синтаксис JSON:

[
  {
    "QueryStatement": "string",
    "QueryParameters": ["string", ...],
    "ViewProperties": {"string": "string"
      ...}
  }
  ...
]

--refresh-schedule (структура)

Конфигурация расписания обновления для дашборда.

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

Частота обновления дашборда.

Unit -> (строка)

Единица измерения для обновления.

Для пользовательских дашбордов единицей измерения может быть HOURS или DAYS .

Для дашборда «Важные моменты» единица измерения Unit должна быть HOURS .

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

Значение расписания обновления.

Для пользовательских дашбордов следующие значения допустимы, когда единица измерения равна HOURS : 1 , 6 , 12 , 24

Для пользовательских дашбордов единственное допустимое значение, когда единица измерения равна DAYS , это 1 .

Для дашборда «Важные моменты» единица измерения Value должна быть 6 .

Status -> (строка)

Указывает, включено ли расписание обновления. Установите значение ENABLED для включения расписания обновления или DISABLED для отключения расписания обновления.

TimeOfDay -> (строка)

Время суток в формате UTC для выполнения расписания; для ежечасного расписания указывайте минуты; значение по умолчанию — 00:00.

Краткая запись:

Frequency={Unit=string,Value=integer},Status=string,TimeOfDay=string

Синтаксис JSON:

{
  "Frequency": {
    "Unit": "HOURS"|"DAYS",
    "Value": integer
  },
  "Status": "ENABLED"|"DISABLED",
  "TimeOfDay": "string"
}

--termination-protection-enabled | --no-termination-protection-enabled (булево)

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

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

Вывод

DashboardArn -> (строка)

ARN дашборда.

Name -> (строка)

Имя дашборда.

Type -> (строка)

Тип дашборда.

Widgets -> (список)

Массив виджетов для дашборда.

(структура)

Виджет на дашборде CloudTrail Lake.

QueryAlias -> (строка)

Псевдоним запроса для идентификации запроса для виджета.

QueryStatement -> (строка)

SQL-запрос для виджета.

QueryParameters -> (список)

Параметры запроса для виджета.

(строка)

ViewProperties -> (карта)

Свойства представления для виджета. Дополнительную информацию о свойствах представления см. в разделе Свойства представления для виджетов в Руководстве пользователя CloudTrail.

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

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

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

Расписание обновления дашборда, если оно настроено.

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

Частота обновления дашборда.

Unit -> (строка)

Единица измерения для обновления.

Для пользовательских дашбордов единицей измерения может быть HOURS или DAYS.

Для дашборда «Важные моменты» единица измерения Unit должна быть HOURS.

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

Значение расписания обновления.

Для пользовательских дашбордов следующие значения допустимы, когда единица измерения равна HOURS : 1 , 6 , 12 , 24

Для пользовательских дашбордов единственное допустимое значение, когда единица измерения равна DAYS , это 1 .

Для дашборда «Важные моменты» единица измерения Value должна быть 6.

Status -> (строка)

Указывает, включено ли расписание обновления. Установите значение ENABLED для включения расписания обновления или DISABLED для отключения расписания обновления.

TimeOfDay -> (строка)

Время суток в формате UTC для выполнения расписания; для ежечасного расписания указывайте минуты; значение по умолчанию — 00:00.

TerminationProtectionEnabled -> (булево)

Указывает, включена ли защита от завершения для дашборда.

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

Метка времени создания дашборда.

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

Метка времени обновления дашборда.

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

Spec-Zone.ru

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