aws_sdk_appstream/client/
describe_images.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeImages`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`names(impl Into<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::names) / [`set_names(Option<Vec::<String>>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_names):<br>required: **false**<br><p>The names of the public or private images to describe.</p><br>
8    ///   - [`arns(impl Into<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::arns) / [`set_arns(Option<Vec::<String>>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_arns):<br>required: **false**<br><p>The ARNs of the public, private, and shared images to describe.</p><br>
9    ///   - [`r#type(VisibilityType)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::type) / [`set_type(Option<VisibilityType>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_type):<br>required: **false**<br><p>The type of image (public, private, or shared) to describe.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum size of each page of results.</p><br>
12    /// - On success, responds with [`DescribeImagesOutput`](crate::operation::describe_images::DescribeImagesOutput) with field(s):
13    ///   - [`images(Option<Vec::<Image>>)`](crate::operation::describe_images::DescribeImagesOutput::images): <p>Information about the images.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_images::DescribeImagesOutput::next_token): <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
15    /// - On failure, responds with [`SdkError<DescribeImagesError>`](crate::operation::describe_images::DescribeImagesError)
16    pub fn describe_images(&self) -> crate::operation::describe_images::builders::DescribeImagesFluentBuilder {
17        crate::operation::describe_images::builders::DescribeImagesFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_appstream/client/describe_images.rs

aws_sdk_appstream/client/
describe_images.rs
