Spec-Zone.ru › AWS CLI v2

[ aws . comprehend ]

list-dominant-language-detection-jobs

Описание

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

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

list-dominant-language-detection-jobs является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DominantLanguageDetectionJobPropertiesList

Синтаксис

  list-dominant-language-detection-jobs
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, указанные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Маркер для указания точки начала постраничного вывода. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для вызова в службе AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя командной строки AWS.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя командной строки AWS.

--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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

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

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

Для получения списка всех заданий обнаружения доминирующего языка

Следующий пример list-dominant-language-detection-jobs отображает все асинхронные задания обнаружения доминирующего языка, которые находятся в стадии выполнения и завершены.

aws comprehend list-dominant-language-detection-jobs

Вывод:

{
    "DominantLanguageDetectionJobPropertiesList": [
        {
            "JobId": "123456abcdeb0e11022f22a11EXAMPLE",
            "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
            "JobName": "languageanalysis1",
            "JobStatus": "COMPLETED",
            "SubmitTime": "2023-06-09T18:10:38.037000+00:00",
            "EndTime": "2023-06-09T18:18:45.498000+00:00",
            "InputDataConfig": {
                "S3Uri": "s3://amzn-s3-demo-bucket",
                "InputFormat": "ONE_DOC_PER_LINE"
            },
            "OutputDataConfig": {
                "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
            },
            "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
        },
        {
            "JobId": "123456abcdeb0e11022f22a11EXAMPLE",
            "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
            "JobName": "languageanalysis2",
            "JobStatus": "STOPPED",
            "SubmitTime": "2023-06-09T18:16:33.690000+00:00",
            "EndTime": "2023-06-09T18:24:40.608000+00:00",
            "InputDataConfig": {
                "S3Uri": "s3://amzn-s3-demo-bucket",
                "InputFormat": "ONE_DOC_PER_LINE"
            },
            "OutputDataConfig": {
                "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
            },
            "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
        }
    ]
}

Для получения дополнительной информации см. Асинхронный анализ для Amazon Comprehend Insights в Руководстве разработчика Amazon Comprehend.

Вывод

DominantLanguageDetectionJobPropertiesList -> (список)

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

(структура)

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

JobId -> (строка)

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

JobArn -> (строка)

Amazon Resource Name (ARN) задания обнаружения доминирующего языка. Это уникальный, полностью квалифицированный идентификатор задания. Он включает учетную запись Amazon Web Services, регион Amazon Web Services и идентификатор задания. Формат ARN следующий:

arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>

Вот пример ARN задания:

arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

JobName -> (строка)

Имя, присвоенное заданию обнаружения доминирующего языка.

JobStatus -> (строка)

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

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

Это поле определяет операцию API Amazon Textract, которую Amazon Comprehend использует для извлечения текста из PDF-файлов и файлов изображений. Введите одно из следующих значений:

  • TEXTRACT_DETECT_DOCUMENT_TEXT — Amazon Comprehend сервис использует операцию API DetectDocumentText.
  • TEXTRACT_ANALYZE_DOCUMENT — Amazon Comprehend сервис использует операцию API AnalyzeDocument.

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 — Возвращает дополнительную информацию о любых обнаруженных в документе формах.

(строка)

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"

DataAccessRoleArn -> (строка)

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

VolumeKmsKeyId -> (строка)

Идентификатор ключа Amazon Web Services Key Management Service (KMS), который Amazon Comprehend использует для шифрования данных на томе хранилища, подключенном к экземпляру вычислительных ресурсов ML, обрабатывающим задание анализа. VolumeKmsKeyId может иметь один из следующих форматов:

  • 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"

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

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

SecurityGroupIds -> (список)

Идентификатор группы безопасности на экземпляре вашей частной VPC. Группы безопасности вашей VPC выполняют функции виртуального брандмауэра, управляя входящим и исходящим трафиком и обеспечивая безопасность ресурсов, к которым вы будете обращаться в VPC. Этот идентификатор начинается с "sg-", например: "sg-03b388029b0a285ea". Дополнительную информацию см. в Группы безопасности для вашей VPC.

(строка)

Subnets -> (список)

Идентификатор каждого подсети, используемого в вашей частной VPC. Эта подсеть является подмножеством диапазона адресов IPv4, используемых VPC, и специфична для заданной зоны доступности в регионе VPC. Этот идентификатор начинается с "subnet-", например: "subnet-04ccf456919e69055". Дополнительную информацию см. в VPC и подсети.

(строка)

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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