Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1428150135.9 KB

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

post/startEdgeConfigurationUpdate

Request body

StreamNamestring

The name of the stream whose edge configuration you want to update. Specify either the <code>StreamName</code> or the <code>StreamARN</code>.

StreamARNstring

The Amazon Resource Name (ARN) of the stream. Specify either the <code>StreamName</code> or the <code>StreamARN</code>.

Response

Success

StreamNamestring

The name of the stream from which the edge configuration was updated.

StreamARNstring

The Amazon Resource Name (ARN) of the stream.

CreationTimestring date-time

The timestamp at which a stream’s edge configuration was first created.

LastUpdatedTimestring date-time

The timestamp at which a stream’s edge configuration was last updated.

SyncStatus'SYNCING' | 'ACKNOWLEDGED' | 'IN_SYNC' | 'SYNC_FAILED' | 'DELETING' | 'DELETE_FAILED'

The current sync status of the stream's edge configuration. When you invoke this API, the sync status will be set to the <code>SYNCING</code> state. Use the <code>DescribeEdgeConfiguration</code> API to get the latest status of the edge configuration.

FailedStatusDetailsstring

A description of the generated failure status.