| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.KinesisVideoArchivedMedia.GetImages
Description
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
This operation returns paginated results.
Synopsis
- data GetImages = GetImages' {
- formatConfig :: Maybe (HashMap FormatConfigKey Text)
- heightPixels :: Maybe Natural
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- streamARN :: Maybe Text
- streamName :: Maybe Text
- widthPixels :: Maybe Natural
- imageSelectorType :: ImageSelectorType
- startTimestamp :: POSIX
- endTimestamp :: POSIX
- samplingInterval :: Natural
- format :: Format
- newGetImages :: ImageSelectorType -> UTCTime -> UTCTime -> Natural -> Format -> GetImages
- getImages_formatConfig :: Lens' GetImages (Maybe (HashMap FormatConfigKey Text))
- getImages_heightPixels :: Lens' GetImages (Maybe Natural)
- getImages_maxResults :: Lens' GetImages (Maybe Natural)
- getImages_nextToken :: Lens' GetImages (Maybe Text)
- getImages_streamARN :: Lens' GetImages (Maybe Text)
- getImages_streamName :: Lens' GetImages (Maybe Text)
- getImages_widthPixels :: Lens' GetImages (Maybe Natural)
- getImages_imageSelectorType :: Lens' GetImages ImageSelectorType
- getImages_startTimestamp :: Lens' GetImages UTCTime
- getImages_endTimestamp :: Lens' GetImages UTCTime
- getImages_samplingInterval :: Lens' GetImages Natural
- getImages_format :: Lens' GetImages Format
- data GetImagesResponse = GetImagesResponse' {}
- newGetImagesResponse :: Int -> GetImagesResponse
- getImagesResponse_images :: Lens' GetImagesResponse (Maybe [Image])
- getImagesResponse_nextToken :: Lens' GetImagesResponse (Maybe Text)
- getImagesResponse_httpStatus :: Lens' GetImagesResponse Int
Creating a Request
See: newGetImages smart constructor.
Constructors
| GetImages' | |
Fields
| |
Instances
Create a value of GetImages with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:formatConfig:GetImages', getImages_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.
$sel:heightPixels:GetImages', getImages_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.
$sel:maxResults:GetImages', getImages_maxResults - The maximum number of images to be returned by the API.
The default limit is 100 images per API response. The additional results will be paginated.
GetImages, getImages_nextToken - A token that specifies where to start paginating the next set of Images.
This is the GetImages:NextToken from a previously truncated response.
$sel:streamARN:GetImages', getImages_streamARN - The Amazon Resource Name (ARN) of the stream from which to retrieve the
images. You must specify either the StreamName or the StreamARN.
$sel:streamName:GetImages', getImages_streamName - The name of the stream from which to retrieve the images. You must
specify either the StreamName or the StreamARN.
$sel:widthPixels:GetImages', getImages_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.
$sel:imageSelectorType:GetImages', getImages_imageSelectorType - The origin of the Server or Producer timestamps to use to generate the
images.
GetImages, getImages_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.
GetImages, getImages_endTimestamp - The end timestamp for the range of images to be generated.
$sel:samplingInterval:GetImages', getImages_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
3000 ms. If the timestamp range is less than the sampling interval, the
Image from the startTimestamp will be returned if available.
The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.
$sel:format:GetImages', getImages_format - The format that will be used to encode the image.
Request Lenses
getImages_formatConfig :: Lens' GetImages (Maybe (HashMap FormatConfigKey Text)) Source #
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.
getImages_heightPixels :: Lens' GetImages (Maybe Natural) Source #
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.
getImages_maxResults :: Lens' GetImages (Maybe Natural) Source #
The maximum number of images to be returned by the API.
The default limit is 100 images per API response. The additional results will be paginated.
getImages_nextToken :: Lens' GetImages (Maybe Text) Source #
A token that specifies where to start paginating the next set of Images.
This is the GetImages:NextToken from a previously truncated response.
getImages_streamARN :: Lens' GetImages (Maybe Text) Source #
The Amazon Resource Name (ARN) of the stream from which to retrieve the
images. You must specify either the StreamName or the StreamARN.
getImages_streamName :: Lens' GetImages (Maybe Text) Source #
The name of the stream from which to retrieve the images. You must
specify either the StreamName or the StreamARN.
getImages_widthPixels :: Lens' GetImages (Maybe Natural) Source #
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.
getImages_imageSelectorType :: Lens' GetImages ImageSelectorType Source #
The origin of the Server or Producer timestamps to use to generate the images.
getImages_startTimestamp :: Lens' GetImages UTCTime Source #
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.
getImages_endTimestamp :: Lens' GetImages UTCTime Source #
The end timestamp for the range of images to be generated.
getImages_samplingInterval :: Lens' GetImages Natural Source #
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
3000 ms. If the timestamp range is less than the sampling interval, the
Image from the startTimestamp will be returned if available.
The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.
getImages_format :: Lens' GetImages Format Source #
The format that will be used to encode the image.
Destructuring the Response
data GetImagesResponse Source #
See: newGetImagesResponse smart constructor.
Constructors
| GetImagesResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> GetImagesResponse |
Create a value of GetImagesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:images:GetImagesResponse', getImagesResponse_images - The list of images generated from the video stream. If there is no media
available for the given timestamp, the NO_MEDIA error will be listed
in the output. If an error occurs while the image is being generated,
the MEDIA_ERROR will be listed in the output as the cause of the
missing image.
GetImages, getImagesResponse_nextToken - The encrypted token that was used in the request to get more images.
$sel:httpStatus:GetImagesResponse', getImagesResponse_httpStatus - The response's http status code.
Response Lenses
getImagesResponse_images :: Lens' GetImagesResponse (Maybe [Image]) Source #
The list of images generated from the video stream. If there is no media
available for the given timestamp, the NO_MEDIA error will be listed
in the output. If an error occurs while the image is being generated,
the MEDIA_ERROR will be listed in the output as the cause of the
missing image.
getImagesResponse_nextToken :: Lens' GetImagesResponse (Maybe Text) Source #
The encrypted token that was used in the request to get more images.
getImagesResponse_httpStatus :: Lens' GetImagesResponse Int Source #
The response's http status code.