get-images
Описание
Возвращает список изображений, соответствующих каждой временной метке для заданного диапазона времени, интервала выборки и конфигурации формата изображения.
См. также: Документацию API AWS
get-images является постраничной операцией. Для получения всего набора результатов могут быть отправлены несколько запросов API. Вы можете отключить постраничную загрузку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной загрузкой, аргумент --query должен извлечь данные из результатов следующих выражений запроса: Images
Синтаксис
get-images
[--stream-name <value>]
[--stream-arn <value>]
--image-selector-type <value>
--start-timestamp <value>
--end-timestamp <value>
[--sampling-interval <value>]
--format <value>
[--format-config <value>]
[--width-pixels <value>]
[--height-pixels <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]
Параметры
--stream-name (строка)
StreamName, либо StreamARN.--stream-arn (строка)
StreamName, либо StreamARN.--image-selector-type (строка)
Источник временных меток сервера или производителя, которые должны быть использованы для генерации изображений.
Возможные значения:
PRODUCER_TIMESTAMPSERVER_TIMESTAMP
--start-timestamp (временная метка)
StartTimestamp должна находиться в диапазоне временных меток, включительно, для возвращения изображения.--end-timestamp (временная метка)
StartTimestamp и EndTimestamp превышает 300 секунд по сравнению с StartTimestamp, вы получите IllegalArgumentException.--sampling-interval (целое число)
startTimestamp будет возвращено, если доступно.--format (строка)
Формат, который будет использован для кодирования изображения.
Возможные значения:
JPEGPNG
--format-config (массив)
Список структур ключ-значение, содержащих дополнительные параметры, которые могут быть применены при генерации изображения. Ключ FormatConfig является ключом качества JPEG, который нужно использовать для генерации изображения. Значение FormatConfig принимает целые числа от 1 до 100. Если значение равно 1, изображение будет сгенерировано с низким качеством и лучшим сжатием. Если значение равно 100, изображение будет сгенерировано с наилучшим качеством и меньшим сжатием. Если значение не указано, значение по умолчанию для ключа JPEGQuality будет установлено в 80.
ключ -> (строка)
значение -> (строка)
Сокращенный синтаксис:
KeyName1=string,KeyName2=string
Where valid key names are:
JPEGQuality
Синтаксис JSON:
{"JPEGQuality": "string"
...}
--width-pixels (целое число)
HeightPixels. Когда оба параметра WidthPixels и HeightPixels указаны, изображение будет растянуто для соответствия указанному соотношению сторон. Если указан только параметр WidthPixels или только HeightPixels, будет выброшено ValidationException. Если ни один параметр не указан, исходный размер изображения из потока будет возвращён.--height-pixels (целое число)
WidthPixels. Когда оба параметра HeightPixels и WidthPixels указаны, изображение будет растянуто для соответствия указанному соотношению сторон. Если указан только параметр HeightPixels, его исходное соотношение сторон будет использовано для расчета соотношения WidthPixels. Если ни один параметр не указан, исходный размер изображения будет возвращен.--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-auto-prompt (логическое значение)
Автоматически запросить параметры ввода командной строки.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода командной строки.
Вывод
Изображения -> (список)
Список изображений, сгенерированных из потока видео. Если нет медиаданных для заданной временной метки, в выводе будет указана ошибка NO_MEDIA. Если при генерации изображения возникла ошибка, причина отсутствия изображения будет указана как MEDIA_ERROR.
(структура)
Структура, содержащая Timestamp, Error и ImageContent.
TimeStamp -> (временная метка)
Image, используемый для извлечения изображения из потока видео. Этот поле используется для управления пробелами в изображениях или для лучшего понимания окна постраничной загрузки.Error -> (строка)
Сообщение об ошибке, отображаемое при невозможности извлечь изображение для указанной временной метки из-за ошибки, не подлежащей исправлению. Ошибка будет возвращена, если:
- Нет медиаданных для указанной
Timestamp. - Медиаданные для указанного времени не позволяют извлечь изображение. В этом случае медиа является только аудио, или был загружен неверный тип медиа.
ImageContent -> (строка)
Image, закодированный в Base64.NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.