Spec-Zone.ru › AWS CLI v2

[ aws . personalize ]

describe-batch-segment-job

Описание

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

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

Синтаксис

  describe-batch-segment-job
--batch-segment-job-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]

Параметры

--batch-segment-job-arn (строка)

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 для вывода.

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

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

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

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

Вывод

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

Информация о задании по созданию сегментов из набора данных.

jobName -> (строка)

Имя задания по созданию сегментов из набора данных.

batchSegmentJobArn -> (строка)

Amazon Resource Name (ARN) задания по созданию сегментов из набора данных.

filterArn -> (строка)

ARN фильтра, используемого для задания по созданию сегментов из набора данных.

failureReason -> (строка)

При ошибке задания по созданию сегментов из набора данных — причина ошибки.

solutionVersionArn -> (строка)

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

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

Количество предсказанных пользователей, сгенерированных заданием по созданию сегментов из набора данных для каждой строки входных данных. Максимальное количество пользователей на сегмент — 5 миллионов.

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

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

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

Подробная информация о конфигурации ведра Amazon S3 для ввода или вывода.

path -> (строка)

Путь к файлу в ведре Amazon S3.

kmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа Key Management Service (KMS), используемого Amazon Personalize для шифрования или дешифрования входных и выходных файлов.

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

Ведро Amazon S3, содержащее выходные данные, сгенерированные заданием по созданию сегментов из набора данных.

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

Подробная информация о конфигурации ведра Amazon S3 для ввода или вывода.

path -> (строка)

Путь к файлу в ведре Amazon S3.

kmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа Key Management Service (KMS), используемого Amazon Personalize для шифрования или дешифрования входных и выходных файлов.

roleArn -> (строка)

ARN роли Amazon Identity and Access Management (IAM), которая запросила задание по созданию сегментов из набора данных.

status -> (строка)

Статус задания по созданию сегментов из набора данных. Статус может быть одним из следующих:

  • ОЖИДАНИЕ
  • В ПРОЦЕССЕ
  • АКТИВНО
  • СОЗДАНИЕ НЕ УСПЕШНО

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

Время создания задания по созданию сегментов из набора данных.

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

Время последнего обновления задания по созданию сегментов из набора данных.

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

Spec-Zone.ru

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