Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

создать-бренд

Описание

Создает бренд Amazon QuickSight.

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

Синтаксис

  create-brand
--aws-account-id <value>
--brand-id <value>
[--brand-definition <value>]
[--tags <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.

--brand-definition (структура)

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

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, указывающий на исходное изображение.

Синтаксис JSON:

{
  "BrandName": "string",
  "Description": "string",
  "ApplicationTheme": {
    "BrandColorPalette": {
      "Primary": {
        "Foreground": "string",
        "Background": "string"
      },
      "Secondary": {
        "Foreground": "string",
        "Background": "string"
      },
      "Accent": {
        "Foreground": "string",
        "Background": "string"
      },
      "Measure": {
        "Foreground": "string",
        "Background": "string"
      },
      "Dimension": {
        "Foreground": "string",
        "Background": "string"
      },
      "Success": {
        "Foreground": "string",
        "Background": "string"
      },
      "Info": {
        "Foreground": "string",
        "Background": "string"
      },
      "Warning": {
        "Foreground": "string",
        "Background": "string"
      },
      "Danger": {
        "Foreground": "string",
        "Background": "string"
      }
    },
    "BrandElementStyle": {
      "NavbarStyle": {
        "GlobalNavbar": {
          "Foreground": "string",
          "Background": "string"
        },
        "ContextualNavbar": {
          "Foreground": "string",
          "Background": "string"
        }
      }
    }
  },
  "LogoConfiguration": {
    "AltText": "string",
    "LogoSet": {
      "Primary": {
        "Original": {
          "Source": {
            "PublicUrl": "string",
            "S3Uri": "string"
          }
        }
      },
      "Favicon": {
        "Original": {
          "Source": {
            "PublicUrl": "string",
            "S3Uri": "string"
          }
        }
      }
    }
  }
}

--tags (список)

Массив пар ключ-значение, назначенных бренду.

(структура)

Ключ или ключи пар ключ-значение для тегов ресурса или тегов, назначенных ресурсу.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

Сокращенный синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-в-base64-выход

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