Spec-Zone.ru › AWS CLI v2

[ aws . comprehend ]

описание-рабочего-колеса

Описание

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

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

Синтаксис

  describe-flywheel
--flywheel-arn <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]

Параметры

--flywheel-arn (строка)

Amazon Resource Number (ARN) рабочего колеса.

--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-flywheel пример получает свойства рабочего колеса. В этом примере модель, связанная с рабочим колесом, — это пользовательская модель классификатора, обученная классифицировать документы как спам или не спам, или «хэмм».

aws comprehend describe-flywheel \
    --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel

Вывод:

{
    "FlywheelProperties": {
        "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel",
        "ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-model/version/1",
        "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role",
        "TaskConfig": {
            "LanguageCode": "en",
            "DocumentClassificationConfig": {
                "Mode": "MULTI_CLASS",
                "Labels": [
                    "ham",
                    "spam"
                ]
            }
        },
        "DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel/schemaVersion=1/20230616T200543Z/",
        "DataSecurityConfig": {},
        "Status": "ACTIVE",
        "ModelType": "DOCUMENT_CLASSIFIER",
        "CreationTime": "2023-06-16T20:05:43.242000+00:00",
        "LastModifiedTime": "2023-06-16T20:21:43.567000+00:00"
    }
}

Дополнительную информацию см. в обзоре рабочего колеса в Руководстве разработчика Amazon Comprehend.

Вывод

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

Свойства рабочего колеса.

FlywheelArn -> (строка)

Amazon Resource Number (ARN) рабочего колеса.

ActiveModelArn -> (строка)

Amazon Resource Number (ARN) активной версии модели.

DataAccessRoleArn -> (строка)

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

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

Конфигурация, относящаяся к модели, связанной с рабочим колесом.

LanguageCode -> (строка)

Код языка, поддерживаемый моделью.

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

Конфигурация, необходимая для модели классификации документов.

Mode -> (строка)

Режим классификации указывает, являются ли документы MULTI_CLASS или MULTI_LABEL.

Labels -> (список)

Один или несколько тегов, которые нужно связать с пользовательским классификатором.

(строка)

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

Конфигурация, необходимая для модели распознавания сущностей.

EntityTypes -> (список)

До 25 типов сущностей, распознаваемых моделью.

(структура)

Тип сущности в помеченном наборе обучающих данных, который Amazon Comprehend использует для обучения пользовательского распознавателя сущностей.

Type -> (строка)

Тип сущности в помеченном наборе обучающих данных, который Amazon Comprehend использует для обучения пользовательского распознавателя сущностей.

Типы сущностей не должны содержать следующих недопустимых символов: n (перевод строки), \n (экранированный перевод строки), r (возврат каретки), \r (экранированный возврат каретки), t (табуляция), \t (экранированная табуляция) и , (запятая).

DataLakeS3Uri -> (строка)

Amazon S3 URI расположения озера данных.

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

Конфигурация безопасности данных.

ModelKmsKeyId -> (строка)

Идентификатор ключа KMS, который Amazon Comprehend использует для шифрования обученных пользовательских моделей. ModelKmsKeyId может быть следующих форматов:

  • Идентификатор ключа KMS: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) ключа KMS: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

VolumeKmsKeyId -> (строка)

Идентификатор ключа KMS, который Amazon Comprehend использует для шифрования объёма.

DataLakeKmsKeyId -> (строка)

Идентификатор ключа KMS, который Amazon Comprehend использует для шифрования данных в озере данных.

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

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

SecurityGroupIds -> (список)

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

(строка)

Subnets -> (список)

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

(строка)

Status -> (строка)

Состояние рабочего колеса.

ModelType -> (строка)

Тип модели рабочего колеса.

Message -> (строка)

Описание состояния рабочего колеса.

CreationTime -> (маркировка времени)

Время создания рабочего колеса.

LastModifiedTime -> (маркировка времени)

Время последнего изменения рабочего колеса.

LatestFlywheelIteration -> (строка)

Самая последняя итерация рабочего колеса.

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

Spec-Zone.ru

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