обновить-пользователя

Описание

Обновляет пользователя Amazon QuickSight.

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

Синтаксис

  update-user
--user-name <value>
--aws-account-id <value>
--namespace <value>
--email <value>
--role <value>
[--custom-permissions-name <value>]
[--unapply-custom-permissions | --no-unapply-custom-permissions]
[--external-login-federation-provider-type <value>]
[--custom-federation-provider-url <value>]
[--external-login-id <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 (строка)

Имя пользователя Amazon QuickSight, которое вы хотите обновить.

--aws-account-id (строка)

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

--namespace (строка)

Пространство имен. В настоящее время вы должны установить его на default .

--email (строка)

Электронный адрес пользователя, который вы хотите обновить.

--role (строка)

Роль Amazon QuickSight пользователя. Роль может быть одной из следующих стандартных ролей безопасности:

READER : Пользователь с только что-читаемым доступом к панелям управления.
AUTHOR : Пользователь, который может создавать источники данных, наборы данных, анализы и панели управления.
ADMIN : Пользователь-автор, который также может управлять настройками Amazon QuickSight.
READER_PRO : Reader Pro добавляет возможности генеративного BI к роли Reader. Reader Pro имеют доступ к Amazon Q в Amazon QuickSight, могут создавать истории с Amazon Q и генерировать сводные таблицы из панелей управления.
AUTHOR_PRO : Author Pro добавляет возможности генеративного BI к роли Author. Author Pro могут создавать панели управления с помощью естественного языка с Amazon Q, создавать истории с Amazon Q, создавать темы для Q&A и генерировать сводные таблицы из панелей управления.
ADMIN_PRO : Admin Pro – это Author Pro, которые также могут управлять административными настройками Amazon QuickSight. Пользователи Admin Pro оплачиваются по ценам Author Pro.

Название роли Amazon QuickSight скрыто для пользователя, за исключением экранов консоли, связанных с разрешениями.

Возможные значения:

ADMIN
AUTHOR
READER
RESTRICTED_AUTHOR
RESTRICTED_READER
ADMIN_PRO
AUTHOR_PRO
READER_PRO

--custom-permissions-name (строка)

(Только для версии Enterprise) Имя настраиваемого профиля разрешений, который вы хотите назначить этому пользователю. Настраиваемые разрешения позволяют контролировать доступ пользователя, ограничивая доступ к следующим операциям:

Создание и обновление источников данных
Создание и обновление наборов данных
Создание и обновление отчетов по электронной почте
Подписка на отчеты по электронной почте

Набор настраиваемых разрешений включает любые комбинации этих ограничений. В настоящее время вам необходимо создавать имена профилей для настраиваемых наборов разрешений с помощью консоли Amazon QuickSight. Затем вы используете операцию API RegisterUser для назначения настраиваемого набора разрешений пользователю Amazon QuickSight.

Настраиваемые разрешения Amazon QuickSight применяются через политики IAM. Поэтому они переопределяют разрешения, обычно предоставляемые при назначении пользователей Amazon QuickSight одной из стандартных ролей безопасности в Amazon QuickSight (администратор, автор, читатель).

Эта функция доступна только для подписок Amazon QuickSight Enterprise.

--unapply-custom-permissions | --no-unapply-custom-permissions (булево)

Флаг, который используется для указания того, что вы хотите удалить все настраиваемые разрешения у этого пользователя. Использование этого параметра сбрасывает состояние пользователя до состояния, которое было до применения настраиваемого профиля разрешений. По умолчанию этот параметр равен NULL и не принимает других значений.

--external-login-federation-provider-type (строка)

Тип поддерживаемого внешнего поставщика входа, который предоставляет идентификацию, позволяющую пользователю выполнить федерацию в Amazon QuickSight с связанной ролью управления идентификацией и доступом (IAM). Тип поддерживаемого внешнего поставщика входа может быть одним из следующих.

COGNITO : Amazon Cognito. URL поставщика — cognito-identity.amazonaws.com. При выборе типа поставщика COGNITO не используйте параметр «CustomFederationProviderUrl», который необходим только в том случае, если внешний поставщик является настраиваемым.
CUSTOM_OIDC : Настраиваемый поставщик OpenID Connect (OIDC). При выборе типа CUSTOM_OIDC используйте параметр CustomFederationProviderUrl для указания URL настраиваемого поставщика OIDC.
NONE : Это очищает всю ранее сохраненную информацию об внешнем входе для пользователя. Используйте операцию API `` DescribeUser `` для проверки информации об внешнем входе.

--custom-federation-provider-url (строка)

URL настраиваемого поставщика OpenID Connect (OIDC), который предоставляет идентификацию, позволяющую пользователю выполнить федерацию в Amazon QuickSight с связанной ролью управления идентификацией и доступом (IAM). Этот параметр следует использовать только в том случае, если параметр ExternalLoginFederationProviderType установлен в CUSTOM_OIDC.

--external-login-id (строка)

Идентификатор идентичности пользователя во внешнем поставщике входа.

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

Вывод

Пользователь -> (структура)

Пользователь Amazon QuickSight.

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) пользователя.

UserName -> (строка)

Имя пользователя. Это значение обязательно, если вы регистрируете пользователя, который будет управляться в Amazon QuickSight. В выводе значение для UserName равно N/A, когда значение для IdentityType равно IAM, и соответствующий пользователь IAM удалён.

Email -> (строка)

Электронный адрес пользователя.

Role -> (строка)

Роль пользователя в Amazon QuickSight. Роль пользователя может быть одной из следующих:

READER : Пользователь с правами только на чтение для дашбордов.
AUTHOR : Пользователь, который может создавать источники данных, наборы данных, анализы и дашборды.
ADMIN : Автор, который также может управлять настройками Amazon QuickSight.
READER_PRO : Reader Pro добавляет возможности Generative BI к роли Reader. Reader Pro имеют доступ к Amazon Q в Amazon QuickSight, могут создавать истории с Amazon Q и генерировать сводные таблицы из дашбордов.
AUTHOR_PRO : Author Pro добавляет возможности Generative BI к роли Author. Author Pro могут создавать дашборды с помощью естественного языка с Amazon Q, создавать истории с Amazon Q, создавать темы для Q&A и генерировать сводные таблицы из дашбордов.
ADMIN_PRO : Admin Pro — это Author Pro, которые также могут управлять административными настройками Amazon QuickSight. Пользователи Admin Pro оплачиваются по цене Author Pro.
RESTRICTED_READER : Эта роль в настоящее время недоступна для использования.
RESTRICTED_AUTHOR : Эта роль в настоящее время недоступна для использования.

IdentityType -> (строка)

Тип аутентификации личности, используемый пользователем.

Active -> (булево)

Статус активности пользователя. При создании пользователя Amazon QuickSight, который не является пользователем IAM или пользователем Active Directory, этот пользователь неактивен, пока не войдёт в систему и не укажет пароль.

PrincipalId -> (строка)

Идентификатор принципала пользователя.

CustomPermissionsName -> (строка)

Профиль пользовательских разрешений, связанный с этим пользователем.

ExternalLoginFederationProviderType -> (строка)

Тип поддерживаемого внешнего поставщика входа, который предоставляет личность, позволяющую пользователю войти в Amazon QuickSight с связанной ролью IAM. Тип может быть одним из следующих.

COGNITO : Amazon Cognito. Адрес поставщика — cognito-identity.amazonaws.com.
CUSTOM_OIDC : Пользовательский поставщик OpenID Connect (OIDC).

ExternalLoginFederationProviderUrl -> (строка)

URL внешнего поставщика входа.

ExternalLoginId -> (строка)

Идентификатор личности пользователя во внешнем поставщике входа.

RequestId -> (строка)

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

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

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