Spec-Zone.ru › AWS CLI v2

[ aws . devicefarm ]

create-remote-access-session

Описание

Указывает и запускает сеанс удалённого доступа.

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

Синтаксис

  create-remote-access-session
--project-arn <value>
--device-arn <value>
[--instance-arn <value>]
[--ssh-public-key <value>]
[--remote-debug-enabled | --no-remote-debug-enabled]
[--remote-record-enabled | --no-remote-record-enabled]
[--remote-record-app-arn <value>]
[--name <value>]
[--client-id <value>]
[--configuration <value>]
[--interaction-mode <value>]
[--skip-app-resign | --no-skip-app-resign]
[--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]

Параметры

--project-arn (строка)

Amazon Resource Name (ARN) проекта, для которого необходимо создать сеанс удалённого доступа.

--device-arn (строка)

ARN устройства, для которого необходимо создать сеанс удалённого доступа.

--instance-arn (строка)

Amazon Resource Name (ARN) экземпляра устройства, для которого необходимо создать сеанс удалённого доступа.

--ssh-public-key (строка)

Игнорируется. Открытый ключ пары ключей ssh, который необходимо использовать для подключения к удалённым устройствам в сеансе удалённой отладки. Этот ключ требуется только если remoteDebugEnabled установлено в true .

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

--remote-debug-enabled | --no-remote-debug-enabled (булево)

Установите в true, если хотите получить удалённый доступ к устройствам для отладки в сеансе удалённого доступа.

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

--remote-record-enabled | --no-remote-record-enabled (булево)

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

--remote-record-app-arn (строка)

Amazon Resource Name (ARN) приложения, которое должно быть записано в сеансе удалённого доступа.

--name (строка)

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

--client-id (строка)

Уникальный идентификатор клиента. Если вам нужен доступ к нескольким устройствам на одном клиенте, вы должны передать одно и то же значение clientId в каждом вызове CreateRemoteAccessSession. Этот идентификатор требуется только если remoteDebugEnabled установлено в true.

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

--configuration (структура)

Конфигурационная информация для запроса сеанса удалённого доступа.

billingMethod -> (строка)

Метод оплаты за сеанс удалённого доступа.

vpceConfigurationArns -> (список)

Массив ARNs, включённых в конфигурацию VPC-туннеля.

(строка)

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

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

host -> (строка)

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

port -> (целое число)

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

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

billingMethod=string,vpceConfigurationArns=string,string,deviceProxy={host=string,port=integer}

Синтаксис JSON:

{
  "billingMethod": "METERED"|"UNMETERED",
  "vpceConfigurationArns": ["string", ...],
  "deviceProxy": {
    "host": "string",
    "port": integer
  }
}

--interaction-mode (строка)

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

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

Возможные значения:

  • INTERACTIVE
  • NO_VIDEO
  • VIDEO_ONLY

--skip-app-resign | --no-skip-app-resign (булево)

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

Дополнительную информацию о том, как Device Farm изменяет ваши загрузки во время тестов, см. в разделе «Изменяет ли Device Farm мои приложения?».

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

Регион для использования. Переопределяет настройки config/env.

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (булево)

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

--ca-bundle (строка)

Набор сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

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

Вывод

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

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

arn -> (строка)

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

ID модели устройства.

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 Resource Name (ARN) инстанса устройства.

deviceArn -> (строка)

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

labels -> (список)

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

(строка)

status -> (строка)

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

udid -> (строка)

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

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

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

arn -> (строка)

Amazon Resource Name (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 переподписывает ваши приложения, см. в разделе «Изменяете ли вы моё приложение?» в «Часто задаваемых вопросах AWS Device Farm».

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

Включённые группы безопасности VPC и подсети проекта.

securityGroupIds -> (список)

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

(строка)

subnetIds -> (список)

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

(строка)

vpcId -> (строка)

ID Amazon VPC.

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

Конфигурация прокси-сервера устройства для сеанса удалённого доступа.

host -> (строка)

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

port -> (целое число)

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

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

Spec-Zone.ru

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