Spec-Zone.ru › AWS CLI v2

[ aws . devicefarm ]

list-devices

Описание

Получает информацию об уникальных типах устройств.

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

list-devices является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: devices

Синтаксис

  list-devices
[--arn <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--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]

Параметры

--arn (строка)

Amazon Resource Name (ARN) проекта.

--filters (список)

Используется для выбора набора устройств. Фильтр состоит из атрибута, оператора и одного или нескольких значений.

  • Атрибут: Аспект устройства, например, платформа или модель, используемые в качестве критериев отбора в фильтре устройств. Разрешенные значения включают:
    • ARN: Amazon Resource Name (ARN) устройства (например, arn:aws:devicefarm:us-west-2::device:12345Example).
    • PLATFORM: Платформа устройства. Допустимые значения: ANDROID или IOS.
    • OS_VERSION: Версия операционной системы (например, 10.3.2).
    • MODEL: Модель устройства (например, iPad 5th Gen).
    • AVAILABILITY: Текущая доступность устройства. Допустимые значения: AVAILABLE, HIGHLY_AVAILABLE, BUSY или TEMPORARY_NOT_AVAILABLE.
    • FORM_FACTOR: Форм-фактор устройства. Допустимые значения: PHONE или TABLET.
    • MANUFACTURER: Производитель устройства (например, Apple).
    • REMOTE_ACCESS_ENABLED: Включен ли удаленный доступ для устройства. Допустимые значения: TRUE или FALSE.
    • REMOTE_DEBUG_ENABLED: Включена ли удаленная отладка для устройства. Допустимые значения: TRUE или FALSE. Поскольку удаленная отладка больше не поддерживается, этот атрибут игнорируется.
    • INSTANCE_ARN: Amazon Resource Name (ARN) экземпляра устройства.
    • INSTANCE_LABELS: Метка экземпляра устройства.
    • FLEET_TYPE: Тип флота. Допустимые значения: PUBLIC или PRIVATE.
  • Оператор: Оператор фильтра.
    • Оператор EQUALS доступен для всех атрибутов, кроме INSTANCE_LABELS.
    • Оператор CONTAINS доступен для атрибутов INSTANCE_LABELS и MODEL.
    • Операторы IN и NOT_IN доступны для атрибутов ARN, OS_VERSION, MODEL, MANUFACTURER и INSTANCE_ARN.
    • Операторы LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS и GREATER_THAN_OR_EQUALS также доступны для атрибута OS_VERSION.
  • Значения: Массив из одного или нескольких значений фильтра.
    • Операторы IN и NOT_IN принимают массив значений, содержащий один или несколько элементов.
    • Другие операторы требуют массива с одним элементом.
    • В запросе атрибут AVAILABILITY принимает следующие значения: AVAILABLE, HIGHLY_AVAILABLE, BUSY или TEMPORARY_NOT_AVAILABLE.

(структура)

Представляет фильтр устройств, используемый для выбора набора устройств, которые будут включены в тест. Эта структура данных передается в качестве параметра deviceSelectionConfiguration к ScheduleRun . Пример синтаксиса JSON-запроса см. в разделе ScheduleRun .

Он также передается в качестве параметра filters к ListDevices . Пример синтаксиса JSON-запроса см. в разделе ListDevices .

attribute -> (строка)

Аспект устройства, например, платформа или модель, используемые в качестве критериев отбора в фильтре устройств.

Поддерживаемые операторы для каждого атрибута приведены в следующем списке.

ARN

Amazon Resource Name (ARN) устройства (например, arn:aws:devicefarm:us-west-2::device:12345Example).

Поддерживаемые операторы: EQUALS, IN, NOT_IN

PLATFORM

Платформа устройства. Допустимые значения: ANDROID или IOS.

Поддерживаемые операторы: EQUALS

OS_VERSION

Версия операционной системы (например, 10.3.2).

Поддерживаемые операторы: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

Модель устройства (например, iPad 5th Gen).

Поддерживаемые операторы: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

Текущая доступность устройства. Допустимые значения: AVAILABLE, HIGHLY_AVAILABLE, BUSY или TEMPORARY_NOT_AVAILABLE.

Поддерживаемые операторы: EQUALS

FORM_FACTOR

Форм-фактор устройства. Допустимые значения: PHONE или TABLET.

Поддерживаемые операторы: EQUALS

MANUFACTURER

Производитель устройства (например, Apple).

Поддерживаемые операторы: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Включен ли удаленный доступ для устройства. Допустимые значения: TRUE или FALSE.

Поддерживаемые операторы: EQUALS

REMOTE_DEBUG_ENABLED

Включена ли удаленная отладка для устройства. Допустимые значения: TRUE или FALSE.

Поддерживаемые операторы: EQUALS

Поскольку удаленная отладка больше не поддерживается, этот фильтр игнорируется.

INSTANCE_ARN

Amazon Resource Name (ARN) экземпляра устройства.

Поддерживаемые операторы: EQUALS, IN, NOT_IN

INSTANCE_LABELS

Метка экземпляра устройства.

Поддерживаемые операторы: CONTAINS

FLEET_TYPE

Тип флота. Допустимые значения: PUBLIC или PRIVATE.

Поддерживаемые операторы: EQUALS

operator -> (строка)

Указывает, как Device Farm сравнивает атрибут фильтра со значением. См. описания атрибутов.

values -> (список)

Массив из одного или нескольких значений фильтра, используемых в фильтре устройств.

Значения оператора
  • Операторы IN и NOT_IN могут принимать массив значений, содержащий более одного элемента.
  • Другие операторы требуют массива с одним элементом.
Значения атрибутов
  • Атрибут PLATFORM может быть установлен в ANDROID или IOS.
  • Атрибут AVAILABILITY может быть установлен в AVAILABLE, HIGHLY_AVAILABLE, BUSY или TEMPORARY_NOT_AVAILABLE.
  • Атрибут FORM_FACTOR может быть установлен в PHONE или TABLET.
  • Атрибут FLEET_TYPE может быть установлен в PUBLIC или PRIVATE.

(строка)

Сокращенный синтаксис:

attribute=string,operator=string,values=string,string ...

Синтаксис JSON:

[
  {
    "attribute": "ARN"|"PLATFORM"|"OS_VERSION"|"MODEL"|"AVAILABILITY"|"FORM_FACTOR"|"MANUFACTURER"|"REMOTE_ACCESS_ENABLED"|"REMOTE_DEBUG_ENABLED"|"INSTANCE_ARN"|"INSTANCE_LABELS"|"FLEET_TYPE",
    "operator": "EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"IN"|"NOT_IN"|"CONTAINS",
    "values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, указанному в --generate-cli-skeleton. Если на командной строке заданы другие аргументы, эти значения переопределят значения, заданные через JSON. Невозможно передавать произвольные двоичные данные с помощью значения JSON, поскольку строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания точки начала постраничной обработки. Это значение NextToken из ранее обрезаемого ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено без значения или со значением input, выводит образец JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, выведет образец ввода YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернет образец выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладочную запись журналов.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Используемый регион. Переопределяет настройки из конфигурации/окружения.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическую запрос параметров ввода CLI.

Вывод

devices -> (list)

Информация об устройствах.

(structure)

Представляет тип устройства, на котором тестируется приложение.

arn -> (string)

ARN устройства.

name -> (string)

Имя отображения устройства.

manufacturer -> (string)

Имя производителя устройства.

model -> (string)

Модель устройства.

modelId -> (string)

Идентификатор модели устройства.

formFactor -> (string)

Форм-фактор устройства.

Допустимые значения включают:

  • PHONE
  • TABLET

platform -> (string)

Платформа устройства.

Допустимые значения включают:

  • ANDROID
  • IOS

os -> (string)

Тип операционной системы устройства.

cpu -> (structure)

Информация о процессоре устройства.

frequency -> (string)

Частота процессора.

architecture -> (string)

Архитектура процессора (например, x86 или ARM).

clock -> (double)

Частота процессора устройства в герцах (Hz). Например, процессор с частотой 1,2 ГГц отображается как 1200000000.

resolution -> (structure)

Разрешение устройства.

width -> (integer)

Ширина разрешения экрана в пикселях.

height -> (integer)

Высота разрешения экрана в пикселях.

heapSize -> (long)

Размер кучи устройства в байтах.

memory -> (long)

Общий объем памяти устройства в байтах.

image -> (string)

Имя изображения устройства.

carrier -> (string)

Оператор связи устройства.

radio -> (string)

Радиомодуль устройства.

remoteAccessEnabled -> (boolean)

Указывает, включен ли удаленный доступ для указанного устройства.

remoteDebugEnabled -> (boolean)

Этот флаг устанавливается в true, если удаленная отладка включена для устройства.

Удаленная отладка больше не поддерживается.

fleetType -> (string)

Тип флота, к которому принадлежит это устройство. Возможные значения — PRIVATE и PUBLIC.

fleetName -> (string)

Имя флота, к которому принадлежит это устройство.

instances -> (list)

Экземпляры, принадлежащие этому устройству.

(structure)

Представляет экземпляр устройства.

arn -> (string)

Amazon Resource Name (ARN) экземпляра устройства.

deviceArn -> (string)

ARN устройства.

labels -> (list)

Массив строк, описывающих экземпляр устройства.

(string)

status -> (string)

Состояние экземпляра устройства. Допустимые значения перечислены здесь.

udid -> (string)

Уникальный идентификатор устройства для экземпляра.

instanceProfile -> (structure)

Объект, содержащий информацию о профиле экземпляра.

arn -> (string)

Amazon Resource Name (ARN) профиля экземпляра.

packageCleanup -> (boolean)

При установке в значение true, Device Farm удаляет пакеты приложений после выполнения теста. Значение по умолчанию — false для частных устройств.

excludeAppPackagesFromCleanup -> (list)

Массив строк, содержащий список пакетов приложений, которые не должны быть удалены с устройства после завершения выполнения теста.

Список пакетов учитывается только при установке packageCleanup в значение true.

(string)

rebootAfterUse -> (boolean)

При установке в значение true, Device Farm перезагружает экземпляр после выполнения теста. Значение по умолчанию — true.

name -> (string)

Имя профиля экземпляра.

description -> (string)

Описание профиля экземпляра.

availability -> (string)

Указывает вероятность того, что устройство будет доступно для выполнения теста. В настоящее время доступно в методах API ListDevices и GetDevice.

nextToken -> (string)

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

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

Spec-Zone.ru

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