aws_sdk_imagebuilder/client/
list_image_recipes.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 [`ListImageRecipes`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`owner(Ownership)`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::owner) / [`set_owner(Option<Ownership>)`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::set_owner):<br>required: **false**<br><p>You can specify the recipe owner to filter results by that owner. By default, this request will only show image recipes owned by your account. To filter by a different owner, specify one of the <code>Valid Values</code> that are listed for this parameter.</p><br>
8    ///   - [`filters(Filter)`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::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>parentImage</code></p></li>  <li>   <p><code>platform</code></p></li> </ul><br>
9    ///   - [`max_results(i32)`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::set_max_results):<br>required: **false**<br><p>Specify the maximum number of items to return in a request.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</p><br>
11    /// - On success, responds with [`ListImageRecipesOutput`](crate::operation::list_image_recipes::ListImageRecipesOutput) with field(s):
12    ///   - [`request_id(Option<String>)`](crate::operation::list_image_recipes::ListImageRecipesOutput::request_id): <p>The request ID that uniquely identifies this request.</p>
13    ///   - [`image_recipe_summary_list(Option<Vec::<ImageRecipeSummary>>)`](crate::operation::list_image_recipes::ListImageRecipesOutput::image_recipe_summary_list): <p>A list of <code>ImageRecipeSummary</code> objects that contain identifying characteristics for the image recipe, such as the name, the Amazon Resource Name (ARN), and the date created, along with other key details.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_image_recipes::ListImageRecipesOutput::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>
15    /// - On failure, responds with [`SdkError<ListImageRecipesError>`](crate::operation::list_image_recipes::ListImageRecipesError)
16    pub fn list_image_recipes(&self) -> crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder {
17        crate::operation::list_image_recipes::builders::ListImageRecipesFluentBuilder::new(self.handle.clone())
18    }
19}