Spec-Zone.ru › AWS CLI v2

[ aws . kinesisvideo ]

list-edge-agent-configurations

Описание

Возвращает массив конфигураций узлов, связанных с указанным агентом узла.

В запросе необходимо указать агента узла HubDeviceArn .

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

list-edge-agent-configurations — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: EdgeConfigs

Синтаксис

  list-edge-agent-configurations
--hub-device-arn <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]

Параметры

--hub-device-arn (строка)

ARN «вещи Интернета вещей (IoT)» агента узла.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставляемому --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята дословно. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания начальной точки постраничного вывода. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничность в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выходных данных команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлечению меньшего количества элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничность в Руководстве пользователя командной строки AWS.

--max-items (целое число)

Общее количество элементов для возвращения в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, в выходных данных команды предоставляется NextToken. Для возобновления постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

Примеры использования см. в разделе Постраничность в Руководстве пользователя командной строки AWS.

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

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

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

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

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

Вывод

EdgeConfigs -> (список)

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

(структура)

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

StreamName -> (строка)

Имя потока.

StreamARN -> (строка)

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

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

Временная метка создания конфигурации граничного узла для потока.

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

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

SyncStatus -> (строка)

Текущий статус синхронизации конфигурации граничного узла для потока.

FailedStatusDetails -> (строка)

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

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

Описание конфигурации граничного узла потока, которая будет использоваться для синхронизации с компонентом IoT Greengrass агента граничного узла. Компонент агента граничного узла будет работать на устройстве 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 данные, определяющие расписание для записи с камеры или локального медиафайла на агент граничного узла. Если атрибут ScheduleExpression не указан, агент граничного узла всегда будет в режиме записи.

ScheduleExpression -> (строка)

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

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

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

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

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

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

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

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

ScheduleExpression -> (строка)

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

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

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

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

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

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

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

Количество часов, в течение которых вы хотите хранить данные в потоке на агенте граничного узла. Значение по умолчанию для времени хранения — 720 часов, что соответствует 30 дням.

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

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

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

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

StrategyOnFullSize -> (строка)

Стратегия, которая выполняется при достижении предела MaxLocalMediaSizeInMB потока.

DeleteAfterUpload -> (логическое значение)

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

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

NextToken -> (строка)

Если ответ усечён, этот элемент возвращается с заданным маркером. Для получения следующей партии конфигураций граничного узла используйте этот маркер в следующем запросе.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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