Spec-Zone.ru › AWS CLI v2

[ aws . comprehend ]

описание-задачи-обнаружения-доминирующего-языка

Описание

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

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

Синтаксис

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

Идентификатор, сгенерированный Amazon Comprehend для задачи. StartDominantLanguageDetectionJob операция возвращает этот идентификатор в своём ответе.

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

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

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

aws comprehend describe-dominant-language-detection-job \
    --job-id 123456abcdeb0e11022f22a11EXAMPLE

Вывод:

{
    "DominantLanguageDetectionJobProperties": {
        "JobId": "123456abcdeb0e11022f22a11EXAMPLE",
        "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
        "JobName": "languageanalysis1",
        "JobStatus": "IN_PROGRESS",
        "SubmitTime": "2023-06-09T18:10:38.037000+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 в Руководстве разработчика Amazon Comprehend.

Вывод

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

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

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 использует указанную в DocumentReadAction операцию API Textract для всех 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 (KMS), который Amazon Comprehend использует для шифрования выходных результатов задания анализа. Укажите идентификатор симметричного ключа, поскольку асимметричные ключи нельзя использовать для загрузки данных в S3.

KmsKeyId может иметь один из следующих форматов:

  • Идентификатор ключа 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 (KMS), который Amazon Comprehend использует для шифрования данных на подключенном к экземпляру ML-вычисления(ей) хранилище объёме, обрабатывающем задание анализа. VolumeKmsKeyId может иметь один из следующих форматов:

  • Идентификатор ключа 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 и подсети.

(строка)

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

Spec-Zone.ru

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