Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1428150135.9 KB

Describes a stream’s edge configuration that was set using the <code>StartEdgeConfigurationUpdate</code> API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agent.

post/describeEdgeConfiguration

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 latest status of the edge configuration update.

FailedStatusDetailsstring

A description of the generated failure status.