Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

describe-brand

Описание

Описывает бренд.

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

Синтаксис

  describe-brand
--aws-account-id <value>
--brand-id <value>
[--version-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, которая владеет брендом.

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

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

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

Идентификатор конкретной версии. По умолчанию используется последняя версия.

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

Вывод

RequestId -> (строка)

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

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

Подробности бренда.

BrandId -> (строка)

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

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) бренда.

BrandStatus -> (строка)

Статус бренда.

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

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

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

Последнее время обновления бренда.

VersionId -> (строка)

Идентификатор версии.

VersionStatus -> (строка)

Статус версии.

Errors -> (список)

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

(строка)

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

Подробности логотипа.

AltText -> (строка)

Альтернативный текст для логотипа.

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

Набор настроенных логотипов.

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

Основной логотип.

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

Оригинальное изображение.

Source -> (структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: PublicUrl, S3Uri.

PublicUrl -> (строка)

Общедоступный URL, указывающий на исходное изображение.

S3Uri -> (строка)

Amazon S3 URI, указывающий на исходное изображение.

GeneratedImageUrl -> (строка)

URL, указывающий на сгенерированное изображение логотипа.

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

Изображение с высотой 64 пикселя.

Source -> (структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: PublicUrl, S3Uri.

PublicUrl -> (строка)

Общедоступный URL, указывающий на исходное изображение.

S3Uri -> (строка)

Amazon S3 URI, указывающий на исходное изображение.

GeneratedImageUrl -> (строка)

URL, указывающий на сгенерированное изображение логотипа.

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

Изображение с высотой 32 пикселя.

Source -> (структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: PublicUrl, S3Uri.

PublicUrl -> (строка)

Общедоступный URL, указывающий на исходное изображение.

S3Uri -> (строка)

Amazon S3 URI, указывающий на исходное изображение.

GeneratedImageUrl -> (строка)

URL, указывающий на сгенерированное изображение логотипа.

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

Логотип Favicon.

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

Оригинальное изображение.

Source -> (структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: PublicUrl, S3Uri.

PublicUrl -> (строка)

Общедоступный URL, указывающий на исходное изображение.

S3Uri -> (строка)

Amazon S3 URI, указывающий на исходное изображение.

GeneratedImageUrl -> (строка)

URL, указывающий на сгенерированное изображение логотипа.

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

Изображение с высотой 64 пикселя.

Source -> (структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: PublicUrl, S3Uri.

PublicUrl -> (строка)

Общедоступный URL, указывающий на исходное изображение.

S3Uri -> (строка)

Amazon S3 URI, указывающий на исходное изображение.

GeneratedImageUrl -> (строка)

URL, указывающий на сгенерированное изображение логотипа.

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

Изображение с высотой 32 пикселя.

Source -> (структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: PublicUrl, S3Uri.

PublicUrl -> (строка)

Общедоступный URL, указывающий на исходное изображение.

S3Uri -> (строка)

Amazon S3 URI, указывающий на исходное изображение.

GeneratedImageUrl -> (строка)

URL, указывающий на сгенерированное изображение логотипа.

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

Определение бренда.

BrandName -> (строка)

Название бренда.

Description -> (строка)

Описание бренда.

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

Тема приложения бренда.

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

Цветовая палитра.

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

Основной цвет.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

Дополнительный цвет.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

Цвет, используемый для акцентных элементов.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

Цвет, используемый для элементов измерения.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

Цвет, используемый для элементов размеров.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

Цвет, используемый для элементов успеха.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

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

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

Цвет, используемый для элементов предупреждения.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

Цвет, используемый для элементов опасности.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

Стиль элемента.

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

Стиль панели навигации.

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

Стиль глобальной панели навигации.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

Стиль контекстной панели навигации.

Foreground -> (строка)

Цвет переднего плана.

Background -> (строка)

Цвет фона.

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

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

AltText -> (строка)

Альтернативный текст для логотипа.

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

Набор настроенных логотипов.

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

Основной логотип.

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

Оригинальное изображение.

Source -> (структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: PublicUrl, S3Uri.

PublicUrl -> (строка)

Общедоступный URL, указывающий на исходное изображение.

S3Uri -> (строка)

Amazon S3 URI, указывающий на исходное изображение.

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

Логотип Favicon.

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

Оригинальное изображение.

Source -> (структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: PublicUrl, S3Uri.

PublicUrl -> (строка)

Общедоступный URL, указывающий на исходное изображение.

S3Uri -> (строка)

Amazon S3 URI, указывающий на исходное изображение.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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