AWS kinesisvideostreams documentation change
Summary
Entire documentation content for the DescribeImageGenerationConfiguration API has been removed, including request/response syntax, parameters, errors, and references.
Security assessment
The change deletes all content from the documentation file without adding new security context. Removed content included standard API documentation elements like AccessDeniedException (HTTP 401) but no evidence indicates this deletion addresses a specific vulnerability. This appears to be a routine documentation cleanup or deprecation.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_DescribeImageGenerationConfiguration.md b/kinesisvideostreams/latest/dg/API_DescribeImageGenerationConfiguration.md index 0f1b29c33..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_DescribeImageGenerationConfiguration.md +++ b//kinesisvideostreams/latest/dg/API_DescribeImageGenerationConfiguration.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_DescribeImageGenerationConfiguration.md) @@ -3,172 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_DescribeImageGenerationConfiguration "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 - -# DescribeImageGenerationConfiguration - -Gets the `ImageGenerationConfiguration` for a given Kinesis video stream. - -## Request Syntax - - - POST /describeImageGenerationConfiguration 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 Kinesis video stream from which to retrieve the image generation configuration. You must 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 from which to retrieve the image generation configuration. You must 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 - - { - "ImageGenerationConfiguration": { - "[DestinationConfig](./API_ImageGenerationConfiguration.html#KinesisVideo-Type-ImageGenerationConfiguration-DestinationConfig)": { - "[DestinationRegion](./API_ImageGenerationDestinationConfig.html#KinesisVideo-Type-ImageGenerationDestinationConfig-DestinationRegion)": "**_string_** ", - "[Uri](./API_ImageGenerationDestinationConfig.html#KinesisVideo-Type-ImageGenerationDestinationConfig-Uri)": "**_string_** " - }, - "[Format](./API_ImageGenerationConfiguration.html#KinesisVideo-Type-ImageGenerationConfiguration-Format)": "**_string_** ", - "[FormatConfig](./API_ImageGenerationConfiguration.html#KinesisVideo-Type-ImageGenerationConfiguration-FormatConfig)": { - "**_string_** " : "**_string_** " - }, - "[HeightPixels](./API_ImageGenerationConfiguration.html#KinesisVideo-Type-ImageGenerationConfiguration-HeightPixels)": **_number_** , - "[ImageSelectorType](./API_ImageGenerationConfiguration.html#KinesisVideo-Type-ImageGenerationConfiguration-ImageSelectorType)": "**_string_** ", - "[SamplingInterval](./API_ImageGenerationConfiguration.html#KinesisVideo-Type-ImageGenerationConfiguration-SamplingInterval)": **_number_** , - "[Status](./API_ImageGenerationConfiguration.html#KinesisVideo-Type-ImageGenerationConfiguration-Status)": "**_string_** ", - "[WidthPixels](./API_ImageGenerationConfiguration.html#KinesisVideo-Type-ImageGenerationConfiguration-WidthPixels)": **_number_** - } - } - -## 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. - -**ImageGenerationConfiguration ** - - -The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream. - -Type: [ImageGenerationConfiguration](./API_ImageGenerationConfiguration.html) object - -## Errors - -For information about the errors that are common to all actions, see [Common Error Types](./CommonErrors.html). - -**AccessDeniedException** - - -You do not have required permissions to perform this operation. - -HTTP Status Code: 401 - -**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 - -**ResourceNotFoundException** - - -Amazon Kinesis Video Streams can't find the stream that you specified. - -HTTP Status Code: 404 - -## 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/DescribeImageGenerationConfiguration) - - * [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) - - * [AWS SDK for C++](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) - - * [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) - - * [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) - - * [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) - - * [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) - - * [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) - - * [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) - - * [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration) - - - - - **Javascript is disabled or is unavailable in your browser.** - -To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions. - -[Document Conventions](/general/latest/gr/docconventions.html) - -DescribeEdgeConfiguration - -DescribeMappedResourceConfiguration - -Did this page help you? - Yes - -Thanks for letting us know we're doing a good job! - -If you've got a moment, please tell us what we did right so we can do more of it. - -Did this page help you? - No - -Thanks for letting us know this page needs work. We're sorry we let you down. - -If you've got a moment, please tell us how we can make the documentation better.