Spec-Zone.ru › AWS CLI v2

[ aws . kinesisvideo ]

describe-image-generation-configuration

Описание

Получает ImageGenerationConfiguration для заданного потока Kinesis video.

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

Синтаксис

  describe-image-generation-configuration
[--stream-name <value>]
[--stream-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]

Параметры

--stream-name (строка)

Имя потока, из которого нужно получить конфигурацию генерации изображений. Вы должны указать либо StreamName, либо StreamARN.

--stream-arn (строка)

Amazon Resource Name (ARN) потока Kinesis video, из которого нужно получить конфигурацию генерации изображений. Вы должны указать либо StreamName, либо StreamARN.

--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
  • text
  • таблица
  • 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 (логическое значение)

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

Вывод

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

Структура, содержащая информацию, необходимую для доставки изображений из потока Kinesis video (KVS). Если эта структура равна null, конфигурация будет удалена из потока.

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

Указывает, включён или выключен API ContinuousImageGenerationConfigurations.

ImageSelectorType -> (строка)

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

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

Структура, содержащая информацию, необходимую для доставки изображений клиенту.

Uri -> (строка)

Унифицированный идентификатор ресурса (URI), указывающий место доставки изображений.

DestinationRegion -> (строка)

Amazon Web Services регион S3 ведра, в который будут доставляться изображения. Этот DestinationRegion должен совпадать с регионом, в котором находится поток.

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

Интервал времени в миллисекундах (мс), через который необходимо генерировать изображения из потока. Минимальное значение, которое можно предоставить, составляет 200 мс. Если диапазон временных меток меньше интервала выборки, будет возвращено изображение из StartTimestamp, если оно доступно.

Формат -> (строка)

Принимаемый формат изображения.

FormatConfig -> (карта)

Список структур пары «ключ-значение», содержащих дополнительные параметры, которые можно применить при генерации изображения. Ключ FormatConfig - это ключ JPEGQuality, который указывает используемый ключ качества JPEG для генерации изображения. Значение FormatConfig принимает целочисленные значения от 1 до 100. Если значение равно 1, изображение будет сгенерировано с меньшим качеством и лучшим сжатием. Если значение равно 100, изображение будет сгенерировано с лучшим качеством и меньшим сжатием. Если значение не указано, значение по умолчанию для ключа JPEGQuality будет установлено в 80.

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

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

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

Ширина выходного изображения, используемая в сочетании с параметром HeightPixels. Когда оба параметра WidthPixels и HeightPixels предоставлены, изображение будет растянуто для соответствия заданному соотношению сторон. Если предоставлен только параметр WidthPixels, его исходное соотношение сторон будет использовано для расчёта соотношения сторон HeightPixels. Если ни один параметр не предоставлен, исходный размер изображения будет возвращён.

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

Высота выходного изображения, используемая в сочетании с параметром WidthPixels. Когда оба параметра HeightPixels и WidthPixels предоставлены, изображение будет растянуто для соответствия заданному соотношению сторон. Если предоставлен только параметр HeightPixels, его исходное соотношение сторон будет использовано для расчёта соотношения сторон WidthPixels. Если ни один параметр не предоставлен, исходный размер изображения будет возвращён.

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

Spec-Zone.ru

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