Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

list-devices

Описание

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

Авторизуйте этот запрос с помощью маркера доступа пользователя, авторизованного на устройстве. Он должен включать область aws.cognito.signin.user.admin .

Примечание

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

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

Синтаксис

  list-devices
--access-token <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]

Параметры

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

Действительный маркер доступа, выданный Amazon Cognito текущему пользователю, авторизованному на устройстве. Должен включать утверждение о области для aws.cognito.signin.user.admin .

--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 (строка)

Переопределить адрес по умолчанию команды заданным адресом.

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

Чтобы получить список устройств пользователя

Следующий list-devices пример отображает список устройств, зарегистрированных текущим пользователем.

aws cognito-idp list-devices \
    --access-token eyJra456defEXAMPLE

Вывод:

{
    "Devices": [
        {
            "DeviceAttributes": [
                {
                    "Name": "device_status",
                    "Value": "valid"
                },
                {
                    "Name": "device_name",
                    "Value": "Dart-device"
                },
                {
                    "Name": "last_ip_used",
                    "Value": "192.0.2.1"
                }
            ],
            "DeviceCreateDate": 1715100742.022,
            "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "DeviceLastAuthenticatedDate": 1715100742.0,
            "DeviceLastModifiedDate": 1723233651.167
        },
        {
            "DeviceAttributes": [
                {
                    "Name": "device_status",
                    "Value": "valid"
                },
                {
                    "Name": "last_ip_used",
                    "Value": "192.0.2.2"
                }
            ],
            "DeviceCreateDate": 1726856147.993,
            "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "DeviceLastAuthenticatedDate": 1726856147.0,
            "DeviceLastModifiedDate": 1726856147.993
        }
    ]
}

Дополнительную информацию см. в разделе Работа с устройствами в Руководстве разработчика Amazon Cognito.

Вывод

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

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

(структура)

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

DeviceKey -> (строка)

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

DeviceAttributes -> (список)

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

(структура)

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

Имя -> (строка)

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

Значение -> (строка)

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

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