1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetImages`](crate::operation::get_images::builders::GetImagesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_images::builders::GetImagesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`stream_name(impl Into<String>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::stream_name) / [`set_stream_name(Option<String>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_stream_name): <p>The name of the stream from which to retrieve the images. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
    ///   - [`stream_arn(impl Into<String>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::stream_arn) / [`set_stream_arn(Option<String>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_stream_arn): <p>The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
    ///   - [`image_selector_type(ImageSelectorType)`](crate::operation::get_images::builders::GetImagesFluentBuilder::image_selector_type) / [`set_image_selector_type(Option<ImageSelectorType>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_image_selector_type): <p>The origin of the Server or Producer timestamps to use to generate the images.</p>
    ///   - [`start_timestamp(DateTime)`](crate::operation::get_images::builders::GetImagesFluentBuilder::start_timestamp) / [`set_start_timestamp(Option<DateTime>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_start_timestamp): <p>The starting point from which the images should be generated. This <code>StartTimestamp</code> must be within an inclusive range of timestamps for an image to be returned.</p>
    ///   - [`end_timestamp(DateTime)`](crate::operation::get_images::builders::GetImagesFluentBuilder::end_timestamp) / [`set_end_timestamp(Option<DateTime>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_end_timestamp): <p>The end timestamp for the range of images to be generated. If the time range between <code>StartTimestamp</code> and <code>EndTimestamp</code> is more than 300 seconds above <code>StartTimestamp</code>, you will receive an <code>IllegalArgumentException</code>.</p>
    ///   - [`sampling_interval(i32)`](crate::operation::get_images::builders::GetImagesFluentBuilder::sampling_interval) / [`set_sampling_interval(Option<i32>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_sampling_interval): <p>The time interval in milliseconds (ms) at which the images need to be generated from the stream, with a default of 3000 ms. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the <code>startTimestamp</code> will be returned if available. </p> <note>   <p>The minimum value of 200 ms is a hard limit.</p>  </note>
    ///   - [`format(Format)`](crate::operation::get_images::builders::GetImagesFluentBuilder::format) / [`set_format(Option<Format>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_format): <p>The format that will be used to encode the image.</p>
    ///   - [`format_config(FormatConfigKey, impl Into<String>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::format_config) / [`set_format_config(Option<HashMap<FormatConfigKey, String>>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_format_config): <p>The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The <code>FormatConfig</code> key is the <code>JPEGQuality</code>, which indicates the JPEG quality key to be used to generate the image. The <code>FormatConfig</code> 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 <code>JPEGQuality</code> key will be set to 80.</p>
    ///   - [`width_pixels(i32)`](crate::operation::get_images::builders::GetImagesFluentBuilder::width_pixels) / [`set_width_pixels(Option<i32>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_width_pixels): <p>The width of the output image that is used in conjunction with the <code>HeightPixels</code> parameter. When both <code>WidthPixels</code> and <code>HeightPixels</code> parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the <code>WidthPixels</code> parameter is provided or if only the <code>HeightPixels</code> is provided, a <code>ValidationException</code> will be thrown. If neither parameter is provided, the original image size from the stream will be returned.</p>
    ///   - [`height_pixels(i32)`](crate::operation::get_images::builders::GetImagesFluentBuilder::height_pixels) / [`set_height_pixels(Option<i32>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_height_pixels): <p>The height of the output image that is used in conjunction with the <code>WidthPixels</code> parameter. When both <code>HeightPixels</code> and <code>WidthPixels</code> parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the <code>HeightPixels</code> parameter is provided, its original aspect ratio will be used to calculate the <code>WidthPixels</code> ratio. If neither parameter is provided, the original image size will be returned.</p>
    ///   - [`max_results(i64)`](crate::operation::get_images::builders::GetImagesFluentBuilder::max_results) / [`set_max_results(Option<i64>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_max_results): <p>The maximum number of images to be returned by the API. </p> <note>   <p>The default limit is 25 images per API response. Providing a <code>MaxResults</code> greater than this value will result in a page size of 25. Any additional results will be paginated. </p>  </note>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_images::builders::GetImagesFluentBuilder::set_next_token): <p>A token that specifies where to start paginating the next set of Images. This is the <code>GetImages:NextToken</code> from a previously truncated response.</p>
    /// - On success, responds with [`GetImagesOutput`](crate::operation::get_images::GetImagesOutput) with field(s):
    ///   - [`images(Option<Vec<Image>>)`](crate::operation::get_images::GetImagesOutput::images): <p>The list of images generated from the video stream. If there is no media available for the given timestamp, the <code>NO_MEDIA</code> error will be listed in the output. If an error occurs while the image is being generated, the <code>MEDIA_ERROR</code> will be listed in the output as the cause of the missing image. </p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_images::GetImagesOutput::next_token): <p>The encrypted token that was used in the request to get more images.</p>
    /// - On failure, responds with [`SdkError<GetImagesError>`](crate::operation::get_images::GetImagesError)
    pub fn get_images(&self) -> crate::operation::get_images::builders::GetImagesFluentBuilder {
        crate::operation::get_images::builders::GetImagesFluentBuilder::new(self.handle.clone())
    }
}