AWS kinesisvideostreams documentation change
Summary
Entire documentation content for DescribeEdgeConfiguration API was removed
Security assessment
The diff shows complete removal of API documentation content without any security context. While the original documentation contained security-related parameters (MediaUriSecretArn), the removal itself doesn't indicate a security fix or vulnerability. No evidence of security incident response or vulnerability mitigation exists in the change.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_DescribeEdgeConfiguration.md b/kinesisvideostreams/latest/dg/API_DescribeEdgeConfiguration.md index aef2f118c..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_DescribeEdgeConfiguration.md +++ b//kinesisvideostreams/latest/dg/API_DescribeEdgeConfiguration.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_DescribeEdgeConfiguration.md) @@ -3,274 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_DescribeEdgeConfiguration "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 - -# DescribeEdgeConfiguration - -Describes a stream’s edge configuration that was set using the `StartEdgeConfigurationUpdate` API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent. - -###### Note - -This API isn't available in the AWS Africa (Cape Town) region, af-south-1. - -## Request Syntax - - - POST /describeEdgeConfiguration HTTP/1.1 - Content-type: application/json - - { - "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. - -**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_** , - "EdgeAgentStatus": { - "[LastRecorderStatus](./API_EdgeAgentStatus.html#KinesisVideo-Type-EdgeAgentStatus-LastRecorderStatus)": { - "[JobStatusDetails](./API_LastRecorderStatus.html#KinesisVideo-Type-LastRecorderStatus-JobStatusDetails)": "**_string_** ", - "[LastCollectedTime](./API_LastRecorderStatus.html#KinesisVideo-Type-LastRecorderStatus-LastCollectedTime)": **_number_** , - "[LastUpdatedTime](./API_LastRecorderStatus.html#KinesisVideo-Type-LastRecorderStatus-LastUpdatedTime)": **_number_** , - "[RecorderStatus](./API_LastRecorderStatus.html#KinesisVideo-Type-LastRecorderStatus-RecorderStatus)": "**_string_** " - }, - "[LastUploaderStatus](./API_EdgeAgentStatus.html#KinesisVideo-Type-EdgeAgentStatus-LastUploaderStatus)": { - "[JobStatusDetails](./API_LastUploaderStatus.html#KinesisVideo-Type-LastUploaderStatus-JobStatusDetails)": "**_string_** ", - "[LastCollectedTime](./API_LastUploaderStatus.html#KinesisVideo-Type-LastUploaderStatus-LastCollectedTime)": **_number_** , - "[LastUpdatedTime](./API_LastUploaderStatus.html#KinesisVideo-Type-LastUploaderStatus-LastUpdatedTime)": **_number_** , - "[UploaderStatus](./API_LastUploaderStatus.html#KinesisVideo-Type-LastUploaderStatus-UploaderStatus)": "**_string_** " - } - }, - "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 - -**EdgeAgentStatus ** - - -An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent. - -Type: [EdgeAgentStatus](./API_EdgeAgentStatus.html) object - -**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 - -Length Constraints: Minimum length of 1. Maximum length of 256. - -Pattern: `[a-zA-Z0-9_.-]+` - -**SyncStatus ** - - -The latest status of the edge configuration update. - -Type: String - -Valid Values: `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` - -## Errors - -For information about the errors that are common to all actions, see [Common Error Types](./CommonErrors.html). - -**AccessDeniedException** -