Spec-Zone.ru › AWS CLI v2

[ aws . cloudtrail ]

получить-дашборд

Описание

Возвращает указанный дашборд.

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

Синтаксис

  get-dashboard
--dashboard-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]

Параметры

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

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

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Вывод

DashboardArn -> (строка)

ARN дашборда.

Тип -> (строка)

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

Статус -> (строка)

Статус дашборда.

Виджеты -> (список)

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

(структура)

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

QueryAlias -> (строка)

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

QueryStatement -> (строка)

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

QueryParameters -> (список)

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

(строка)

ViewProperties -> (карта)

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

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

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

Расписание обновления -> (структура)

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

Частота -> (структура)

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

Единица -> (строка)

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

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

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

Значение -> (целое число)

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

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

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

Для дашборда Highlights значение должно быть Value.

Статус -> (строка)

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

Время суток -> (строка)

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

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

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

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

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

LastRefreshId -> (строка)

Идентификатор последнего обновления дашборда.

LastRefreshFailureReason -> (строка)

Предоставляет информацию о сбоях при последнем запланированном обновлении.

TerminationProtectionEnabled -> (булево)

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

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

Spec-Zone.ru

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