Обновление конфигурации граничного узла

Описание

Асинхронный API, обновляющий существующую конфигурацию граничного узла потока. Поток Kinesis Video Stream синхронизирует конфигурацию граничного узла с компонентом Edge Agent IoT Greengrass, работающим на устройстве IoT Hub, установленного на вашем предприятии. Время синхронизации может варьироваться и зависит от подключения устройства Hub. SyncStatus будет обновляться по мере подтверждения и синхронизации конфигурации граничного узла с Edge Agent.

Если этот API вызывается впервые, для потока будет создана новая конфигурация граничного узла, а статус синхронизации будет установлен в SYNCING. Вы должны дождаться, пока статус синхронизации достигнет конечного состояния, такого как: IN_SYNC или SYNC_FAILED, прежде чем снова использовать этот API. Если вы вызываете этот API во время процесса синхронизации, будет брошено исключение ResourceInUseException. Подключение конфигурации граничного узла потока и Edge Agent будет повторно пытаться в течение 15 минут. По истечении 15 минут состояние перейдет в состояние SYNC_FAILED.

Чтобы перенести конфигурацию граничного узла с одного устройства на другое, используйте DeleteEdgeConfiguration для удаления текущей конфигурации граничного узла. Затем вы можете вызвать StartEdgeConfigurationUpdate с обновлённым ARN устройства Hub.

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

Синопсис

  start-edge-configuration-update
[--stream-name <value>]
[--stream-arn <value>]
--edge-config <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]

Параметры

StreamName (строка)

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

--edge-config (структура)

Сокращённый синтаксис:

HubDeviceArn=string,RecorderConfig={MediaSourceConfig={MediaUriSecretArn=string,MediaUriType=string},ScheduleConfig={ScheduleExpression=string,DurationInSeconds=integer}},UploaderConfig={ScheduleConfig={ScheduleExpression=string,DurationInSeconds=integer}},DeletionConfig={EdgeRetentionInHours=integer,LocalSizeConfig={MaxLocalMediaSizeInMB=integer,StrategyOnFullSize=string},DeleteAfterUpload=boolean}

Синтаксис JSON:

{
  "HubDeviceArn": "string",
  "RecorderConfig": {
    "MediaSourceConfig": {
      "MediaUriSecretArn": "string",
      "MediaUriType": "RTSP_URI"|"FILE_URI"
    },
    "ScheduleConfig": {
      "ScheduleExpression": "string",
      "DurationInSeconds": integer
    }
  },
  "UploaderConfig": {
    "ScheduleConfig": {
      "ScheduleExpression": "string",
      "DurationInSeconds": integer
    }
  },
  "DeletionConfig": {
    "EdgeRetentionInHours": integer,
    "LocalSizeConfig": {
      "MaxLocalMediaSizeInMB": integer,
      "StrategyOnFullSize": "DELETE_OLDEST_MEDIA"|"DENY_NEW_MEDIA"
    },
    "DeleteAfterUpload": true|false
  }
}

--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
• table
• yaml
• yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

• on
• off
• auto

--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.

Вывод

StreamName -> (строка)

StreamARN -> (строка)

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

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

SyncStatus -> (строка)

FailedStatusDetails -> (строка)

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