Spec-Zone.ru › AWS CLI v2

[ aws . devicefarm ]

list-remote-access-sessions

Описание

Возвращает список всех активных сессий удаленного доступа.

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

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

Синтаксис

  list-remote-access-sessions
--arn <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) проекта, о котором запрашивается информация.

--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 (логическое значение)

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

--endpoint-url (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

remoteAccessSessions -> (список)

Контейнер, представляющий метаданные службы о каждой сессии удалённого доступа, которую вы запрашиваете.

(структура)

Представляет информацию о сессии удалённого доступа.

arn -> (строка)

Идентификатор ресурса Amazon (ARN) сессии удалённого доступа.

name -> (строка)

Имя сессии удалённого доступа.

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

Дата и время создания сессии удалённого доступа.

status -> (строка)

Статус сессии удалённого доступа. Может принимать следующие значения:

  • PENDING.
  • PENDING_CONCURRENCY.
  • PENDING_DEVICE.
  • PROCESSING.
  • SCHEDULING.
  • PREPARING.
  • RUNNING.
  • COMPLETED.
  • STOPPING.

result -> (строка)

Результат сессии удалённого доступа. Может принимать следующие значения:

  • PENDING.
  • PASSED.
  • WARNED.
  • FAILED.
  • SKIPPED.
  • ERRORED.
  • STOPPED.

message -> (строка)

Сообщение о сессии удалённого доступа.

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

Дата и время начала сессии удалённого доступа.

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

Дата и время остановки сессии удалённого доступа.

device -> (структура)

Устройство (телефон или планшет), используемое в сессии удалённого доступа.

arn -> (строка)

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

name -> (строка)

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

manufacturer -> (строка)

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

model -> (строка)

Название модели устройства.

modelId -> (строка)

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

formFactor -> (строка)

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

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

  • PHONE
  • TABLET

platform -> (строка)

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

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

  • ANDROID
  • IOS

os -> (строка)

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

cpu -> (структура)

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

frequency -> (строка)

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

architecture -> (строка)

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

clock -> (двойное)

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

resolution -> (структура)

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

width -> (целое)

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

height -> (целое)

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

heapSize -> (длинное)

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

memory -> (длинное)

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

image -> (строка)

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

carrier -> (строка)

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

radio -> (строка)

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

remoteAccessEnabled -> (булево)

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

remoteDebugEnabled -> (булево)

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

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

fleetType -> (строка)

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

fleetName -> (строка)

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

instances -> (список)

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

(структура)

Представляет инстанс устройства.

arn -> (строка)

Идентификатор ресурса Amazon (ARN) инстанса устройства.

deviceArn -> (строка)

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

labels -> (список)

Массив строк, описывающих инстанс устройства.

(строка)

status -> (строка)

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

udid -> (строка)

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

instanceProfile -> (структура)

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

arn -> (строка)

Идентификатор ресурса Amazon (ARN) профиля инстанса.

packageCleanup -> (булево)

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

excludeAppPackagesFromCleanup -> (список)

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

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

(строка)

rebootAfterUse -> (булево)

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

name -> (строка)

Имя профиля инстанса.

description -> (строка)

Описание профиля инстанса.

availability -> (строка)

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

instanceArn -> (строка)

ARN инстанса.

remoteDebugEnabled -> (булево)

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

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

remoteRecordEnabled -> (булево)

Этот флаг установлен в true, если удалённая запись включена для сессии удалённого доступа.

remoteRecordAppArn -> (строка)

ARN приложения, подлежащего записи в сессии удалённого доступа.

hostAddress -> (строка)

IP-адрес хоста EC2, к которому необходимо подключиться для удалённой отладки устройств. Возвращается только в том случае, если удалённая отладка включена для сессии удалённого доступа.

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

clientId -> (строка)

Уникальный идентификатор вашего клиента для сессии удалённого доступа. Возвращается только в том случае, если удалённая отладка включена для сессии удалённого доступа.

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

billingMethod -> (строка)

Способ оплаты сессии удалённого доступа. Возможные значения включают METERED или UNMETERED. Дополнительную информацию о устройствах с оплатой по факту использования см. в терминологии AWS Device Farm.

deviceMinutes -> (структура)

Количество минут использования устройства в сессии удалённого доступа (включая минуты настройки и завершения).

total -> (двойное)

Если указано, представляет общее количество минут, используемых ресурсом для выполнения тестов.

metered -> (двойное)

Если указано, представляет только сумму израсходованных по оплате минут, используемых ресурсом для выполнения тестов.

unmetered -> (двойное)

Если указано, представляет только сумму израсходованных не по оплате минут, используемых ресурсом для выполнения тестов.

endpoint -> (строка)

Конечная точка для сессии удалённого доступа.

deviceUdid -> (строка)

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

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

interactionMode -> (строка)

Режим взаимодействия сессии удалённого доступа. Допустимые значения:

  • INTERACTIVE: Вы можете взаимодействовать с устройством iOS, просматривая, касаясь и вращая экран. В этом режиме нельзя запускать тесты на основе фреймворка XCUITest.
  • NO_VIDEO: Вы подключены к устройству, но не можете взаимодействовать с ним или просматривать экран. Этот режим обеспечивает самую быструю скорость выполнения тестов. В этом режиме можно запускать тесты на основе фреймворка XCUITest.
  • VIDEO_ONLY: Вы можете просматривать экран, но не можете касаться или вращать его. В этом режиме можно запускать тесты на основе фреймворка XCUITest и наблюдать за экраном.

skipAppResign -> (булево)

Если установлено в true, для частных устройств Device Farm не переподписывает ваше приложение. Для общедоступных устройств Device Farm всегда переподписывает ваши приложения.

Дополнительную информацию о том, как Device Farm переподписывает ваши приложения, см. в разделе «Модифицирует ли Device Farm моё приложение?» в часто задаваемых вопросах AWS Device Farm.

vpcConfig -> (структура)

Настройки безопасности VPC и подсети, присоединённые к проекту.

securityGroupIds -> (список)

Массив из одного или нескольких идентификаторов групп безопасности в вашей сети Amazon VPC.

(строка)

subnetIds -> (список)

Массив из одного или нескольких идентификаторов подсетей в вашей сети Amazon VPC.

(строка)

vpcId -> (строка)

Идентификатор сети Amazon VPC.

deviceProxy -> (структура)

Прокси устройства, настроенный для сессии удалённого доступа.

host -> (строка)

Имя хоста или IPv4-адрес прокси.

port -> (целое)

Номер порта, на котором прокси http/s прослушивает соединения.

nextToken -> (строка)

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

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

Spec-Zone.ru

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