Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

describe-template

Описание

Описывает метаданные шаблона.

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

Синтаксис

  describe-template
--aws-account-id <value>
--template-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, содержащей шаблон, который вы описываете.

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

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

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

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

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

Псевдоним шаблона, который вы хотите описать. Если вы указываете конкретный псевдоним, вы описываете версию, к которой он указывает. Вы можете указать последнюю версию шаблона, указав ключевое слово $LATEST в параметре AliasName. Ключевое слово $PUBLISHED не применяется к шаблонам.

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

Вывод

Шаблон -> (структура)

Структура шаблона для объекта, который вы хотите описать.

Arn -> (строка)

Amazon Resource Name (ARN) шаблона.

Имя -> (строка)

Отображаемое имя шаблона.

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

Структура, описывающая версии шаблона.

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

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

Ошибки -> (список)

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

(структура)

Список ошибок, возникших при неудачном создании версии шаблона.

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

Тип ошибки.

Сообщение -> (строка)

Описание типа ошибки.

НарушенныеСущности -> (список)

Путь ошибки, показывающий, какие сущности вызвали ошибку шаблона.

(структура)

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

Путь -> (строка)

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

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

Номер версии шаблона.

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

Статус, связанный с шаблоном.

  • CREATION_IN_PROGRESS
  • CREATION_SUCCESSFUL
  • CREATION_FAILED
  • UPDATE_IN_PROGRESS
  • UPDATE_SUCCESSFUL
  • UPDATE_FAILED
  • DELETED

НастройкиНаборовДанных -> (список)

Схема набора данных, определенного плейсхолдером. Любая панель, созданная по этому шаблону, должна быть связана с новыми наборами данных, соответствующими той же схеме, описанной в этом API-запросе.

(структура)

Конфигурация набора данных.

Плейсхолдер -> (строка)

Плейсхолдер.

СхемаНабораДанных -> (структура)

Схема набора данных.

СписокСхемСтолбцов -> (список)

Структура, содержащая список схем столбцов.

(структура)

Схема столбца.

Имя -> (строка)

Имя схемы столбца.

ТипДанных -> (строка)

Тип данных схемы столбца.

ГеографическаяРоль -> (строка)

Географическая роль схемы столбца.

СписокСхемГруппСтолбцов -> (список)

Структура, содержащая список схем групп столбцов.

(структура)

Схема группы столбцов.

Имя -> (строка)

Имя схемы группы столбцов.

СписокСхемСтолбцовГруппы -> (список)

Структура, содержащая список схем столбцов группы.

(структура)

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

Имя -> (строка)

Имя схемы столбца группы.

Описание -> (строка)

Описание шаблона.

SourceEntityArn -> (строка)

Amazon Resource Name (ARN) анализа или шаблона, который использовался для создания этого шаблона.

ThemeArn -> (строка)

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

Листы -> (список)

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

(структура)

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

SheetId -> (строка)

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

Имя -> (строка)

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

Изображения -> (список)

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

(структура)

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

SheetImageId -> (строка)

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

Источник -> (структура)

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

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

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

StaticFileId -> (строка)

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

Масштабирование -> (структура)

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

ScalingType -> (строка)

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

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

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

Подсказка -> (структура)

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

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

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

PlainText -> (строка)

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

Видимость -> (строка)

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

AltTextИзображения -> (строка)

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

Взаимодействия -> (структура)

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

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

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

AvailabilityStatus -> (строка)

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

Действия -> (список)

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

(структура)

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

CustomActionId -> (строка)

Идентификатор настраиваемого действия.

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

Имя настраиваемого действия.

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

Статус настраиваемого действия.

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

Триггер 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.

Значение -> (структура)

Конфигурация целевых значений параметра.

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

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

Конфигурация пользовательских значений для целевого параметра в DestinationParameterValueConfiguration.

IncludeNullValue -> (булево)

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

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

Пользовательские значения параметра.

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

StringValues -> (список)

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

(строка)

IntegerValues -> (список)

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

(целое число)

DecimalValues -> (список)

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

(вещественное число)

DateTimeValues -> (список)

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

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

SelectAllValueOptions -> (строка)

Конфигурация, которая выбирает все варианты.

SourceParameterName -> (строка)

Имя исходного параметра целевого параметра.

SourceField -> (строка)

Идентификатор исходного поля целевого параметра.

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

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

DataSetIdentifier -> (строка)

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

ColumnName -> (строка)

Имя столбца.

TemplateId -> (строка)

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

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

Время последнего обновления.

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

Время создания.

Статус -> (целое число)

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

RequestId -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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