aws_sdk_workspaces/client/
describe_workspace_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 [`DescribeWorkspaceImages`](crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`image_ids(impl Into<String>)`](crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder::image_ids) / [`set_image_ids(Option<Vec::<String>>)`](crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder::set_image_ids):<br>required: **false**<br><p>The identifier of the image.</p><br>
7    ///   - [`image_type(ImageType)`](crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder::image_type) / [`set_image_type(Option<ImageType>)`](crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder::set_image_type):<br>required: **false**<br><p>The type (owned or shared) of the image.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder::set_next_token):<br>required: **false**<br><p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return.</p><br>
10    /// - On success, responds with [`DescribeWorkspaceImagesOutput`](crate::operation::describe_workspace_images::DescribeWorkspaceImagesOutput) with field(s):
11    ///   - [`images(Option<Vec::<WorkspaceImage>>)`](crate::operation::describe_workspace_images::DescribeWorkspaceImagesOutput::images): <p>Information about the images.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::describe_workspace_images::DescribeWorkspaceImagesOutput::next_token): <p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p>
13    /// - On failure, responds with [`SdkError<DescribeWorkspaceImagesError>`](crate::operation::describe_workspace_images::DescribeWorkspaceImagesError)
14    pub fn describe_workspace_images(&self) -> crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder {
15        crate::operation::describe_workspace_images::builders::DescribeWorkspaceImagesFluentBuilder::new(self.handle.clone())
16    }
17}