aws_sdk_imagebuilder/client/
list_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 [`ListImages`](crate::operation::list_images::builders::ListImagesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_images::builders::ListImagesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`owner(Ownership)`](crate::operation::list_images::builders::ListImagesFluentBuilder::owner) / [`set_owner(Option<Ownership>)`](crate::operation::list_images::builders::ListImagesFluentBuilder::set_owner):<br>required: **false**<br><p>Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.</p><br>
8    ///   - [`filters(Filter)`](crate::operation::list_images::builders::ListImagesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::list_images::builders::ListImagesFluentBuilder::set_filters):<br>required: **false**<br><p>Use the following filters to streamline results:</p> <ul>  <li>   <p><code>name</code></p></li>  <li>   <p><code>osVersion</code></p></li>  <li>   <p><code>platform</code></p></li>  <li>   <p><code>type</code></p></li>  <li>   <p><code>version</code></p></li> </ul><br>
9    ///   - [`by_name(bool)`](crate::operation::list_images::builders::ListImagesFluentBuilder::by_name) / [`set_by_name(Option<bool>)`](crate::operation::list_images::builders::ListImagesFluentBuilder::set_by_name):<br>required: **false**<br><p>Requests a list of images with a specific recipe name.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_images::builders::ListImagesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_images::builders::ListImagesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return in a single request.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_images::builders::ListImagesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_images::builders::ListImagesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to specify where to start paginating. Use the <code>nextToken</code> value from a previously truncated response.</p><br>
12    ///   - [`include_deprecated(bool)`](crate::operation::list_images::builders::ListImagesFluentBuilder::include_deprecated) / [`set_include_deprecated(Option<bool>)`](crate::operation::list_images::builders::ListImagesFluentBuilder::set_include_deprecated):<br>required: **false**<br><p>Includes deprecated images in the response list.</p><br>
13    /// - On success, responds with [`ListImagesOutput`](crate::operation::list_images::ListImagesOutput) with field(s):
14    ///   - [`request_id(Option<String>)`](crate::operation::list_images::ListImagesOutput::request_id): <p>The request ID that uniquely identifies this request.</p>
15    ///   - [`image_version_list(Option<Vec::<ImageVersion>>)`](crate::operation::list_images::ListImagesOutput::image_version_list): <p>The list of image semantic versions.</p><note>  <p>The semantic version has four nodes: <major>    .    <minor>     .     <patch>      /      <build>       . You can assign values for the first three, and can filter on all of them.      </build>     </patch>    </minor>   </major></p>  <p><b>Filtering:</b> You can use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.</p> </note>
16    ///   - [`next_token(Option<String>)`](crate::operation::list_images::ListImagesOutput::next_token): <p>The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.</p>
17    /// - On failure, responds with [`SdkError<ListImagesError>`](crate::operation::list_images::ListImagesError)
18    pub fn list_images(&self) -> crate::operation::list_images::builders::ListImagesFluentBuilder {
19        crate::operation::list_images::builders::ListImagesFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_imagebuilder/client/list_images.rs

aws_sdk_imagebuilder/client/
list_images.rs
