Spec-Zone.ru › AWS CLI v2

[ aws . devicefarm ]

stop-run

Описание

Инициирует запрос на остановку текущего выполнения теста. AWS Device Farm немедленно останавливает выполнение на устройствах, где тесты еще не начались. За эти устройства вы не оплачиваете. На устройствах, где выполнение тестов уже началось, тесты настройки (setup suite) и завершения (teardown suite) выполняются до завершения на этих устройствах. Вы оплачиваете за настройку, завершение и любые тесты, которые были в процессе или уже завершены.

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

Синтаксис

  stop-run
--arn <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]

Параметры

--arn (строка)

Представляет собой Amazon Resource Name (ARN) выполнения 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
  • 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 для вывода.

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

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

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

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

Вывод

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

Запущенный процесс, который был остановлен.

arn -> (строка)

ARN процесса.

name -> (строка)

Имя процесса.

type -> (строка)

Тип процесса.

Должно быть одним из следующих значений:

  • BUILTIN_FUZZ
  • APPIUM_JAVA_JUNIT
  • APPIUM_JAVA_TESTNG
  • APPIUM_PYTHON
  • APPIUM_NODE
  • APPIUM_RUBY
  • APPIUM_WEB_JAVA_JUNIT
  • APPIUM_WEB_JAVA_TESTNG
  • APPIUM_WEB_PYTHON
  • APPIUM_WEB_NODE
  • APPIUM_WEB_RUBY
  • INSTRUMENTATION
  • XCTEST
  • XCTEST_UI

platform -> (строка)

Платформа процесса.

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

  • ANDROID
  • IOS

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

Дата и время создания процесса.

status -> (строка)

Статус процесса.

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

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

result -> (строка)

Результат процесса.

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

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

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

Время начала процесса.

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

Время остановки процесса.

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

Счётчики результатов процесса.

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

Общее количество сущностей.

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

Количество пройденных сущностей.

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

Количество завершённых с ошибкой сущностей.

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

Количество сущностей с предупреждениями.

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

Количество сущностей с ошибками.

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

Количество остановленных сущностей.

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

Количество пропущенных сущностей.

message -> (строка)

Сообщение о результате процесса.

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

Общее количество задач для процесса.

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

Общее количество завершённых задач.

billingMethod -> (строка)

Определяет метод оплаты для выполнения тестирования: metered или unmetered. Если параметр не указан, используется значение по умолчанию metered.

Примечание

Если у вас есть нелимитированные слоты устройств, необходимо установить это значение на unmetered, чтобы использовать их. В противном случае процесс учитывается в почасовой оплате.

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

Представляет общее (лимитированное или нелимитированное) время, потраченное на выполнение тестирования.

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

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

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

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

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

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

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

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

arn -> (строка)

Amazon Resource Name (ARN) профиля сети.

name -> (строка)

Название профиля сети.

description -> (строка)

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

type -> (строка)

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

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

Скорость пропускной способности по восходящему каналу в битах в секунду, целое число от 0 до 104857600.

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

Скорость пропускной способности по нисходящему каналу в битах в секунду, целое число от 0 до 104857600.

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

Задержка для всех пакетов до назначения в миллисекундах, целое число от 0 до 2000.

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

Задержка для всех пакетов до назначения в миллисекундах, целое число от 0 до 2000.

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

Изменение времени задержки полученных пакетов в миллисекундах, целое число от 0 до 2000.

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

Изменение времени задержки полученных пакетов в миллисекундах, целое число от 0 до 2000.

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

Доля передаваемых пакетов, которые не доходят до адресата от 0 до 100 процентов.

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

Доля полученных пакетов, которые не доходят до адресата от 0 до 100 процентов.

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

Настроенный прокси-сервер устройств для процесса.

host -> (строка)

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

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

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

parsingResultUrl -> (строка)

Только для чтения URL для объекта в ведре S3, где можно получить результаты обработки пакета тестов. Если пакет тестов не обрабатывается, причина, по которой он не обрабатывается, отображается в файле, на который указывает этот URL.

resultCode -> (строка)

Вспомогательное поле для поля result. Устанавливается только если result является SKIPPED. PARSING_FAILED, если результат пропущен из-за ошибки обработки пакета тестов.

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

Для тестов fuzz это семя для случайного выбора последовательности действий UI-теста fuzz. Использование одного и того же значения семени между тестами обеспечивает идентичные последовательности событий.

appUpload -> (строка)

Приложение для загрузки или которое было загружено.

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

Для тестов fuzz это количество событий, от 1 до 10000, которые должен выполнить UI-тест fuzz.

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

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

devicePoolArn -> (строка)

ARN пула устройств для процесса.

locale -> (строка)

Информация о используемом для процесса регионе.

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

Информация о состояниях радиосвязи для процесса.

wifi -> (булево)

Истинно, если Wi-Fi включен в начале теста. Иначе — ложно.

bluetooth -> (булево)

Истинно, если Bluetooth включен в начале теста. Иначе — ложно.

nfc -> (булево)

Истинно, если NFC включен в начале теста. Иначе — ложно.

gps -> (булево)

Истинно, если GPS включен в начале теста. Иначе — ложно.

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

Информация о расположении, используемом для процесса.

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

Широта.

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

Долгота.

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

Выходные данные CustomerArtifactPaths для процесса тестирования.

iosPaths -> (список)

Список путей на устройстве iOS, разделённых запятыми, откуда извлекаются артефакты, сгенерированные тестами клиента.

(строка)

androidPaths -> (список)

Список путей на Android-устройстве, разделённых запятыми, откуда извлекаются артефакты, сгенерированные тестами клиента.

(строка)

deviceHostPaths -> (список)

Список путей в среде выполнения теста, разделённых запятыми, откуда извлекаются артефакты, сгенерированные тестами клиента.

(строка)

webUrl -> (строка)

URL консоли Device Farm для записи процесса.

skipAppResign -> (булево)

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

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

testSpecArn -> (строка)

ARN YAML-форматированного описания теста для процесса.

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

Результаты фильтра устройств, используемого для выбора устройств для выполнения теста.

filters -> (список)

Фильтры в результате выбора устройства.

(структура)

Представляет фильтр устройств, используемый для выбора набора устройств, которые должны быть включены в запуск теста. Эта структура данных передаётся в качестве параметра 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.

(строка)

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

Количество устройств, соответствующих критериям выбора фильтра устройств.

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

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

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

ВPC-группы безопасности и подсети, прикреплённые к проекту.

securityGroupIds -> (список)

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

(строка)

subnetIds -> (список)

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

(строка)

vpcId -> (строка)

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

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

Spec-Zone.ru

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