AWS kinesisvideostreams documentation change
Summary
Removed entire documentation for the ListEdgeAgentConfigurations API including request syntax, parameters, response elements, errors, and SDK references.
Security assessment
The change deletes API documentation without introducing security-specific content or referencing vulnerabilities. The removed content included standard API parameters and error messages (like NotAuthorizedException) but no evidence of addressing a security flaw. Documentation removal typically indicates deprecation or restructuring rather than security fixes.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_ListEdgeAgentConfigurations.md b/kinesisvideostreams/latest/dg/API_ListEdgeAgentConfigurations.md index b991888f0..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_ListEdgeAgentConfigurations.md +++ b//kinesisvideostreams/latest/dg/API_ListEdgeAgentConfigurations.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_ListEdgeAgentConfigurations.md) @@ -3,217 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_ListEdgeAgentConfigurations "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 - -# ListEdgeAgentConfigurations - -Returns an array of edge configurations associated with the specified Edge Agent. - -In the request, you must specify the Edge Agent `HubDeviceArn`. - -###### Note - -This API isn't available in the AWS Africa (Cape Town) region, af-south-1. - -## Request Syntax - - - POST /listEdgeAgentConfigurations HTTP/1.1 - Content-type: application/json - - { - "HubDeviceArn": "string", - "MaxResults": number, - "NextToken": "string" - } - -## URI Request Parameters - -The request does not use any URI parameters. - -## Request Body - -The request accepts the following data in JSON format. - -**HubDeviceArn ** - - -The "Internet of Things (IoT) Thing" Arn of the edge agent. - -Type: String - -Length Constraints: Minimum length of 1. Maximum length of 1024. - -Pattern: `arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+` - -Required: Yes - -**MaxResults ** - - -The maximum number of edge configurations to return in the response. The default is 5. - -Type: Integer - -Valid Range: Minimum value of 1. Maximum value of 10. - -Required: No - -**NextToken ** - - -If you specify this parameter, when the result of a `ListEdgeAgentConfigurations` operation is truncated, the call returns the `NextToken` in the response. To get another batch of edge configurations, provide this token in your next request. - -Type: String - -Length Constraints: Minimum length of 0. Maximum length of 1024. - -Pattern: `[a-zA-Z0-9+/=]*` - -Required: No - -## Response Syntax - - - HTTP/1.1 200 - Content-type: application/json - - { - "EdgeConfigs": [ - { - "[CreationTime](./API_ListEdgeAgentConfigurationsEdgeConfig.html#KinesisVideo-Type-ListEdgeAgentConfigurationsEdgeConfig-CreationTime)": **_number_** , - "[EdgeConfig](./API_ListEdgeAgentConfigurationsEdgeConfig.html#KinesisVideo-Type-ListEdgeAgentConfigurationsEdgeConfig-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](./API_ListEdgeAgentConfigurationsEdgeConfig.html#KinesisVideo-Type-ListEdgeAgentConfigurationsEdgeConfig-FailedStatusDetails)": "**_string_** ", - "[LastUpdatedTime](./API_ListEdgeAgentConfigurationsEdgeConfig.html#KinesisVideo-Type-ListEdgeAgentConfigurationsEdgeConfig-LastUpdatedTime)": **_number_** , - "[StreamARN](./API_ListEdgeAgentConfigurationsEdgeConfig.html#KinesisVideo-Type-ListEdgeAgentConfigurationsEdgeConfig-StreamARN)": "**_string_** ", - "[StreamName](./API_ListEdgeAgentConfigurationsEdgeConfig.html#KinesisVideo-Type-ListEdgeAgentConfigurationsEdgeConfig-StreamName)": "**_string_** ", - "[SyncStatus](./API_ListEdgeAgentConfigurationsEdgeConfig.html#KinesisVideo-Type-ListEdgeAgentConfigurationsEdgeConfig-SyncStatus)": "**_string_** " - } - ], - "NextToken": "**_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. - -**EdgeConfigs ** - - -A description of a single stream's edge configuration. - -Type: Array of [ListEdgeAgentConfigurationsEdgeConfig](./API_ListEdgeAgentConfigurationsEdgeConfig.html) objects - -**NextToken ** - - -If the response is truncated, the call returns this element with a given token. To get the next batch of edge configurations, use this token in your next request. - -Type: String - -Length Constraints: Minimum length of 0. Maximum length of 1024. - -Pattern: `[a-zA-Z0-9+/=]*` - -## Errors - -For information about the errors that are common to all actions, see [Common Error Types](./CommonErrors.html). - -**ClientLimitExceededException** - - -Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. - -HTTP Status Code: 400 - -**InvalidArgumentException** - - -The value for this input parameter is invalid. - -HTTP Status Code: 400 - -**NotAuthorizedException** - - -The caller is not authorized to perform this operation. - -HTTP Status Code: 401 - -## See Also - -For more information about using this API in one of the language-specific AWS SDKs, see the following: - - * [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) - - * [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) - - * [AWS SDK for C++](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) - - * [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) - - * [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) - - * [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) - - * [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) - - * [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) - - * [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) - - * [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations) -