[ aws . mediapackagev2 ]
list-harvest-jobs
Описание
Получает список заданий сбора, соответствующих заданным критериям.
См. также: Документация API AWS
list-harvest-jobs — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Items
Синтаксис
list-harvest-jobs
--channel-group-name <value>
[--channel-name <value>]
[--origin-endpoint-name <value>]
[--status <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]
Параметры
--channel-group-name (строка)
--channel-name (строка)
--origin-endpoint-name (строка)
--status (строка)
Статус для фильтрации заданий сбора. Если указано, будут возвращены только задания сбора с этим статусом.
Возможные значения:
QUEUEDIN_PROGRESSCANCELLEDCOMPLETEDFAILED
--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
- текст
- таблица
- 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 ввода.
Вывод
Элементы -> (список)
Массив объектов заданий сбора, соответствующих заданным критериям.
(структура)
Представляет ресурс задания сбора в MediaPackage v2, используемый для экспорта содержимого из конечной точки происхождения в ведро S3.
ChannelGroupName -> (строка)
ChannelName -> (строка)
OriginEndpointName -> (строка)
Destination -> (структура)
S3-место назначения, где будет помещено собранное содержимое.
S3Destination -> (структура)
Настройка для экспорта собранного содержимого в ведро S3. Включает подробности, такие как имя ведра и путь к месту назначения в ведре.
BucketName -> (строка)
DestinationPath -> (строка)
HarvestJobName -> (строка)
HarvestedManifests -> (структура)
Список манифестов, которые собираются или были собраны.
HlsManifests -> (список)
Список собранных HLS-манифестов.
(структура)
Информация о собранном HLS-манифесте.
ManifestName -> (строка)
DashManifests -> (список)
Список собранных DASH-манифестов.
(структура)
Информация о собранном DASH-манифесте.
ManifestName -> (строка)
LowLatencyHlsManifests -> (список)
Список собранных манифестов Low-Latency HLS.
(структура)
Информация о собранном манифесте Low-Latency HLS.
ManifestName -> (строка)
Description -> (строка)
ScheduleConfiguration -> (структура)
Настройка времени выполнения задания сбора.
StartTime -> (временная метка)
EndTime -> (временная метка)
Arn -> (строка)
CreatedAt -> (временная метка)
ModifiedAt -> (временная метка)
Status -> (строка)
ErrorMessage -> (строка)
ETag -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.