[ aws . cognito-idp ]
admin-get-device
Описание
Принимая ключ устройства, возвращает сведения об устройстве пользователя. Дополнительную информацию см. в разделе Работа с устройствами.
Примечание
Amazon Cognito оценивает политики управления идентификацией и доступом (IAM) в запросах к этой операции API. Для этой операции необходимо использовать учетные данные IAM для авторизации запросов и предоставить себе соответствующее разрешение IAM в политике.
- Подписание запросов к API Amazon Web Services
- Использование API пулов пользователей Amazon Cognito и конечных точек пулов пользователей
См. также: Документация по API AWS
Синтаксис
admin-get-device
--device-key <value>
--user-pool-id <value>
--username <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]
Параметры
--device-key (строка)
--user-pool-id (строка)
--username (строка)
username не является атрибутом псевдонима в вашем пуле пользователей, это значение должно быть sub локального пользователя или именем пользователя из стороннего IdP.--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.
Если не указано иное, все примеры используют правила цитирования, подобные UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Получение устройства
Следующий admin-get-device пример отображает одно устройство для пользователя diego.
aws cognito-idp admin-get-device \
--user-pool-id us-west-2_EXAMPLE \
--username diego \
--device-key us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
Вывод:
{
"Device": {
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceAttributes": [
{
"Name": "device_status",
"Value": "valid"
},
{
"Name": "device_name",
"Value": "MyDevice"
},
{
"Name": "dev:device_arn",
"Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
},
{
"Name": "dev:device_owner",
"Value": "diego.us-west-2_EXAMPLE"
},
{
"Name": "last_ip_used",
"Value": "192.0.2.1"
},
{
"Name": "dev:device_remembered_status",
"Value": "remembered"
},
{
"Name": "dev:device_sdk",
"Value": "aws-sdk"
}
],
"DeviceCreateDate": 1715100742.022,
"DeviceLastModifiedDate": 1723233651.167,
"DeviceLastAuthenticatedDate": 1715100742.0
}
}
Дополнительную информацию см. в разделе Работа с устройствами пользователей в вашем пуле пользователей в Руководстве разработчика Amazon Cognito.
Вывод
Устройство -> (структура)
Подробности запрошенного устройства. Включает информацию об устройстве, даты последнего доступа и создания, а также ключ устройства.
DeviceKey -> (строка)
us-west-2_EXAMPLE-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.DeviceAttributes -> (список)
Метаданные об устройстве пользователя, например имя и IP-адрес последнего источника доступа.
(структура)
Имя и значение атрибута пользователя.
Name -> (строка)
Value -> (строка)
DeviceCreateDate -> (временная метка)
Date.DeviceLastModifiedDate -> (временная метка)
Date.DeviceLastAuthenticatedDate -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.