Spec-Zone.ru › AWS CLI v2

[ aws . comprehendmedical ]

Запуск задачи обнаружения сущностей v2

Описание

Запускает асинхронную задачу обнаружения медицинских сущностей для коллекции документов. Используйте операцию DescribeEntitiesDetectionV2Job для отслеживания статуса задачи.

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

Синтаксис

  start-entities-detection-v2-job
--input-data-config <value>
--output-data-config <value>
--data-access-role-arn <value>
[--job-name <value>]
[--client-request-token <value>]
[--kms-key <value>]
--language-code <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]

Параметры

--input-data-config (структура)

Настройка входных данных, определяющая формат и расположение входных данных для задачи.

S3Bucket -> (строка)

URI S3-ведра, содержащего входные данные. Ведро должно находиться в том же регионе, что и вызываемый API-точкой.

S3Key -> (строка)

Путь к файлам входных данных в S3-ведре.

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

S3Bucket=string,S3Key=string

Синтаксис JSON:

{
  "S3Bucket": "string",
  "S3Key": "string"
}

--output-data-config (структура)

Настройка выходных данных, определяющая место назначения выходных файлов.

S3Bucket -> (строка)

При использовании объекта OutputDataConfig с асинхронными операциями, вы указываете расположение Amazon S3, куда нужно записать выходные данные. URI должен находиться в том же регионе, что и вызываемый API-точкой. Расположение используется в качестве префикса для фактического расположения вывода.

S3Key -> (строка)

Путь к файлам выходных данных в S3-ведре. Amazon Comprehend Medical создаёт выходную директорию, используя ID задачи, чтобы вывод одной задачи не перезаписывал вывод другой.

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

S3Bucket=string,S3Key=string

Синтаксис JSON:

{
  "S3Bucket": "string",
  "S3Key": "string"
}

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

Amazon Resource Name (ARN) роли AWS Identity and Access Management (IAM), предоставляющей Amazon Comprehend Medical доступ для чтения к вашим входным данным. Для получения дополнительной информации см. Разрешения, основанные на роле, необходимые для асинхронных операций.

--job-name (строка)

Идентификатор задачи.

--client-request-token (строка)

Уникальный идентификатор запроса. Если вы не зададите токен запроса клиента, Amazon Comprehend Medical сгенерирует его за вас.

--kms-key (строка)

Ключ AWS Key Management Service для шифрования выходных файлов. Если вы не укажете ключ, файлы будут записаны в открытом виде.

--language-code (строка)

Язык входных документов. Все документы должны быть на одном языке. Amazon Comprehend Medical обрабатывает файлы на английском языке США (en).

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

  • en

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

Использовать определённый профиль из файла credentials.

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

Примеры

Примечание

Для использования следующих примеров, необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

За исключением случаев, явно указанных иначе, все примеры имеют правила цитирования, похожие на Unix-подобные. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. раздел "Использование кавычек со строками" в Руководстве пользователя AWS CLI.

Для запуска задачи обнаружения сущностей

Следующий start-entities-detection-v2-job пример запускает асинхронную задачу обнаружения сущностей.

aws comprehendmedical start-entities-detection-v2-job \
    --input-data-config "S3Bucket=comp-med-input" \
    --output-data-config "S3Bucket=comp-med-output" \
    --data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \
    --language-code en

Вывод:

{
    "JobId": "ab9887877365fe70299089371c043b96"
}

Для получения дополнительной информации, обратитесь к разделу "API пакетной обработки" в Руководстве разработчика Amazon Comprehend Medical.

Вывод

JobId -> (строка)

Идентификатор, сгенерированный для задачи. Для получения статуса задачи используйте этот идентификатор с операцией DescribeEntitiesDetectionV2Job.

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

Spec-Zone.ru

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