Module Values.StartEdgeConfigurationUpdateOutputSource

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. To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.

Sourcetype nonrec t = {
  1. streamName : StreamName.t option;
    (*

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

    *)
  2. streamARN : ResourceARN.t option;
    (*

    The Amazon Resource Name (ARN) of the stream.

    *)
  3. creationTime : Timestamp.t option;
    (*

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

    *)
  4. lastUpdatedTime : Timestamp.t option;
    (*

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

    *)
  5. syncStatus : SyncStatus.t option;
    (*

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

    *)
  6. failedStatusDetails : FailedStatusDetails.t option;
    (*

    A description of the generated failure status.

    *)
  7. edgeConfig : EdgeConfig.t option;
    (*

    A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `ClientLimitExceededException of ClientLimitExceededException.t
  3. | `InvalidArgumentException of InvalidArgumentException.t
  4. | `NoDataRetentionException of NoDataRetentionException.t
  5. | `ResourceInUseException of ResourceInUseException.t
  6. | `ResourceNotFoundException of ResourceNotFoundException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?streamName:??? -> ?streamARN:??? -> ?creationTime:??? -> ?lastUpdatedTime:??? -> ?syncStatus:??? -> ?failedStatusDetails:??? -> ?edgeConfig:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `ClientLimitExceededException of ClientLimitExceededException.t | `InvalidArgumentException of InvalidArgumentException.t | `NoDataRetentionException of NoDataRetentionException.t | `ResourceInUseException of ResourceInUseException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `ClientLimitExceededException of ClientLimitExceededException.t | `InvalidArgumentException of InvalidArgumentException.t | `NoDataRetentionException of NoDataRetentionException.t | `ResourceInUseException of ResourceInUseException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of StreamName.t | `Structure of (string * [> `String of HubDeviceArn.t | `Structure of (string * [> `Boolean of DeleteAfterUpload.t | `Integer of EdgeRetentionInHours.t | `Structure of (string * [> `Enum of string | `Integer of DurationInSeconds.t | `String of MediaUriSecretArn.t ]) list ]) list ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t