Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

Настройка учетной записи

Описание

Создает настройки Amazon QuickSight для текущего региона Amazon Web Services. В настоящее время вы можете добавить пользовательскую тему по умолчанию, используя API-операцию CreateAccountCustomization или UpdateAccountCustomization. Чтобы дополнительно настроить Amazon QuickSight, удалив образцы ресурсов и видео Amazon QuickSight для всех новых пользователей, ознакомьтесь с разделом «Настройка Amazon QuickSight» в руководстве пользователя Amazon QuickSight.

Вы можете создать настройки для вашей учетной записи Amazon Web Services или, если вы укажете имя пространства, для пространства QuickSight вместо этого. Настройки, применимые к пространству, всегда переопределяют настройки, применимые к учетной записи Amazon Web Services. Чтобы узнать, какие настройки применяются, используйте API-операцию DescribeAccountCustomization.

Перед использованием API-операции CreateAccountCustomization для добавления темы в качестве темы по умолчанию для пространства, убедитесь, что вы сначала поделились этой темой с пространством. Если вы не поделитесь ею с пространством, тема не будет видна вашим пользователям, даже если вы сделаете её темой по умолчанию. Чтобы проверить, разделена ли тема, просмотрите текущие разрешения, используя API-операцию `` DescribeThemePermissions ``. Чтобы поделиться темой, предоставьте разрешения, используя API-операцию `` UpdateThemePermissions ``.

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

Синтаксис

  create-account-customization
--aws-account-id <value>
[--namespace <value>]
--account-customization <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, для которой вы хотите настроить Amazon QuickSight.

--namespace (строка)

Пространство Amazon QuickSight, к которому вы хотите добавить настройки.

--account-customization (структура)

Настройки Amazon QuickSight, которые вы добавляете в текущем регионе Amazon Web Services. Вы можете добавить их к учетной записи Amazon Web Services и пространству QuickSight.

Например, вы можете добавить тему по умолчанию, установив AccountCustomization на тему midnight: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Или вы можете добавить пользовательскую тему, указав "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.

DefaultTheme -> (строка)

Тема по умолчанию для этой подписки Amazon QuickSight.

DefaultEmailCustomizationTemplate -> (строка)

Шаблон пользовательской настройки по умолчанию для электронной почты.

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

DefaultTheme=string,DefaultEmailCustomizationTemplate=string

Синтаксис JSON:

{
  "DefaultTheme": "string",
  "DefaultEmailCustomizationTemplate": "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-in-base64-out

--no-cli-pager (логическое значение)

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Arn -> (строка)

Amazon Resource Name (ARN) настройки, которую вы создали для этой учетной записи Amazon Web Services.

AwsAccountId -> (строка)

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

Namespace -> (строка)

Пространство, связанное с настройкой, которую вы создаете.

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

Настройки Amazon QuickSight, которые вы добавляете в текущем регионе Amazon Web Services.

DefaultTheme -> (строка)

Тема по умолчанию для этой подписки Amazon QuickSight.

DefaultEmailCustomizationTemplate -> (строка)

Шаблон пользовательской настройки по умолчанию для электронной почты.

RequestId -> (строка)

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

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

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

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

Spec-Zone.ru

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