AWS kinesisvideostreams documentation change
Summary
Removed entire content of the documentation file including API reference details, parameters, errors, and examples for GetImages operation.
Security assessment
The change deletes the entire API documentation content but shows no evidence of addressing a specific security vulnerability, weakness, or incident. No security-related content was added or modified.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_reader_GetImages.md b/kinesisvideostreams/latest/dg/API_reader_GetImages.md index ba95cdfba..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_reader_GetImages.md +++ b//kinesisvideostreams/latest/dg/API_reader_GetImages.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_reader_GetImages.md) @@ -3,321 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_reader_GetImages "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 - -# GetImages - -Managed support for images provides a fully managed way to get images from the video data streamed and stored in Kinesis Video Streams. You can use images to run machine learning (ML) workloads such as person, pet, or vehicle detection. Images can also be used to add interactive elements to playback, such as image previews for motion events and scrubbing for a video clip. - -GetImages also retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration. - -###### Note - -You must first call the `GetDataEndpoint` API to get an endpoint. Then send the `GetImages` requests to this endpoint using the [\--endpoint-url parameter](https://docs.aws.amazon.com/cli/latest/reference/). - -[Video playback track requirements](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html). - -## Request Syntax - - - POST /getImages HTTP/1.1 - Content-type: application/json - - { - "EndTimestamp": number, - "Format": "string", - "FormatConfig": { - "string" : "string" - }, - "HeightPixels": number, - "ImageSelectorType": "string", - "MaxResults": number, - "NextToken": "string", - "SamplingInterval": number, - "StartTimestamp": number, - "StreamARN": "string", - "StreamName": "string", - "WidthPixels": number - } - -## URI Request Parameters - -The request does not use any URI parameters. - -## Request Body - -The request accepts the following data in JSON format. - -**EndTimestamp ** - - -The end timestamp for the range of images to be generated. If the time range between `StartTimestamp` and `EndTimestamp` is more than 300 seconds above `StartTimestamp`, you will receive an `IllegalArgumentException`. - -Type: Timestamp - -Required: Yes - -**Format ** - - -The format that will be used to encode the image. - -Type: String - -Valid Values: `JPEG | PNG` - -Required: Yes - -**FormatConfig ** - - -The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The `FormatConfig` key is the `JPEGQuality`, which indicates the JPEG quality key to be used to generate the image. The `FormatConfig` value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the `JPEGQuality` key will be set to 80. - -Type: String to string map - -Map Entries: Maximum number of 1 item. - -Valid Keys: `JPEGQuality` - -Value Length Constraints: Minimum length of 0. Maximum length of 256. - -Value Pattern: `^[a-zA-Z_0-9]+` - -Required: No - -**HeightPixels ** - - -The height of the output image that is used in conjunction with the `WidthPixels` parameter. When both `HeightPixels` and `WidthPixels` parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the `HeightPixels` parameter is provided, its original aspect ratio will be used to calculate the `WidthPixels` ratio. If neither parameter is provided, the original image size will be returned. - -Type: Integer - -Valid Range: Minimum value of 1. Maximum value of 2160. - -Required: No - -**ImageSelectorType ** - - -The origin of the Server or Producer timestamps to use to generate the images. - -Type: String - -Valid Values: `PRODUCER_TIMESTAMP | SERVER_TIMESTAMP` - -Required: Yes - -**MaxResults ** - - -The maximum number of images to be returned by the API. - -###### Note - -The default limit is 25 images per API response. Providing a `MaxResults` greater than this value will result in a page size of 25. Any additional results will be paginated. - -Type: Long - -Valid Range: Minimum value of 1. Maximum value of 100. - -Required: No - -**NextToken ** - - -A token that specifies where to start paginating the next set of Images. This is the `GetImages:NextToken` from a previously truncated response. - -Type: String - -Length Constraints: Minimum length of 1. Maximum length of 4096. - -Pattern: `[a-zA-Z0-9+/]+={0,2}` - -Required: No - -**SamplingInterval ** - - -The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms (5 images per second). If the timestamp range is less than the sampling interval, the image from the `startTimestamp` will be returned if available. - -Type: Integer - -Required: No - -**StartTimestamp ** - - -The starting point from which the images should be generated. This `StartTimestamp` must be within an inclusive range of timestamps for an image to be returned. - -Type: Timestamp - -Required: Yes - -**StreamARN ** - - -The Amazon Resource Name (ARN) of the stream from which to retrieve the images. 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 images. 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 - -**WidthPixels ** - - -The width of the output image that is used in conjunction with the `HeightPixels` parameter. When both `WidthPixels` and `HeightPixels` parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the `WidthPixels` parameter is provided or if only the `HeightPixels` is provided, a `ValidationException` will be thrown. If neither parameter is provided, the original image size from the stream will be returned. - -Type: Integer - -Valid Range: Minimum value of 1. Maximum value of 3840. - -Required: No - -## Response Syntax -