Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

admin-list-devices

Описание

Отображает зарегистрированные устройства пользователя. Запоминаемые устройства используются в службах аутентификации, где вы предлагаете опцию «Запомнить меня» для пользователей, которым вы хотите разрешить вход без MFA с доверенного устройства. Пользователи могут обойти MFA, пока ваше приложение выполняет аутентификацию SRP устройства на стороне сервера. Для получения дополнительной информации см. Работа с устройствами.

Примечание

Amazon Cognito оценивает политики управления идентификацией и доступом (IAM) в запросах для данной операции API. Для этой операции вы должны использовать учетные данные IAM для авторизации запросов и предоставить себе соответствующее разрешение IAM в политике.

Узнать больше
  • Подписание запросов к API Amazon Web Services
  • Использование API пулов пользователей Amazon Cognito и конечных точек пулов пользователей

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

Синтаксис

  admin-list-devices
--user-pool-id <value>
--username <value>
[--limit <value>]
[--pagination-token <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.

--limit (целое число)

Максимальное количество устройств, которое вы хотите, чтобы Amazon Cognito вернул в ответе.

--pagination-token (строка)

Данная операция API возвращает ограниченное количество результатов. Маркер пагинации — это идентификатор, который вы можете предоставить в дополнительном запросе API с теми же параметрами. При включении маркера пагинации Amazon Cognito возвращает следующий набор элементов после текущего списка. Последующие запросы возвращают новый маркер пагинации. Используя этот маркер, вы можете пролистать весь список элементов.

--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-list-devices примере отображаются устройства для пользователя diego.

aws cognito-idp admin-list-devices \
    --user-pool-id us-west-2_EXAMPLE \
    --username diego \
    --limit 1

Вывод:

{
    "Devices": [
        {
            "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.

Вывод

Устройства -> (список)

Массив устройств и их информации. Каждый возвращаемый элемент включает информацию о устройстве, даты последнего доступа и создания, а также ключ устройства.

(структура)

Информация об устройстве пользователя, которое он зарегистрировал для аутентификации SRP устройства в вашем приложении. Для получения дополнительной информации см. Работа с устройствами пользователей в вашем пуле пользователей.

DeviceKey -> (строка)

Ключ устройства, например, us-west-2_EXAMPLE-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

DeviceAttributes -> (список)

Метаданные об устройстве пользователя, такие как имя и последний IP-адрес источника доступа.

(структура)

Имя и значение атрибута пользователя.

Name -> (строка)

Имя атрибута.

Value -> (строка)

Значение атрибута.

DeviceCreateDate -> (временная метка)

Дата и время создания элемента. Amazon Cognito возвращает эту временную метку в формате эпохи Unix. Ваш SDK может отобразить вывод в удобочитаемом формате, таком как ISO 8601, или объекте Java Date.

DeviceLastModifiedDate -> (временная метка)

Дата и время изменения элемента. Amazon Cognito возвращает эту временную метку в формате эпохи Unix. Ваш SDK может отобразить вывод в удобочитаемом формате, таком как ISO 8601, или объекте Java Date.

DeviceLastAuthenticatedDate -> (временная метка)

Дата последнего входа пользователя с данным устройством.

PaginationToken -> (строка)

Идентификатор, возвращенный Amazon Cognito в предыдущем запросе для этой операции. При включении маркера пагинации в ваш запрос Amazon Cognito возвращает следующий набор элементов в списке. Используя этот маркер, вы можете пролистать весь список элементов.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API