[ aws . comprehendmedical ]
описание-задания-обнаружения-сущностей-v2-задание
Описание
Получает свойства, связанные с заданием обнаружения медицинских сущностей. Используйте эту операцию для получения статуса задания обнаружения.
См. также: Документация API AWS
Синопсис
describe-entities-detection-v2-job
--job-id <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]
Параметры
--job-id (строка)
StartEntitiesDetectionV2Job возвращает этот идентификатор в своём ответе.--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 (строка)
Область для использования. Переопределяет настройки конфигурации/среды.
--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.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.
Для описания задания обнаружения сущностей
Следующий describe-entities-detection-v2-job пример отображает свойства асинхронного задания обнаружения сущностей.
aws comprehendmedical describe-entities-detection-v2-job \
--job-id "ab9887877365fe70299089371c043b96"
Вывод:
{
"ComprehendMedicalAsyncJobProperties": {
"JobId": "ab9887877365fe70299089371c043b96",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-03-18T21:20:15.614000+00:00",
"EndTime": "2020-03-18T21:27:07.350000+00:00",
"ExpirationTime": "2020-07-16T21:20:15+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": ""
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "867139942017-EntitiesDetection-ab9887877365fe70299089371c043b96/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "DetectEntitiesModelV20190930"
}
}
Дополнительную информацию см. в разделе «API пакетных операций» в руководстве разработчика Amazon Comprehend Medical.
Вывод
ComprehendMedicalAsyncJobProperties -> (структура)
Объект, содержащий свойства, связанные с заданием обнаружения.
JobId -> (строка)
JobName -> (строка)
JobStatus -> (строка)
FAILED , поле Message отображает причину ошибки.Message -> (строка)
SubmitTime -> (метка времени)
EndTime -> (метка времени)
ExpirationTime -> (метка времени)
ListEntitiesDetectionV2Job или ListPHIDetectionJobs.InputDataConfig -> (структура)
Конфигурация входных данных, которую вы предоставили при создании задания обнаружения.
S3Bucket -> (строка)
S3Key -> (строка)
OutputDataConfig -> (структура)
Конфигурация выходных данных, которую вы предоставили при создании задания обнаружения.
S3Bucket -> (строка)
OutputDataConfig с асинхронными операциями, вы указываете расположение Amazon S3, куда вы хотите записать выходные данные. URI должен находиться в той же области, что и вызываемая API-точка. Расположение используется в качестве префикса для фактического расположения вывода.S3Key -> (строка)
LanguageCode -> (строка)
DataAccessRoleArn -> (строка)
ManifestFilePath -> (строка)
KMSKey -> (строка)
ModelVersion -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.