#[non_exhaustive]pub struct GetImagesInput { /* private fields */ }
Implementations§
source§impl GetImagesInput
impl GetImagesInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetImages, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetImages, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<GetImages
>
Examples found in repository?
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetImages,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetImagesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetImagesOutput,
aws_smithy_http::result::SdkError<crate::error::GetImagesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture GetImagesInput
.
source§impl GetImagesInput
impl GetImagesInput
sourcepub fn stream_name(&self) -> Option<&str>
pub fn stream_name(&self) -> Option<&str>
The name of the stream from which to retrieve the images. You must specify either the StreamName
or the StreamARN
.
sourcepub fn stream_arn(&self) -> Option<&str>
pub fn stream_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName
or the StreamARN
.
sourcepub fn image_selector_type(&self) -> Option<&ImageSelectorType>
pub fn image_selector_type(&self) -> Option<&ImageSelectorType>
The origin of the Server or Producer timestamps to use to generate the images.
sourcepub fn start_timestamp(&self) -> Option<&DateTime>
pub fn start_timestamp(&self) -> Option<&DateTime>
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.
sourcepub fn end_timestamp(&self) -> Option<&DateTime>
pub fn end_timestamp(&self) -> Option<&DateTime>
The end timestamp for the range of images to be generated.
sourcepub fn sampling_interval(&self) -> Option<i32>
pub fn sampling_interval(&self) -> Option<i32>
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.
sourcepub fn format_config(&self) -> Option<&HashMap<FormatConfigKey, String>>
pub fn format_config(&self) -> Option<&HashMap<FormatConfigKey, String>>
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.
sourcepub fn width_pixels(&self) -> Option<i32>
pub fn width_pixels(&self) -> Option<i32>
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.
sourcepub fn height_pixels(&self) -> Option<i32>
pub fn height_pixels(&self) -> Option<i32>
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.
sourcepub fn max_results(&self) -> Option<i64>
pub fn max_results(&self) -> Option<i64>
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.
sourcepub fn next_token(&self) -> Option<&str>
pub fn next_token(&self) -> Option<&str>
A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken
from a previously truncated response.
Trait Implementations§
source§impl Clone for GetImagesInput
impl Clone for GetImagesInput
source§fn clone(&self) -> GetImagesInput
fn clone(&self) -> GetImagesInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more