[ aws . cognito-idp ]
admin-update-device-status
Описание
Обновляет статус устройства пользователя, отмечая его как запомненное или не запомненное для целей аутентификации по устройству. Аутентификация по устройству — это механизм «запомнить меня», который без участия пользователя завершает вход с доверенных устройств с помощью ключа устройства вместо кода MFA. Данная операция изменяет статус устройства, не удаляя его, поэтому вы можете снова его включить позже. Дополнительную информацию об аутентификации по устройству см. в разделе Работа с устройствами.
Примечание
Amazon Cognito оценивает политики управления идентификацией и доступом (IAM) в запросах для данной операции API. Для этой операции необходимо использовать учетные данные IAM для авторизации запросов и предоставить себе соответствующее разрешение IAM в политике.
- Подписание запросов к API Amazon Web Services
- Использование API пулов пользователей Amazon Cognito и конечных точек пулов пользователей
См. также: Документация по API AWS
Синтаксис
admin-update-device-status
--user-pool-id <value>
--username <value>
--device-key <value>
[--device-remembered-status <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-pool-id (строка)
--username (строка)
username не является атрибутом псевдонима в вашем пуле пользователей, это значение должно быть sub локального пользователя или именем пользователя из стороннего IdP.--device-key (строка)
--device-remembered-status (строка)
Для включения аутентификации по устройству с указанным устройством установите значение в remembered. Для отключения установите значение в not_remembered.
Возможные значения:
rememberednot_remembered
--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.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, аналогичные unix. Эти примеры потребуют адаптации к правилам цитирования вашей консоли. Смотрите Использование кавычек со строками в руководстве пользователя AWS CLI.
Для обновления статуса устройства
В этом примере устанавливается статус устройства «запомнить устройство» для устройства с идентификатором device-key в состояние «не запомнено».
Команда:
aws cognito-idp admin-update-device-status --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --device-key xxxx --device-remembered-status not_remembered
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.