describe-account-customization

Описание

Описывает настройки, связанные с предоставленной учетной записью Amazon Web Services и пространством имен Amazon QuickSight в регионе Amazon Web Services. Консоль Amazon QuickSight определяет, какие настройки применять, выполняя эту операцию API с включённым флагом Resolved.

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

• Amazon Web Services account - Учетная запись Amazon Web Services расположена в верхней части иерархии. Она может использовать все регионы и службы Amazon Web Services. При подписке на Amazon QuickSight вы выбираете один регион Amazon Web Services в качестве домашнего. Там находится ваш бесплатный объём SPICE. Вы можете использовать Amazon QuickSight в любом поддерживаемом регионе Amazon Web Services.
• Amazon Web Services Region - В каждом регионе Amazon Web Services, где вы хотя бы раз заходили в Amazon QuickSight, Amazon QuickSight выступает как отдельная инстанция той же самой службы. Если у вас есть пользовательский каталог, он находится в us-east-1, который является US East (N. Virginia). Как правило, эти пользователи имеют доступ к Amazon QuickSight в любом регионе Amazon Web Services, если только они не ограничены пространством имён. Для выполнения команды в другом регионе Amazon Web Services измените настройки региона. Если вы используете командную строку, вы можете использовать один из следующих вариантов:
  • Использовать параметры командной строки.
  • Использовать профили с именами.
  • Выполнить aws configure для изменения вашего стандартного региона Amazon Web Services. Используйте Enter, чтобы задать те же настройки для ваших ключей. Дополнительную информацию можно найти в разделе Настройка командной строки.
• Namespace - Пространство имён QuickSight — это раздел, содержащий пользователей и ресурсы (источники данных, наборы данных, панели мониторинга и т. д.). Для доступа к ресурсам в конкретном пространстве имён пользователи и группы также должны быть частью этого пространства имён. Люди, которые используют одно и то же пространство имён, полностью изолированы от пользователей и ресурсов в других пространствах имён, даже если они находятся в одной и той же учетной записи Amazon Web Services и регионе Amazon Web Services.
• Applied customizations - Внутри региона Amazon Web Services набор настроек Amazon QuickSight может применяться к учетной записи Amazon Web Services или пространству имён. Параметры, которые вы применяете к пространству имён, переопределяют параметры, применяемые к учетной записи Amazon Web Services. Все настройки изолированы в одном регионе Amazon Web Services. Чтобы применить их в других регионах Amazon Web Services, выполните команду CreateAccountCustomization в каждом регионе Amazon Web Services, где вы хотите применить те же самые настройки.

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

Синтаксис

  describe-account-customization
--aws-account-id <value>
[--namespace <value>]
[--resolved | --no-resolved]
[--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 (строка)

--namespace (строка)

--resolved | --no-resolved (логическое значение)

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

AwsAccountId -> (строка)

Namespace -> (строка)

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

RequestId -> (строка)

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