Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

describe-dashboard

Описание

Предоставляет сводку по дашборду.

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

Синтаксис

  describe-dashboard
--aws-account-id <value>
--dashboard-id <value>
[--version-number <value>]
[--alias-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]

Параметры

--aws-account-id (строка)

Идентификатор учетной записи Amazon Web Services, содержащей дашборд, который вы описываете.

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

Идентификатор дашборда.

--version-number (целое число)

Номер версии дашборда. Если номер версии не указан, описывается последняя опубликованная версия дашборда.

--alias-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 (логическое значение)

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

--endpoint-url (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

Дэшборд -> (структура)

Информация о дэшборде.

DashboardId -> (строка)

Идентификатор дэшборда.

Arn -> (строка)

Amazon Resource Name (ARN) ресурса.

Name -> (строка)

Имя для отображения дэшборда.

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

Версия.

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

Время создания этой версии дэшборда.

Errors -> (список)

Ошибки, связанные с этой версией дэшборда.

(структура)

Ошибка дэшборда.

Type -> (строка)

Тип.

Message -> (строка)

Сообщение.

ViolatedEntities -> (список)

Список нарушенных сущностей, которые вызвали ошибку дэшборда.

(структура)

Объект, структура или подструктура анализа, шаблона или дэшборда.

Path -> (строка)

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

VersionNumber -> (целое)

Номер версии для этой версии дэшборда.

Status -> (строка)

HTTP-статус запроса.

Arn -> (строка)

Amazon Resource Name (ARN) ресурса.

SourceEntityArn -> (строка)

ARN источника сущности.

DataSetArns -> (список)

Amazon Resource Numbers (ARN) наборов данных, связанных с этой версией дэшборда.

(строка)

Description -> (строка)

Описание.

ThemeArn -> (строка)

ARN темы, связанной с версией дэшборда.

Sheets -> (список)

Список связанных листов с уникальным идентификатором и именем каждого листа.

(структура)

Лист, представляющий собой объект, содержащий набор визуализаций, отображаемых вместе на одной странице в Amazon QuickSight. Каждый анализ и каждый дэшборд содержат по крайней мере один лист. Каждый лист содержит по крайней мере один элемент визуализации, например, диаграмму, сводную таблицу или аналитический вывод. Листы могут быть связаны с другими компонентами, такими как элементы управления, фильтры и т. д.

SheetId -> (строка)

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

Name -> (строка)

Имя листа. Это имя отображается на вкладке листа в консоли Amazon QuickSight.

Images -> (список)

Список изображений на листе.

(структура)

Изображение, расположенное на листе.

SheetImageId -> (строка)

Идентификатор изображения листа.

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

Источник изображения.

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

Источник статического файла, содержащего изображение.

StaticFileId -> (строка)

Идентификатор статического файла, содержащего изображение.

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

Определяет, как масштабируется изображение.

ScalingType -> (строка)

Вариант масштабирования для подгонки изображения внутри контейнера.

Допустимые значения определены следующим образом:

  • SCALE_TO_WIDTH : Изображение занимает всю ширину контейнера. Соотношение сторон изображения сохраняется.
  • SCALE_TO_HEIGHT : Изображение занимает всю высоту контейнера. Соотношение сторон изображения сохраняется.
  • SCALE_TO_CONTAINER : Изображение занимает всю ширину и высоту контейнера. Соотношение сторон изображения не сохраняется.
  • SCALE_NONE : Изображение отображается в исходном размере и не масштабируется относительно контейнера.

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

Подсказка, отображаемая при наведении курсора на изображение.

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

Текст, отображаемый в подсказке.

PlainText -> (строка)

Формат простого текста.

Visibility -> (строка)

Видимость подсказки.

ImageContentAltText -> (строка)

Альтернативный текст для изображения.

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

Настройка общих взаимодействий с изображением.

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

Варианты меню для изображения.

AvailabilityStatus -> (строка)

Статус доступности меню изображения. Если значение этого свойства установлено на ENABLED, пользователи дэшборда могут взаимодействовать с меню изображения.

Actions -> (список)

Список настроенных пользовательских действий для изображения.

(структура)

Пользовательское действие, определенное для изображения.

CustomActionId -> (строка)

Идентификатор пользовательского действия.

Name -> (строка)

Название пользовательского действия.

Status -> (строка)

Статус пользовательского действия.

Trigger -> (строка)

Триггер VisualCustomAction.

Допустимые значения определены следующим образом:

  • CLICK : Инициирует пользовательское действие щелчком левой кнопкой мыши по точке данных.
  • MENU : Инициирует пользовательское действие щелчком правой кнопкой мыши из меню.

ActionOperations -> (список)

Список ImageCustomActionOperations.

Это структура объединения типов. Для корректности структуры должен быть определен только один из атрибутов.

(структура)

Операция, определенная пользовательским действием.

Это структура объединения типов. Для корректности структуры должен быть определен только один из атрибутов.

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

Операция перехода между разными листами в одном анализе.

Это структура объединения типов. Для корректности структуры должен быть определен только один из атрибутов.

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

Настройка, определяющая целевой элемент перехода.

TargetSheetId -> (строка)

Лист, который является целевым объектом перехода в рамках одного анализа.

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

Операция URL, открывающая ссылку на другую веб-страницу.

URLTemplate -> (строка)

Ссылка URL CustomActionURLOperation.

URLTarget -> (строка)

Цель CustomActionURLOperation.

Допустимые значения определены следующим образом:

  • NEW_TAB : Открывает целевой URL в новой вкладке браузера.
  • NEW_WINDOW : Открывает целевой URL в новом окне браузера.
  • SAME_TAB : Открывает целевой URL в той же вкладке браузера.

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

Операция установки параметров в пользовательском действии.

ParameterValueConfigurations -> (список)

Параметр, определяющий конфигурацию значения.

(структура)

Настройка добавления параметров в действие.

DestinationParameterName -> (строка)

Имя параметра назначения SetParameterValueConfiguration.

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

Настройка значений параметра назначения.

Это структура объединения типов. Для корректности структуры должен быть определен только один из атрибутов.

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

Настройка пользовательских значений для параметра назначения в DestinationParameterValueConfiguration.

IncludeNullValue -> (логическое)

Включает значение NULL в значения параметров пользовательского действия.

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

Настраиваемые значения параметров.

Это структура объединения типов. Для корректности структуры должен быть определен только один из атрибутов.

StringValues -> (список)

Список значений параметров типа строка.

(строка)

IntegerValues -> (список)

Список значений параметров целого типа.

(целое)

DecimalValues -> (список)

Список значений параметров десятичного типа.

(двойное)

DateTimeValues -> (список)

Список значений параметров типа дата и время.

(метка времени)

SelectAllValueOptions -> (строка)

Настройка выбора всех вариантов.

SourceParameterName -> (строка)

Имя источника параметра назначения.

SourceField -> (строка)

Идентификатор поля источника параметра назначения.

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

Столбец набора данных.

DataSetIdentifier -> (строка)

Набор данных, к которому принадлежит столбец.

ColumnName -> (строка)

Имя столбца.

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

Время создания этого дэшборда.

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

Последнее время публикации этого дэшборда.

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

Последнее время обновления этого дэшборда.

LinkEntities -> (список)

Список Amazon Resource Names (ARN) анализов, которые нужно связать с дэшбордом.

(строка)

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

HTTP-статус этого запроса.

RequestId -> (строка)

Идентификатор запроса Amazon Web Services для этой операции.

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

Spec-Zone.ru

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