Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

описание-анализа

Описание

Предоставляет сводку метаданных для анализа.

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

Синтаксис

  describe-analysis
--aws-account-id <value>
--analysis-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]

Параметры

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

Идентификатор учётной записи Amazon Web Services, содержащей анализ. Вы должны использовать учётную запись Amazon Web Services, в которой находится анализ.

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

Идентификатор анализа, который вы описываете. Идентификатор является частью URL-адреса анализа.

--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 (строка)

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

  • вкл
  • выкл
  • авто

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

Вывод

Анализ -> (структура)

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

AnalysisId -> (строка)

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

Arn -> (строка)

Amazon Resource Name (ARN) анализа.

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

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

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

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

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

Ошибки, связанные с анализом.

(структура)

Ошибка анализа.

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

Тип ошибки анализа.

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

Сообщение, связанное с ошибкой анализа.

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

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

(структура)

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

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

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

DataSetArns -> (список)

ARN наборов данных анализа.

(строка)

ThemeArn -> (строка)

ARN темы анализа.

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

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

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

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

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

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

(структура)

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

SheetId -> (строка)

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

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

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

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

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

(структура)

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

SheetImageId -> (строка)

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

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

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

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

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

StaticFileId -> (строка)

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

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

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

ТипМасштабирования -> (строка)

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

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

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

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

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

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

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

ПростойТекст -> (строка)

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

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

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

АльтернативныйТекстИзображения -> (строка)

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

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

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

ВариантМенюИзображения -> (структура)

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

СтатусДоступности -> (строка)

Статус доступности меню изображения. Если значение этого свойства установлено в 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 -> (строка)

Имя столбца.

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

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

RequestId -> (строка)

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

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

Spec-Zone.ru

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