Spec-Zone.ru › AWS CLI v2

[ aws . kinesisvideo ]

describe-edge-configuration

Описание

Описывает конфигурацию кромки потока, установленную с помощью API StartEdgeConfigurationUpdate и последний статус задач записи и загрузки агента кромки. Используйте этот API для получения статуса конфигурации, чтобы определить, синхронизирована ли конфигурация с агентом кромки. Используйте этот API для оценки состояния агента кромки.

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

Синтаксис

  describe-edge-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) потока. Укажите либо 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
  • текст
  • таблица
  • 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 (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

StreamName -> (строка)

Имя потока, из которого была обновлена конфигурация края.

StreamARN -> (строка)

Amazon Resource Name (ARN) потока.

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

Метка времени, когда конфигурация края потока была впервые создана.

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

Метка времени, когда конфигурация края потока была в последний раз обновлена.

SyncStatus -> (строка)

Последний статус обновления конфигурации края.

FailedStatusDetails -> (строка)

Описание сгенерированного статуса ошибки.

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

Описание конфигурации края потока, которая будет использоваться для синхронизации с компонентом IoT Greengrass Edge Agent. Компонент Edge Agent будет выполняться на устройстве IoT Hub в вашей инфраструктуре.

HubDeviceArn -> (строка)

ARN «Устройства Интернета вещей (IoT)» потока.

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

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

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

Подробности конфигурации, включающие учетные данные, необходимые (MediaUriSecretArn и MediaUriType), для доступа к медиафайлам, передаваемым на камеру.

MediaUriSecretArn -> (строка)

ARN Amazon Web Services Secrets Manager для имени пользователя и пароля камеры или расположения локального медиафайла.

MediaUriType -> (строка)

Тип универсального идентификатора ресурса (URI). Значение FILE_URI может использоваться для потоковой передачи локальных медиафайлов.

Примечание

Предварительный просмотр поддерживает только формат URI источника медиа RTSP_URI.

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

Конфигурация, содержащая ScheduleExpression и DurationInMinutes данные, определяющие расписание записи с камеры или локального медиафайла на Edge Agent. Если атрибут ScheduleExpression не указан, Edge Agent всегда будет в режиме записи.

ScheduleExpression -> (строка)

Выражение Quartz cron, отвечающее за планирование задач записи с камеры или локального медиафайла на Edge Agent. Если ScheduleExpression не указано для RecorderConfig, Edge Agent всегда будет в режиме записи.

Для получения дополнительной информации о Quartz обратитесь к странице ` Руководство по триггеру Cron http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html`__ для понимания допустимых выражений и их использования.

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

Общее время записи медиа. Если указан атрибут ScheduleExpression, то необходимо также указать атрибут DurationInSeconds.

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

Конфигурация загрузчика содержит ScheduleExpression данные, используемые для планирования задач загрузки записанных медиафайлов с Edge Agent в Kinesis Video Stream.

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

Конфигурация, содержащая ScheduleExpression и DurationInMinutes данные, определяющие расписание записи с камеры или локального медиафайла на Edge Agent. Если ScheduleConfig не указано в этом UploaderConfig, Edge Agent будет загружать данные регулярно (каждые 1 час).

ScheduleExpression -> (строка)

Выражение Quartz cron, отвечающее за планирование задач записи с камеры или локального медиафайла на Edge Agent. Если ScheduleExpression не указано для RecorderConfig, Edge Agent всегда будет в режиме записи.

Для получения дополнительной информации о Quartz обратитесь к странице ` Руководство по триггеру Cron http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html`__ для понимания допустимых выражений и их использования.

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

Общее время записи медиа. Если указан атрибут ScheduleExpression, то необходимо также указать атрибут DurationInSeconds.

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

Конфигурация удаления состоит из данных о времени хранения (EdgeRetentionInHours) и конфигурации локального размера (LocalSizeConfig), используемых для удаления.

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

Количество часов, в течение которых необходимо хранить данные в потоке на Edge Agent. Значение по умолчанию для времени хранения составляет 720 часов, что эквивалентно 30 дням.

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

Значение локального размера, необходимого для удаления конфигурации края.

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

Максимальный размер медиа, который вы хотите хранить для потока на Edge Agent.

StrategyOnFullSize -> (строка)

Стратегия действий при достижении ограничения MaxLocalMediaSizeInMB потока.

DeleteAfterUpload -> (булево)

Значение boolean, указывающее, нужно ли помечать медиа для удаления после загрузки в облачный Kinesis Video Stream. Медиафайлы могут быть удалены, если какие-либо значения конфигурации удаления установлены в true, например, при достижении ограничения EdgeRetentionInHours или MaxLocalMediaSizeInMB.

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

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

Объект, содержащий последние данные о статусе задач записи и загрузки агента края. Используйте эту информацию для определения текущего состояния агента края.

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

Последний статус задачи записи края потока.

JobStatusDetails -> (строка)

Описание последнего статуса задачи записи.

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

Метка времени последнего выполнения задачи записи и сохранения медиа на локальном диске.

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

Метка времени последнего обновления статуса записи.

RecorderStatus -> (строка)

Статус последней задачи записи.

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

Последний статус задачи загрузки медиа с края в облако.

JobStatusDetails -> (строка)

Описание последнего статуса задачи загрузки.

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

Метка времени последнего выполнения задачи загрузки и сбора медиа в облаке.

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

Метка времени последнего обновления статуса загрузки.

UploaderStatus -> (строка)

Статус последней задачи загрузки.

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

Spec-Zone.ru

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