start-run

Описание

Запускает новый запуск или дублирует существующий запуск.

Для нового запуска укажите уникальный requestId, workflowId, и ARN роли. Если вы используете статическое хранилище запусков (по умолчанию), укажите необходимую storageCapacity.

Для дублирования запуска укажите уникальный requestId, runID запуска для дублирования и ARN роли.

Дополнительную информацию об необязательных параметрах в запросе StartRun см. в руководстве пользователя Amazon Web Services HealthOmics.

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

start-run использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая запись не поддерживает типы документов.

Синтаксис

  start-run
[--workflow-id <value>]
[--workflow-type <value>]
[--run-id <value>]
--role-arn <value>
[--name <value>]
[--cache-id <value>]
[--cache-behavior <value>]
[--run-group-id <value>]
[--priority <value>]
[--parameters <value>]
[--storage-capacity <value>]
[--output-uri <value>]
[--log-level <value>]
[--tags <value>]
[--request-id <value>]
[--retention-mode <value>]
[--storage-type <value>]
[--workflow-owner-id <value>]
[--workflow-version-name <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]

Опции

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

--workflow-type (строка)

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

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

--name (строка)

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

--cache-behavior (строка)

--run-group-id (строка)

--priority (целое число)

--parameters (документ)

Синтаксис JSON:

{...}

--storage-capacity (целое число)

--output-uri (строка)

--log-level (строка)

--tags (массив)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

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

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

--storage-type (строка)

--workflow-owner-id (строка)

--workflow-version-name (строка)

--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
• таблица
• 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.

Примеры

Запуск рабочей области

Следующий start-run пример запускает рабочую область с ID 1234567.

aws omics start-run \
    --workflow-id 1234567 \
    --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \
    --name 'cram-to-bam' \
    --output-uri s3://omics-artifacts-01d6xmpl4e72dd32/workflow-output/ \
    --run-group-id 1234567 \
    --priority 1 \
    --storage-capacity 10 \
    --log-level ALL \
    --parameters file://workflow-inputs.json

workflow-inputs.json - это JSON-документ со следующим содержимым.

{
    "sample_name": "NA12878",
    "input_cram": "s3://omics-artifacts-01d6xmpl4e72dd32/NA12878.cram",
    "ref_dict": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict",
    "ref_fasta": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta",
    "ref_fasta_index": "omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta.fai"
}

Вывод:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567",
    "id": "1234567",
    "status": "PENDING",
    "tags": {}
}

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

Загрузка исходных файлов из Amazon Omics

Вы также можете загрузить исходные файлы из хранилища Amazon Omics, используя специфичные для сервиса URI. В следующем примере файл workflow-inputs.json использует URI Amazon Omics для источников наборов считывания и референцного генома.

{
    "sample_name": "NA12878",
    "input_cram": "omics://123456789012.storage.us-west-2.amazonaws.com/1234567890/readSet/1234567890/source1",
    "ref_dict": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict",
    "ref_fasta": "omics://123456789012.storage.us-west-2.amazonaws.com/1234567890/reference/1234567890",
    "ref_fasta_index": "omics://123456789012.storage.us-west-2.amazonaws.com/1234567890/reference/1234567890/index"
}

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

Вывод

arn -> (строка)

id -> (строка)

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

теги -> (массив)

uuid -> (строка)

runOutputUri -> (строка)