Spec-Zone.ru › AWS CLI v2

[ aws . comprehendmedical ]

list-entities-detection-v2-jobs

Описание

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

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

Синтаксис

  list-entities-detection-v2-jobs
[--filter <value>]
[--next-token <value>]
[--max-results <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]

Параметры

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

Фильтры возвращаемых заданий. Можно фильтровать задания по их имени, статусу или дате и времени их отправки. Можно задать только один фильтр за раз.

JobName -> (строка)

Фильтровать по имени задания.

JobStatus -> (строка)

Фильтровать список заданий по статусу. Возвращает только задания с указанным статусом.

SubmitTimeBefore -> (метка времени)

Фильтровать список заданий по времени отправки задания на обработку. Возвращает только задания, отправленные до указанного времени. Задания возвращаются в порядке возрастания, от старейшего к новейшему.

SubmitTimeAfter -> (метка времени)

Фильтровать список заданий по времени отправки задания на обработку. Возвращает только задания, отправленные после указанного времени. Задания возвращаются в порядке убывания, от новейшего к старейшему.

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

JobName=string,JobStatus=string,SubmitTimeBefore=timestamp,SubmitTimeAfter=timestamp

Синтаксис JSON:

{
  "JobName": "string",
  "JobStatus": "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"PARTIAL_SUCCESS"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
  "SubmitTimeBefore": timestamp,
  "SubmitTimeAfter": timestamp
}

--next-token (строка)

Идентифицирует следующую страницу результатов для возврата.

--max-results (целое число)

Максимальное количество результатов, возвращаемых на каждой странице. По умолчанию 100.

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

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

Чтобы перечислить задания обнаружения сущностей

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

aws comprehendmedical list-entities-detection-v2-jobs

Вывод:

{
    "ComprehendMedicalAsyncJobPropertiesList": [
        {
            "JobId": "ab9887877365fe70299089371c043b96",
            "JobStatus": "COMPLETED",
            "SubmitTime": "2020-03-19T20:38:37.594000+00:00",
            "EndTime": "2020-03-19T20:45:07.894000+00:00",
            "ExpirationTime": "2020-07-17T20:38:37+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.

Вывод

ComprehendMedicalAsyncJobPropertiesList -> (список)

Список, содержащий свойства каждого возвращенного задания.

(структура)

Предоставляет информацию о задании обнаружения.

JobId -> (строка)

Идентификатор, назначенный заданию обнаружения.

JobName -> (строка)

Имя, назначенное вами заданию обнаружения.

JobStatus -> (строка)

Текущий статус задания обнаружения. Если статус FAILED, поле Message показывает причину сбоя.

Message -> (строка)

Описание статуса задания.

SubmitTime -> (метка времени)

Время отправки задания обнаружения на обработку.

EndTime -> (метка времени)

Время завершения задания обнаружения.

ExpirationTime -> (метка времени)

Дата и время удаления метаданных задания с сервера. Файлы вывода в вашем ведре S3 не будут удалены. После удаления метаданных задание больше не будет отображаться в результатах операции ListEntitiesDetectionV2Job или операции ListPHIDetectionJobs.

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

Конфигурация входных данных, указанная вами при создании задания обнаружения.

S3Bucket -> (строка)

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

S3Key -> (строка)

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

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

Конфигурация выходных данных, указанная вами при создании задания обнаружения.

S3Bucket -> (строка)

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

S3Key -> (строка)

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

LanguageCode -> (строка)

Код языка входных документов.

DataAccessRoleArn -> (строка)

Amazon Resource Name (ARN), предоставляющий Amazon Comprehend Medical доступ для чтения к вашим входным данным.

ManifestFilePath -> (строка)

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

KMSKey -> (строка)

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

ModelVersion -> (строка)

Версия модели, используемой для анализа документов. Номер версии выглядит как X.X.X. Вы можете использовать эту информацию для отслеживания модели, используемой для конкретной группы документов.

NextToken -> (строка)

Идентифицирует следующую страницу результатов для возврата.

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

Spec-Zone.ru

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