[ aws . quicksight ]
describe-user
Описание
Возвращает информацию о пользователе, заданном по имени пользователя.
См. также: AWS API документацию
Синтаксис
describe-user
--user-name <value>
--aws-account-id <value>
--namespace <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]
Параметры
--user-name (строка)
--aws-account-id (строка)
--namespace (строка)
default.--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.
Вывод
Пользователь -> (структура)
Имя пользователя.
Arn -> (строка)
UserName -> (строка)
UserName имеет значение N/A, когда значение IdentityType равно IAM, а соответствующий пользователь IAM удалён.Email -> (строка)
Role -> (строка)
Роль Amazon QuickSight для пользователя. Роль пользователя может быть одной из следующих:
-
READER: Пользователь с только что-просмотром доступа к панелям. -
AUTHOR: Пользователь, который может создавать источники данных, наборы данных, анализы и панели. -
ADMIN: Пользователь-автор, который также может управлять настройками Amazon QuickSight. -
READER_PRO: Reader Pro добавляет возможности Generative BI к роли Reader. Reader Pros имеют доступ к Amazon Q в Amazon QuickSight, могут создавать истории с Amazon Q и могут генерировать сводные таблицы из панелей. -
AUTHOR_PRO: Author Pro добавляет возможности Generative BI к роли Author. Author Pros могут создавать панели с использованием естественного языка с Amazon Q, создавать истории с Amazon Q, создавать темы для Q&A и генерировать сводные таблицы из панелей. -
ADMIN_PRO: Admin Pros являются Author Pros, которые также могут управлять административными настройками Amazon QuickSight. Пользователи Admin Pro оплачиваются по цене Author Pro. -
RESTRICTED_READER: Эта роль в настоящее время недоступна для использования. -
RESTRICTED_AUTHOR: Эта роль в настоящее время недоступна для использования.
IdentityType -> (строка)
Active -> (логическое значение)
PrincipalId -> (строка)
CustomPermissionsName -> (строка)
ExternalLoginFederationProviderType -> (строка)
Тип поддерживаемого внешнего поставщика входа, предоставляющего идентификацию, позволяющую пользователю пройти федерацию в Amazon QuickSight с связанной ролью IAM. Тип может быть одним из следующих.
-
COGNITO: Amazon Cognito. URL поставщика — cognito-identity.amazonaws.com. -
CUSTOM_OIDC: Пользовательский поставщик OpenID Connect (OIDC).
ExternalLoginFederationProviderUrl -> (строка)
ExternalLoginId -> (строка)
RequestId -> (строка)
Status -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|