Spec-Zone.ru › AWS CLI v2

[ aws . machinelearning ]

describe-batch-predictions

Описание

Возвращает список BatchPrediction операций, которые соответствуют критериям поиска в запросе.

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

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

Синтаксис

  describe-batch-predictions
[--filter-variable <value>]
[--eq <value>]
[--gt <value>]
[--lt <value>]
[--ge <value>]
[--le <value>]
[--ne <value>]
[--prefix <value>]
[--sort-order <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-variable (строка)

Используйте одну из следующих переменных для фильтрации списка BatchPrediction:

  • CreatedAt — устанавливает критерии поиска на дату создания BatchPrediction.
  • Status — устанавливает критерии поиска на статус BatchPrediction.
  • Name — устанавливает критерии поиска на содержимое BatchPrediction **** Name .
  • IAMUser — устанавливает критерии поиска на учётную запись пользователя, которая инициировала создание BatchPrediction.
  • MLModelId — устанавливает критерии поиска на MLModel, используемый в BatchPrediction.
  • DataSourceId — устанавливает критерии поиска на DataSource, используемый в BatchPrediction.
  • DataURI — устанавливает критерии поиска на файл(ы) данных, используемые в BatchPrediction. URL может указывать на файл или на ведро или директорию Amazon Simple Storage Solution (Amazon S3).

Возможные значения:

  • CreatedAt
  • LastUpdatedAt
  • Status
  • Name
  • IAMUser
  • MLModelId
  • DataSourceId
  • DataURI

--eq (строка)

Оператор равенства. Результаты BatchPrediction будут иметь значения FilterVariable, которые точно совпадают со значением, указанным с помощью EQ.

--gt (строка)

Оператор больше. Результаты BatchPrediction будут иметь значения FilterVariable, которые больше значения, указанного с помощью GT.

--lt (строка)

Оператор меньше. Результаты BatchPrediction будут иметь значения FilterVariable, которые меньше значения, указанного с помощью LT.

--ge (строка)

Оператор больше или равно. Результаты BatchPrediction будут иметь значения FilterVariable, которые больше или равны значению, указанному с помощью GE.

--le (строка)

Оператор меньше или равно. Результаты BatchPrediction будут иметь значения FilterVariable, которые меньше или равны значению, указанному с помощью LE.

--ne (строка)

Оператор не равно. Результаты BatchPrediction будут иметь значения FilterVariable, не равные значению, указанному с помощью NE.

--prefix (строка)

Строка, которая находится в начале переменной, например Name или Id.

Например, операция Batch Prediction может иметь Name 2014-09-09-HolidayGiftMailer . Чтобы найти эту BatchPrediction , выберите Name для FilterVariable и любую из следующих строк для Prefix:

  • 2014-09
  • 2014-09-09
  • 2014-09-09-Holiday

--sort-order (строка)

Двухзначный параметр, определяющий порядок списка полученных MLModel.

  • asc — сортирует список по возрастанию (А-Я, 0-9).
  • dsc — сортирует список по убыванию (Я-А, 9-0).

Результаты отсортированы по FilterVariable.

Возможные значения:

  • asc
  • dsc

--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
  • text
  • таблица
  • 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 для вывода.

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

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

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

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

Вывод

Результаты -> (список)

Список объектов BatchPrediction, соответствующих критериям поиска.

(структура)

Представляет собой вывод операции GetBatchPrediction.

Содержит подробные метаданные, статус и информацию о файле данных для Batch Prediction.

BatchPredictionId -> (строка)

Идентификатор, присвоенный BatchPrediction при создании. Это значение должно совпадать со значением BatchPredictionID в запросе.

MLModelId -> (строка)

Идентификатор MLModel, который сгенерировал прогнозы для запроса BatchPrediction.

BatchPredictionDataSourceId -> (строка)

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

InputDataLocationS3 -> (строка)

Расположение файла или каталога данных в Amazon Simple Storage Service (Amazon S3).

CreatedByIamUser -> (строка)

AWS учётная запись пользователя, которая вызвала BatchPrediction. Тип учётной записи может быть как корневой учётной записью AWS, так и учётной записью пользователя AWS Identity and Access Management (IAM).

CreatedAt -> (метка времени)

Время создания BatchPrediction. Время выражено в формате временной метки.

LastUpdatedAt -> (метка времени)

Время последнего изменения BatchPrediction. Время выражено в формате временной метки.

Name -> (строка)

Предоставленное пользователем имя или описание BatchPrediction.

Status -> (строка)

Статус BatchPrediction. Этот элемент может принимать одно из следующих значений:

  • PENDING - Amazon Machine Learning (Amazon ML) отправил запрос на генерацию прогнозов для пакета наблюдений.
  • INPROGRESS - Процесс выполняется.
  • FAILED - Запрос на выполнение прогнозирования по пакету не был завершён. Он не используется.
  • COMPLETED - Процесс прогнозирования по пакету завершился успешно.
  • DELETED - BatchPrediction помечен как удалённый. Он не используется.

OutputUri -> (строка)

Расположение ведра или каталога Amazon S3 для получения результатов операции. Следующие подстроки недопустимы в части s3 key поля outputURI: ‘:’, ‘//’, ‘/./’, ‘/../’.

Message -> (строка)

Описание последних деталей по обработке запроса прогнозирования по пакету.

ComputeTime -> (целое число)

Целое число типа long, 64-битное со знаком.

FinishedAt -> (метка времени)

Метка времени, представленная в формате временной метки.

StartedAt -> (метка времени)

Метка времени, представленная в формате временной метки.

TotalRecordCount -> (целое число)

Целое число типа long, 64-битное со знаком.

InvalidRecordCount -> (целое число)

Целое число типа long, 64-битное со знаком.

NextToken -> (строка)

Идентификатор следующей страницы в результатах постраничной выдачи, указывающий, что за ним следует ещё как минимум одна страница.

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

Spec-Zone.ru

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