Spec-Zone.ru › AWS CLI v2

[ aws . sagemaker ]

list-candidates-for-auto-ml-job

Описание

Список кандидатов, созданных для задания.

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

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

Синтаксис

  list-candidates-for-auto-ml-job
--auto-ml-job-name <value>
[--status-equals <value>]
[--candidate-name-equals <value>]
[--sort-order <value>]
[--sort-by <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]

Параметры

--auto-ml-job-name (строка)

Вывести список кандидатов, созданных для задания, указав имя задания.

--status-equals (строка)

Вывести список кандидатов для задания и отфильтровать по статусу.

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

  • Completed
  • InProgress
  • Failed
  • Stopped
  • Stopping

--candidate-name-equals (строка)

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

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

Порядок сортировки результатов. По умолчанию — Ascending.

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

  • Ascending
  • Descending

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

Параметр сортировки результатов. По умолчанию — Descending.

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

  • CreationTime
  • Status
  • FinalObjectiveMetricValue

--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 (целое число)

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

Вывод

Кандидаты -> (список)

Сводки о AutoMLCandidates .

(структура)

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

CandidateName -> (строка)

Имя кандидата.

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

Лучший результат кандидата из задачи обучения AutoML.

Type -> (строка)

Тип метрики с лучшим результатом.

MetricName -> (строка)

Имя метрики с лучшим результатом. Для описания возможных целевых метрик см. AutoMLJobObjective$MetricName .

Value -> (число с плавающей точкой)

Значение метрики с лучшим результатом.

StandardMetricName -> (строка)

Имя стандартной метрики. Для описания стандартных метрик см. Метрики кандидатов Autopilot .

ObjectiveStatus -> (строка)

Статус целевой функции.

CandidateSteps -> (список)

Информация о шагах кандидата.

(структура)

Информация о шагах кандидата и над каким шагом он работает.

CandidateStepType -> (строка)

Шаг преобразования, обучения или обработки.

CandidateStepArn -> (строка)

ARN шага кандидата.

CandidateStepName -> (строка)

Имя шага кандидата.

CandidateStatus -> (строка)

Статус кандидата.

InferenceContainers -> (список)

Информация о рекомендуемых определениях контейнеров для вывода.

(структура)

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

Image -> (строка)

Путь в Amazon Elastic Container Registry (Amazon ECR) для контейнера. Дополнительную информацию см. в разделе ContainerDefinition .

ModelDataUrl -> (строка)

Расположение артефактов модели. Дополнительную информацию см. в разделе ContainerDefinition .

Environment -> (массив)

Переменные среды, которые нужно установить в контейнере. Дополнительную информацию см. в разделе ContainerDefinition .

key -> (строка)

value -> (строка)

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

Время создания.

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

Время завершения.

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

Время последнего изменения.

FailureReason -> (строка)

Причина ошибки.

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

Свойства задачи кандидата AutoML.

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

Префикс Amazon S3 для артефактов, сгенерированных для кандидата AutoML.

Explainability -> (строка)

Префикс Amazon S3 для артефактов объяснения, сгенерированных для кандидата AutoML.

ModelInsights -> (строка)

Префикс Amazon S3 для артефактов информации о модели, сгенерированных для кандидата AutoML.

BacktestResults -> (строка)

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

CandidateMetrics -> (список)

Информация о метриках кандидата для задачи AutoML.

(структура)

Информация о метрике кандидата, созданного задачей AutoML.

MetricName -> (строка)

Имя метрики.

StandardMetricName -> (строка)

Имя стандартной метрики.

Примечание

Для определений стандартных метрик см. ` Autopilot candidate metrics https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-metrics`__ .

Value -> (число с плавающей точкой)

Значение метрики.

Set -> (строка)

Разбиение набора данных, из которого задача AutoML получила метрику.

InferenceContainerDefinitions -> (массив)

Сопоставление всех поддерживаемых процессорных единиц (CPU, GPU и т. д.) с определениями контейнеров вывода для кандидата. Это поле заполняется для задач AutoML V2 (например, для задач, созданных с помощью вызова CreateAutoMLJobV2 ) только для типов задач классификации изображений или текста.

key -> (строка)

Процессорная единица для контейнера вывода. В настоящее время Autopilot поддерживает только CPU или GPU .

value -> (список)

Информация о рекомендуемых определениях контейнеров для вывода.

(структура)

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

Image -> (строка)

Путь в Amazon Elastic Container Registry (Amazon ECR) для контейнера. Дополнительную информацию см. в разделе ContainerDefinition .

ModelDataUrl -> (строка)

Расположение артефактов модели. Дополнительную информацию см. в разделе ContainerDefinition .

Environment -> (массив)

Переменные среды, которые нужно установить в контейнере. Дополнительную информацию см. в разделе ContainerDefinition .

key -> (строка)

value -> (строка)

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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