AWS kinesisvideostreams documentation change
Summary
Removed detailed technical documentation about automated S3 image generation configuration and throttling mitigation, replacing it with simplified overview content and links to other pages.
Security assessment
The changes restructure documentation without introducing or removing security controls. The removed S3 throttling recommendations were performance-related (request limits) rather than security-focused. No authentication, encryption, or access control changes were mentioned.
Diff
diff --git a/kinesisvideostreams/latest/dg/images.md b/kinesisvideostreams/latest/dg/images.md index 3d6601d54..0e7f33cfe 100644 --- a//kinesisvideostreams/latest/dg/images.md +++ b//kinesisvideostreams/latest/dg/images.md @@ -5,2 +4,0 @@ -Automated image generation (Amazon S3 delivery) - @@ -9,237 +7 @@ Automated image generation (Amazon S3 delivery) -You can use Amazon Kinesis Video Streams APIs and SDKs to help you extract images from your video streams. You can use these images for enhanced playback applications such as thumbnails or enhanced scrubbing, or for use in machine learning pipelines. Kinesis Video Streams offers on-demand image extraction through an API, or automated image extraction from metadata tags in an ingested video. - -For information about using Kinesis Video Streams managed support for images, see: - - * **[On-demand Image Generation (GetImages)](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_GetImages.html)** \- This API allows customers to extract a single image or multiple images from video stored in Kinesis Video Streams. - - * **Automated image generation (Amazon S3 delivery)** \- Configure Kinesis Video Streams to automatically extract images from video data in real time based on tags in an uploaded video, and deliver the images to the customer-specified S3 bucket. - - - - -## Automated image generation (Amazon S3 delivery) - -Currently, customers run and manage their own image transcoding pipeline to create images for various purposes like scrubbing, image preview, running ML models on images, and more. Kinesis Video Streams offers the capability to transcode and deliver the images. Kinesis Video Streams will automatically extract images from video data in real-time based on a tag, and deliver the images to a customer specified S3 bucket. - -###### Topics - - * UpdateImageGenerationConfiguration - - * DescribeImageGenerationConfiguration - - * Producer MKV tags - - * Add metadata tags in producer SDK using PutEventMetaData - - * Limits - - * S3 Object metadata - - * Amazon S3 object path (image) - - * Amazon S3 URI recommendations to protect against throttling - - - - -### UpdateImageGenerationConfiguration - -###### To set up a Kinesis video stream to enable image generation to Amazon S3: - - 1. Create an **S3 Bucket** for image generation based on the tags added in the SDK using the new API. Note the **S3 URI** , which is required in the next step, when updating the image generation configurations for the streams. - - 2. Create a JSON file called **update-image-generation-input.json** with the following content as input. - - - - - - { - "StreamName": "TestStream", - "ImageGenerationConfiguration": - { - "Status": "ENABLED", - "DestinationConfig": - { - "DestinationRegion": "us-east-1", - "Uri": "s3://bucket-name" - }, - "SamplingInterval": 200, - "ImageSelectorType": "PRODUCER_TIMESTAMP", - "Format": "JPEG", - "FormatConfig": { - "JPEGQuality": "80" - }, - "WidthPixels": 320, - "HeightPixels": 240 - } - } - -You can use the AWS CLI to invoke the [UpdateImageGenerationConfiguration](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_UpdateImageGenerationConfiguration.html) API operation to add the Amazon S3 ARN created previously and change the status to `ENABLED`. - - - aws kinesisvideo update-image-generation-configuration \ - --cli-input-json file://./update-image-generation-input.json \ - -**Request:** - - - UpdateImageGenerationConfiguration HTTP/1.1 - - Method: 'POST' - Path: '/updateImageGenerationConfiguration' - Body: { - StreamName: 'String', // Optional. Either stream name or arn should be passed - StreamArn: 'String', // Optional. Either stream name or arn should be passed - ImageGenerationConfiguration : { - // required - Status: 'Enum', // ENABLED | DISABLED, - ImageSelectorType: 'Enum', // SERVER_TIMESTAMP | PRODUCER_TIMESTAMP.. - DestinationConfig: { - DestinationRegion: 'String', - Uri: string, - }, - SamplingInterval: 'Number'// - Format: 'Enum', // JPEG | PNG - // Optional parameters - FormatConfig: { - 'String': 'String', - }, - WidthPixels: 'Number', // 1 - 3840 (4k). - HeightPixels: 'Number' // 1 - 2160 (4k). - } - } - - -**Response:** - - - HTTP/1.1 200 - Content-type: application/json - Body: { - } - - -###### Note - -It takes at least 1 minute to initiate the image generation workflow after updating the image generation configuration. Wait at least 1 minute before invoking `PutMedia` after the update call. - -### DescribeImageGenerationConfiguration - -To view image generation configurations that are already set for a stream, customers can make a `DescribeImageGenerationConfiguration` request, as follows. - -**Request:** - - - DescribeImageGenerationConfiguration HTTP/1.1 - - - Method: 'POST' - Path: '/describeImageGenerationConfiguration' - Body: { - StreamName: 'String', // Optional. Either stream name or arn should be passed - StreamArn: 'String', // Optional. Either stream name or arn should be passed - } - - -**Response:** - - - HTTP/1.1 200 - Content-type: application/json - Body: { - ImageGenerationConfiguration : { - Status: 'Enum', - ImageSelectorType: 'Enum', // SERVER_TIMESTAMP | PRODUCER_TIMESTAMP - DestinationConfig: { - DestinationRegion: 'String' - Uri: 'string', - }, - SamplingInterval: 'Number', - Format: 'Enum', - FormatConfig: { - 'String': 'String', - }, - WidthPixels: 'Number', - HeightPixels: 'Number' - } - } - - - -To learn more about the `DescribeImageGenerationConfiguration` feature, see [DescribeImageGenerationConfiguration ](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeImageGenerationConfiguration.html) in the _Amazon Kinesis Video Streams Developer Guide._ - -### Producer MKV tags - -You can use the Kinesis Video Streams producer SDK to tag specific fragments of interest by exposing an API operation in the SDK. For an example of a tag, see [this code](https://github.com/awslabs/amazon-kinesis-video-streams-producer-sdk-cpp/blob/master/samples/kvs_gstreamer_sample.cpp#L404). Upon calling this API, the SDK will add a set of predefined MKV tags along with the fragment data. Kinesis Video Streams will recognize these special MKV tags and initiate the image generation workflow based on the image processing configuration of that stream. - -Any fragment metadata provided along with the Amazon S3 image generation tags will be saved as Amazon S3 metadata. - -#### Syntax for producer MKV tags - - - |+ Tags - | + Tag - | // MANDATORY: Predefined MKV tag to trigger image generation for the fragment - | + Simple - | + Name: AWS_KINESISVIDEO_IMAGE_GENERATION - - | // OPTIONAL: S3 prefix which will be set as prefix for generated image. - | + Simple - | + Name: AWS_KINESISVIDEO_IMAGE_PREFIX - | + String: image_prefix_in_s3 // 256 bytes max m - - | // OPTIONAL: Key value pairs that will be persisted as S3 Image object metadata. - | + Simple - | + Name: CUSTOM_KEY_1 // Max 128 bytes - | + String:CUSTOM_VALUE_1 // Max 256 bytes - | + Simple - | + Name: CUSTOM_KEY_2 // Max 128 bytes - | + String: CUSTOM_VALUE_2 // Max 256 bytes - -