#[non_exhaustive]pub struct GetImagesInput { /* private fields */ }
Implementations
sourceimpl GetImagesInput
impl GetImagesInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetImages, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetImages, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<GetImages
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture GetImagesInput
.
sourceimpl 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
sourceimpl Clone for GetImagesInput
impl Clone for GetImagesInput
sourcefn clone(&self) -> GetImagesInput
fn clone(&self) -> GetImagesInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GetImagesInput
impl Debug for GetImagesInput
sourceimpl PartialEq<GetImagesInput> for GetImagesInput
impl PartialEq<GetImagesInput> for GetImagesInput
sourcefn eq(&self, other: &GetImagesInput) -> bool
fn eq(&self, other: &GetImagesInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
impl StructuralPartialEq for GetImagesInput
Auto Trait Implementations
impl RefUnwindSafe for GetImagesInput
impl Send for GetImagesInput
impl Sync for GetImagesInput
impl Unpin for GetImagesInput
impl UnwindSafe for GetImagesInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more