[ aws . comprehend ]
list-events-detection-jobs
Описание
Получает список заданий обнаружения событий, которые вы отправили.
См. также: Документацию API AWS
Синтаксис
list-events-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"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
"SubmitTimeBefore": timestamp,
"SubmitTimeAfter": timestamp
}
--next-token (строка)
--max-results (целое число)
--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, которое соответствует двоичному блоку, 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-events-detection-jobs пример перечисляет все асинхронные задания обнаружения событий.
aws comprehend list-events-detection-jobs
Вывод:
{
"EventsDetectionJobPropertiesList": [
{
"JobId": "aa9593f9203e84f3ef032ce18EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:1111222233333:events-detection-job/aa9593f9203e84f3ef032ce18EXAMPLE",
"JobName": "events_job_1",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-12T19:14:57.751000+00:00",
"EndTime": "2023-06-12T19:21:04.962000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-source-bucket/EventsData/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/1111222233333-EVENTS-aa9593f9203e84f3ef032ce18EXAMPLE/output/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::1111222233333:role/service-role/AmazonComprehendServiceRole-example-role",
"TargetEventTypes": [
"BANKRUPTCY",
"EMPLOYMENT",
"CORPORATE_ACQUISITION",
"CORPORATE_MERGER",
"INVESTMENT_GENERAL"
]
},
{
"JobId": "4a990a2f7e82adfca6e171135EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:1111222233333:events-detection-job/4a990a2f7e82adfca6e171135EXAMPLE",
"JobName": "events_job_2",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-12T19:55:43.702000+00:00",
"EndTime": "2023-06-12T20:03:49.893000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-source-bucket/EventsData/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/1111222233333-EVENTS-4a990a2f7e82adfca6e171135EXAMPLE/output/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::1111222233333:role/service-role/AmazonComprehendServiceRole-example-role",
"TargetEventTypes": [
"BANKRUPTCY",
"EMPLOYMENT",
"CORPORATE_ACQUISITION",
"CORPORATE_MERGER",
"INVESTMENT_GENERAL"
]
}
]
}
Для получения дополнительной информации см. Асинхронный анализ для Amazon Comprehend insights в Руководстве разработчика Amazon Comprehend.
Вывод
EventsDetectionJobPropertiesList -> (список)
Список, содержащий свойства каждого задания, которое возвращается.
(структура)
Предоставляет информацию о задании обнаружения событий.
JobId -> (строка)
JobArn -> (строка)
Amazon Resource Name (ARN) задания обнаружения событий. Это уникальный, полностью квалифицированный идентификатор задания. Он включает учетную запись Amazon Web Services, регион Amazon Web Services и идентификатор задания. Формат ARN следующий:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>Следующий пример ARN задания:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890abJobName -> (строка)
JobStatus -> (строка)
Message -> (строка)
SubmitTime -> (временная метка)
EndTime -> (временная метка)
InputDataConfig -> (структура)
Настройка входных данных, которую вы предоставили при создании задания обнаружения событий.
S3Uri -> (строка)
Amazon S3 URI для входных данных. URI должен находиться в том же регионе, что и конечная точка API, к которой вы обращаетесь. URI может указывать на один входной файл или может указывать префикс для набора файлов данных.
Например, если вы используете URI S3://bucketName/prefix, если префикс относится к одному файлу, Amazon Comprehend использует этот файл в качестве входных данных. Если более одного файла начинается с префикса, Amazon Comprehend использует все их в качестве входных данных.
InputFormat -> (строка)
Определяет, как текст в входном файле должен обрабатываться:
-
ONE_DOC_PER_FILE- Каждый файл рассматривается как отдельная запись. Используйте этот параметр при обработке больших документов, таких как газетные статьи или научные статьи. -
ONE_DOC_PER_LINE- Каждая строка в файле рассматривается как отдельная запись. Используйте этот параметр при обработке множества коротких документов, таких как текстовые сообщения.
DocumentReaderConfig -> (структура)
Предоставляет параметры конфигурации для переопределения стандартных действий по извлечению текста из PDF-документов и файлов изображений.
DocumentReadAction -> (строка)
Это поле определяет операцию Amazon Textract API, которую Amazon Comprehend использует для извлечения текста из PDF-файлов и файлов изображений. Введите одно из следующих значений:
-
TEXTRACT_DETECT_DOCUMENT_TEXT- Amazon Comprehend service использует операцию APIDetectDocumentText. -
TEXTRACT_ANALYZE_DOCUMENT- Amazon Comprehend service использует операцию APIAnalyzeDocument.
DocumentReadMode -> (строка)
Определяет действия по извлечению текста для PDF-файлов. Введите одно из следующих значений:
-
SERVICE_DEFAULT- использовать настройки Amazon Comprehend по умолчанию для PDF-файлов. -
FORCE_DOCUMENT_READ_ACTION- Amazon Comprehend использует API Textract, указанный в DocumentReadAction, для всех PDF-файлов, включая цифровые PDF-файлы.
FeatureTypes -> (список)
Определяет тип функций Amazon Textract, которые нужно применить. Если вы выбрали TEXTRACT_ANALYZE_DOCUMENT в качестве действия чтения, вы должны указать одно или оба из следующих значений:
-
TABLES- Возвращает дополнительную информацию о любых таблицах, обнаруженных в документе. -
FORMS- Возвращает дополнительную информацию о любых формах, обнаруженных в документе.
(строка)
OutputDataConfig -> (структура)
Настройка выходных данных, которую вы предоставили при создании задания обнаружения событий.
S3Uri -> (строка)
При использовании объекта OutputDataConfig с асинхронными операциями вы указываете местоположение Amazon S3, куда хотите записать выходные данные. URI должен находиться в том же регионе, что и конечная точка API, к которой вы обращаетесь. Местоположение используется в качестве префикса для фактического местоположения выходного файла.
Когда задание обнаружения тем завершено, служба создает выходной файл в каталоге, специфичном для задания. Поле S3Uri содержит расположение выходного файла, называемого output.tar.gz. Это сжатый архив, содержащий результат операции.
Для задания обнаружения сущностей PII выходной файл является обычным текстом, а не сжатым архивом. Имя выходного файла такое же, как и входного файла, с прикрепленным .out в конце.
KmsKeyId -> (строка)
Идентификатор ключа Amazon Web Services Key Management Service (KMS), который Amazon Comprehend использует для шифрования выходных результатов задания анализа. Укажите идентификатор ключа симметричного ключа, потому что асимметричный ключ не может использоваться для загрузки данных в S3.
KmsKeyId может иметь один из следующих форматов:
- ID ключа KMS:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) ключа KMS:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - Псевдоним ключа KMS:
"alias/ExampleAlias" - ARN псевдонима ключа KMS:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
LanguageCode -> (строка)
DataAccessRoleArn -> (строка)
TargetEventTypes -> (список)
Типы событий, которые обнаруживаются заданием.
(строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.