Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

list-predictors

Описание

Возвращает список предикторов, созданных с помощью операций CreateAutoPredictor или CreatePredictor. Для каждого предиктора эта операция возвращает сводку его свойств, включая Amazon Resource Name (ARN).

Вы можете получить полные свойства, используя ARN с операциями DescribeAutoPredictor и DescribePredictor. Вы можете фильтровать список, используя массив объектов Filter.

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

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

Синтаксис

  list-predictors
[--filters <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]

Параметры

--filters (список)

Массив фильтров. Для каждого фильтра вы предоставляете условие и выражение соответствия. Условие — это либо IS, либо IS_NOT, что соответственно определяет, следует ли включать или исключать предикторов, соответствующих выражению, из списка. Выражение соответствия состоит из ключа и значения.

Свойства фильтра
  • Condition — Условие для применения. Допустимые значения — IS и IS_NOT. Для включения предикторов, соответствующих выражению, укажите IS. Для исключения соответствующих предикторов, укажите IS_NOT.
  • Key — Название параметра для фильтрации. Допустимые значения — DatasetGroupArn и Status.
  • Value — Значение для соответствия.

Например, чтобы вывести все предикторы со статусом ACTIVE, вы должны указать:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

(структура)

Описывает фильтр для выбора подмножества объектов. Каждый фильтр состоит из условия и выражения соответствия. Условие — это либо IS, либо IS_NOT, что соответственно определяет, следует ли включать или исключать объекты, соответствующие выражению, из списка. Выражение соответствия состоит из ключа и значения.

Ключ -> (строка)

Название параметра для фильтрации.

Значение -> (строка)

Значение для соответствия.

Условие -> (строка)

Условие для применения. Для включения объектов, соответствующих выражению, укажите IS. Для исключения соответствующих объектов, укажите IS_NOT.

Сокращенный синтаксис:

Key=string,Value=string,Condition=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string",
    "Condition": "IS"|"IS_NOT"
  }
  ...
]

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из вашего файла с учетными данными.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--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.

Вывод

Предикторы -> (список)

Массив объектов, которые обобщают свойства каждого предиктора.

(структура)

Предоставляет сводку свойств предиктора, используемых в операции ListPredictors. Для получения полного набора свойств вызовите операцию DescribePredictor и укажите указанный PredictorArn.

PredictorArn -> (строка)

ARN предиктора.

PredictorName -> (строка)

Имя предиктора.

DatasetGroupArn -> (строка)

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

IsAutoPredictor -> (булево)

Используется ли AutoPredictor для создания предиктора.

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

Сводка используемого предиктора-эталона, если предиктор был переобучен или обновлен.

Arn -> (строка)

ARN эталонного предиктора.

Состояние -> (строка)

Состояние эталонного предиктора - Active или Deleted.

Статус -> (строка)

Статус предиктора. Статусы включают:

  • ACTIVE
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
  • CREATE_STOPPING, CREATE_STOPPED

Примечание

Статус предиктора должен быть ACTIVE, прежде чем вы сможете использовать предиктор для создания прогноза.

Сообщение -> (строка)

Если произошла ошибка, информационное сообщение об ошибке.

CreationTime -> (временная метка)

Когда была создана задача обучения модели.

LastModificationTime -> (временная метка)

Последнее время изменения ресурса. Временная метка зависит от статуса задачи:

  • CREATE_PENDING — CreationTime.
  • CREATE_IN_PROGRESS — Текущая временная метка.
  • CREATE_STOPPING — Текущая временная метка.
  • CREATE_STOPPED — Время остановки задачи.
  • ACTIVE или CREATE_FAILED — Время завершения или ошибки задачи.

NextToken -> (строка)

Если ответ усечен, Amazon Forecast возвращает этот токен. Для получения следующего набора результатов используйте токен в следующем запросе.

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

Spec-Zone.ru

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