Spec-Zone.ru › AWS CLI v2

[ aws . comprehendmedical ]

list-phi-detection-jobs

Описание

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

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

Синтаксис

  list-phi-detection-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
  • 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Для получения списка заданий обнаружения защищенной медицинской информации (PHI)

Следующий list-phi-detection-jobs пример отображает текущие задания обнаружения защищенной медицинской информации (PHI)

aws comprehendmedical list-phi-detection-jobs

Вывод:

{
    "ComprehendMedicalAsyncJobPropertiesList": [
        {
            "JobId": "4750034166536cdb52ffa3295a1b00a3",
            "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-PHIDetection-4750034166536cdb52ffa3295a1b00a3/"
            },
            "LanguageCode": "en",
            "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
            "ModelVersion": "PHIModelV20190903"
        }
    ]
}

Для получения дополнительной информации см. разделы Batch APIs в руководстве разработчика 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