Spec-Zone.ru › AWS CLI v2

[ aws . comprehend ]

list-sentiment-detection-jobs

Описание

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

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

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

Синтаксис

  list-sentiment-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 Command Line Interface.

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

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

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

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

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

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

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Для перечисления всех заданий распознавания настроений

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

aws comprehend list-sentiment-detection-jobs

Вывод:

{
    "SentimentDetectionJobPropertiesList": [
        {
            "JobId": "123456abcdeb0e11022f22a11EXAMPLE",
            "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
            "JobName": "example-sentiment-detection-job",
            "JobStatus": "IN_PROGRESS",
            "SubmitTime": "2023-06-09T22:42:20.545000+00:00",
            "EndTime": "2023-06-09T22:52:27.416000+00:00",
            "InputDataConfig": {
                "S3Uri": "s3://amzn-s3-demo-bucket/MovieData",
                "InputFormat": "ONE_DOC_PER_LINE"
            },
            "OutputDataConfig": {
                "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
            },
            "LanguageCode": "en",
            "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
        },
        {
            "JobId": "123456abcdeb0e11022f22a1EXAMPLE2",
            "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a1EXAMPLE2",
            "JobName": "example-sentiment-detection-job-2",
            "JobStatus": "COMPLETED",
            "SubmitTime": "2023-06-09T23:16:15.956000+00:00",
            "EndTime": "2023-06-09T23:26:00.168000+00:00",
            "InputDataConfig": {
                "S3Uri": "s3://amzn-s3-demo-bucket/MovieData2",
                "InputFormat": "ONE_DOC_PER_LINE"
            },
            "OutputDataConfig": {
                "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz"
            },
            "LanguageCode": "en",
            "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
        }
    ]
}

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

Вывод

SentimentDetectionJobPropertiesList -> (список)

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

(структура)

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

JobId -> (строка)

Идентификатор, назначенный заданию распознавания настроения.

JobArn -> (строка)

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

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

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

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

JobName -> (строка)

Имя, назначенное заданию распознавания настроения.

JobStatus -> (строка)

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

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 . Это сжатый архив, содержащий результат операции.

Для задания распознавания сущностей ПИН-данных выходной файл — это обычный текст, а не сжатый архив. Имя выходного файла такое же, как имя входного файла, с добавленным .out в конце.

KmsKeyId -> (строка)

Идентификатор ключа Amazon Web Services Key Management Service (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"

LanguageCode -> (строка)

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

DataAccessRoleArn -> (строка)

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

VolumeKmsKeyId -> (строка)

Идентификатор ключа Amazon Web Services Key Management Service (KMS), который Amazon Comprehend использует для шифрования данных на томе хранения, подключенном к виртуальной машине (VM) 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 и подсети.

(строка)

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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