AWS kinesisvideostreams documentation change
Summary
Entire documentation page for StartEdgeConfigurationUpdate API was removed.
Security assessment
The diff shows complete deletion of the API documentation without any security-specific context. No vulnerability mentions, security fixes, or security feature additions are present in the removed content. The removal appears to be general documentation cleanup or restructuring rather than security-related.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_StartEdgeConfigurationUpdate.md b/kinesisvideostreams/latest/dg/API_StartEdgeConfigurationUpdate.md index 055978871..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_StartEdgeConfigurationUpdate.md +++ b//kinesisvideostreams/latest/dg/API_StartEdgeConfigurationUpdate.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_StartEdgeConfigurationUpdate.md) @@ -3,309 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_StartEdgeConfigurationUpdate "Open PDF") - -[Documentation](/index.html)[Amazon Kinesis Video Streams](/kinesis/index.html)[Developer Guide](what-is-kinesis-video.html) - -Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also - -# StartEdgeConfigurationUpdate - -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](./API_DeleteEdgeConfiguration.html) to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN. - -###### Note - -This API isn't available in the AWS Africa (Cape Town) region, af-south-1. - -## Request Syntax - - - POST /startEdgeConfigurationUpdate HTTP/1.1 - Content-type: application/json - - { - "EdgeConfig": { - "[DeletionConfig](./API_EdgeConfig.html#KinesisVideo-Type-EdgeConfig-DeletionConfig)": { - "[DeleteAfterUpload](./API_DeletionConfig.html#KinesisVideo-Type-DeletionConfig-DeleteAfterUpload)": boolean, - "[EdgeRetentionInHours](./API_DeletionConfig.html#KinesisVideo-Type-DeletionConfig-EdgeRetentionInHours)": number, - "[LocalSizeConfig](./API_DeletionConfig.html#KinesisVideo-Type-DeletionConfig-LocalSizeConfig)": { - "[MaxLocalMediaSizeInMB](./API_LocalSizeConfig.html#KinesisVideo-Type-LocalSizeConfig-MaxLocalMediaSizeInMB)": number, - "[StrategyOnFullSize](./API_LocalSizeConfig.html#KinesisVideo-Type-LocalSizeConfig-StrategyOnFullSize)": "string" - } - }, - "[HubDeviceArn](./API_EdgeConfig.html#KinesisVideo-Type-EdgeConfig-HubDeviceArn)": "string", - "[RecorderConfig](./API_EdgeConfig.html#KinesisVideo-Type-EdgeConfig-RecorderConfig)": { - "[MediaSourceConfig](./API_RecorderConfig.html#KinesisVideo-Type-RecorderConfig-MediaSourceConfig)": { - "[MediaUriSecretArn](./API_MediaSourceConfig.html#KinesisVideo-Type-MediaSourceConfig-MediaUriSecretArn)": "string", - "[MediaUriType](./API_MediaSourceConfig.html#KinesisVideo-Type-MediaSourceConfig-MediaUriType)": "string" - }, - "[ScheduleConfig](./API_RecorderConfig.html#KinesisVideo-Type-RecorderConfig-ScheduleConfig)": { - "[DurationInSeconds](./API_ScheduleConfig.html#KinesisVideo-Type-ScheduleConfig-DurationInSeconds)": number, - "[ScheduleExpression](./API_ScheduleConfig.html#KinesisVideo-Type-ScheduleConfig-ScheduleExpression)": "string" - } - }, - "[UploaderConfig](./API_EdgeConfig.html#KinesisVideo-Type-EdgeConfig-UploaderConfig)": { - "[ScheduleConfig](./API_UploaderConfig.html#KinesisVideo-Type-UploaderConfig-ScheduleConfig)": { - "[DurationInSeconds](./API_ScheduleConfig.html#KinesisVideo-Type-ScheduleConfig-DurationInSeconds)": number, - "[ScheduleExpression](./API_ScheduleConfig.html#KinesisVideo-Type-ScheduleConfig-ScheduleExpression)": "string" - } - } - }, - "StreamARN": "string", - "StreamName": "string" - } - -## URI Request Parameters - -The request does not use any URI parameters. - -## Request Body - -The request accepts the following data in JSON format. - -**EdgeConfig ** - - -The edge configuration details required to invoke the update process. - -Type: [EdgeConfig](./API_EdgeConfig.html) object - -Required: Yes - -**StreamARN ** - - -The Amazon Resource Name (ARN) of the stream. Specify either the `StreamName` or the `StreamARN`. - -Type: String - -Length Constraints: Minimum length of 1. Maximum length of 1024. - -Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` - -Required: No - -**StreamName ** - - -The name of the stream whose edge configuration you want to update. Specify either the `StreamName` or the `StreamARN`. - -Type: String - -Length Constraints: Minimum length of 1. Maximum length of 256. - -Pattern: `[a-zA-Z0-9_.-]+` - -Required: No - -## Response Syntax - - - HTTP/1.1 200 - Content-type: application/json - - { - "CreationTime": **_number_** , - "EdgeConfig": { - "[DeletionConfig](./API_EdgeConfig.html#KinesisVideo-Type-EdgeConfig-DeletionConfig)": { - "[DeleteAfterUpload](./API_DeletionConfig.html#KinesisVideo-Type-DeletionConfig-DeleteAfterUpload)": **_boolean_** , - "[EdgeRetentionInHours](./API_DeletionConfig.html#KinesisVideo-Type-DeletionConfig-EdgeRetentionInHours)": **_number_** , - "[LocalSizeConfig](./API_DeletionConfig.html#KinesisVideo-Type-DeletionConfig-LocalSizeConfig)": { - "[MaxLocalMediaSizeInMB](./API_LocalSizeConfig.html#KinesisVideo-Type-LocalSizeConfig-MaxLocalMediaSizeInMB)": **_number_** , - "[StrategyOnFullSize](./API_LocalSizeConfig.html#KinesisVideo-Type-LocalSizeConfig-StrategyOnFullSize)": "**_string_** " - } - }, - "[HubDeviceArn](./API_EdgeConfig.html#KinesisVideo-Type-EdgeConfig-HubDeviceArn)": "**_string_** ", - "[RecorderConfig](./API_EdgeConfig.html#KinesisVideo-Type-EdgeConfig-RecorderConfig)": { - "[MediaSourceConfig](./API_RecorderConfig.html#KinesisVideo-Type-RecorderConfig-MediaSourceConfig)": { - "[MediaUriSecretArn](./API_MediaSourceConfig.html#KinesisVideo-Type-MediaSourceConfig-MediaUriSecretArn)": "**_string_** ", - "[MediaUriType](./API_MediaSourceConfig.html#KinesisVideo-Type-MediaSourceConfig-MediaUriType)": "**_string_** " - }, - "[ScheduleConfig](./API_RecorderConfig.html#KinesisVideo-Type-RecorderConfig-ScheduleConfig)": { - "[DurationInSeconds](./API_ScheduleConfig.html#KinesisVideo-Type-ScheduleConfig-DurationInSeconds)": **_number_** , - "[ScheduleExpression](./API_ScheduleConfig.html#KinesisVideo-Type-ScheduleConfig-ScheduleExpression)": "**_string_** " - } - }, - "[UploaderConfig](./API_EdgeConfig.html#KinesisVideo-Type-EdgeConfig-UploaderConfig)": { - "[ScheduleConfig](./API_UploaderConfig.html#KinesisVideo-Type-UploaderConfig-ScheduleConfig)": { - "[DurationInSeconds](./API_ScheduleConfig.html#KinesisVideo-Type-ScheduleConfig-DurationInSeconds)": **_number_** , - "[ScheduleExpression](./API_ScheduleConfig.html#KinesisVideo-Type-ScheduleConfig-ScheduleExpression)": "**_string_** " - } - } - }, - "FailedStatusDetails": "**_string_** ", - "LastUpdatedTime": **_number_** , - "StreamARN": "**_string_** ", - "StreamName": "**_string_** ", - "SyncStatus": "**_string_** " - } - -## Response Elements - -If the action is successful, the service sends back an HTTP 200 response. - -The following data is returned in JSON format by the service. - -**CreationTime ** - - -The timestamp at which a stream’s edge configuration was first created. - -Type: Timestamp - -**EdgeConfig ** - - -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. - -Type: [EdgeConfig](./API_EdgeConfig.html) object - -**FailedStatusDetails ** - - -A description of the generated failure status. - -Type: String - -**LastUpdatedTime ** - - -The timestamp at which a stream’s edge configuration was last updated. - -Type: Timestamp - -**StreamARN ** - - -The Amazon Resource Name (ARN) of the stream. - -Type: String - -Length Constraints: Minimum length of 1. Maximum length of 1024. - -Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` - -**StreamName ** - - -The name of the stream from which the edge configuration was updated. - -Type: String -