Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

create-theme

Описание

Создаёт тему.

Тема — это набор параметров конфигурации для цвета и макета. Тема применяется к анализам и панелям мониторинга. Для получения дополнительной информации см. Использование тем в Amazon QuickSight в Руководстве пользователя Amazon QuickSight.

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

Синтаксис

  create-theme
--aws-account-id <value>
--theme-id <value>
--name <value>
--base-theme-id <value>
[--version-description <value>]
--configuration <value>
[--permissions <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, в которой нужно сохранить новую тему.

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

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

--name (строка)

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

--base-theme-id (строка)

Идентификатор темы, от которой будет наследоваться настраиваемая тема. Все темы наследуют одну из начальных тем, определённых Amazon QuickSight. Для просмотра списка начальных тем используйте ListThemes или выберите Themes в анализе.

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

Описание первой версии создаваемой темы. Каждый раз, когда вызывается UpdateTheme, создаётся новая версия. Каждая версия темы имеет описание версии в поле VersionDescription.

--configuration (структура)

Конфигурация темы, содержащая свойства отображения темы.

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

Свойства цвета, применяемые к цветам данных на диаграммах.

Colors -> (список)

Шестнадцатеричные коды цветов.

(строка)

MinMaxGradient -> (список)

Минимальный и максимальный шестнадцатеричные коды, описывающие градиент цвета.

(строка)

EmptyFillColor -> (строка)

Шестнадцатеричный код цвета, применяемый к диаграммам, на которых отображается отсутствие данных.

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

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

PrimaryForeground -> (строка)

Цвет текста и других элементов переднего плана, отображаемых над основными областями фона, такими как линии сетки, рамки, полосы таблиц, значки и так далее.

PrimaryBackground -> (строка)

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

SecondaryForeground -> (строка)

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

SecondaryBackground -> (строка)

Цвет фона листа и элементов управления листами.

Accent -> (строка)

Цвет, применяемый к выбранным состояниям и кнопкам.

AccentForeground -> (строка)

Цвет переднего плана, применяемый к любому тексту или другим элементам, отображаемым над цветом акцента.

Danger -> (строка)

Цвет, применяемый к сообщениям об ошибках.

DangerForeground -> (строка)

Цвет переднего плана, применяемый к любому тексту или другим элементам, отображаемым над цветом ошибки.

Warning -> (строка)

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

WarningForeground -> (строка)

Цвет переднего плана, применяемый к любому тексту или другим элементам, отображаемым над цветом предупреждения.

Success -> (строка)

Цвет, применяемый к сообщениям об успехе, например, к отметке о успешном скачивании.

SuccessForeground -> (строка)

Цвет переднего плана, применяемый к любому тексту или другим элементам, отображаемым над цветом успеха.

Dimension -> (строка)

Цвет, применяемый к именам полей, идентифицированных как измерения.

DimensionForeground -> (строка)

Цвет переднего плана, применяемый к любому тексту или другим элементам, отображаемым над цветом измерения.

Measure -> (строка)

Цвет, применяемый к именам полей, идентифицированных как метрики.

MeasureForeground -> (строка)

Цвет переднего плана, применяемый к любому тексту или другим элементам, отображаемым над цветом метрики.

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

Параметры отображения, относящиеся к листам.

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

Параметры отображения плиток.

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

Граница вокруг плитки.

Show -> (булево)

Параметр для включения отображения границ визуализаций.

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

Параметры макета плиток.

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

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

Show -> (булево)

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

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

Параметры отступов, применяемые вокруг внешнего края листов.

Show -> (булево)

Это булево значение управляет отображением отступов листа.

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

Определяет параметры шрифтов.

FontFamilies -> (список)

Определяет список семейств шрифтов.

(структура)

Определяет настройки шрифта.

FontFamily -> (строка)

Определяет параметры семейства шрифтов.

Синтаксис JSON:

{
  "DataColorPalette": {
    "Colors": ["string", ...],
    "MinMaxGradient": ["string", ...],
    "EmptyFillColor": "string"
  },
  "UIColorPalette": {
    "PrimaryForeground": "string",
    "PrimaryBackground": "string",
    "SecondaryForeground": "string",
    "SecondaryBackground": "string",
    "Accent": "string",
    "AccentForeground": "string",
    "Danger": "string",
    "DangerForeground": "string",
    "Warning": "string",
    "WarningForeground": "string",
    "Success": "string",
    "SuccessForeground": "string",
    "Dimension": "string",
    "DimensionForeground": "string",
    "Measure": "string",
    "MeasureForeground": "string"
  },
  "Sheet": {
    "Tile": {
      "Border": {
        "Show": true|false
      }
    },
    "TileLayout": {
      "Gutter": {
        "Show": true|false
      },
      "Margin": {
        "Show": true|false
      }
    }
  },
  "Typography": {
    "FontFamilies": [
      {
        "FontFamily": "string"
      }
      ...
    ]
  }
}

--permissions (список)

Правильное группирование разрешений на ресурсы для применения к новой теме.

(структура)

Разрешение на ресурс.

Principal -> (строка)

Amazon Resource Name (ARN) принципала. Это может быть одно из следующего:

  • ARN пользователя или группы Amazon QuickSight, связанных с источником данных или набором данных. (Это обычно.)
  • ARN пользователя, группы или пространства имён Amazon QuickSight, связанных с анализом, панелью мониторинга, шаблоном или темой. (Это обычно.)
  • ARN корневой учётной записи Amazon Web Services: это IAM ARN, а не QuickSight ARN. Используйте этот параметр только для совместного использования ресурсов (шаблонов) между учётными записями Amazon Web Services. (Это менее распространено.)

Actions -> (список)

IAM действие для предоставления или отмены разрешений.

(строка)

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

Principal=string,Actions=string,string ...

Синтаксис JSON:

[
  {
    "Principal": "string",
    "Actions": ["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
  • text
  • таблица
  • 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-in-base64-out

--no-cli-pager (булево)

Отключить пейджер командной строки для вывода.

--cli-auto-prompt (булево)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросить параметры ввода CLI.

Вывод

Arn -> (строка)

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

VersionArn -> (строка)

Идентификатор ресурса Amazon (ARN) новой темы.

ThemeId -> (строка)

Идентификатор темы.

CreationStatus -> (строка)

Статус создания темы.

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

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

RequestId -> (строка)

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

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

Spec-Zone.ru

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