aws_sdk_lightsail/client/get_blueprints.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 [`GetBlueprints`](crate::operation::get_blueprints::builders::GetBlueprintsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`include_inactive(bool)`](crate::operation::get_blueprints::builders::GetBlueprintsFluentBuilder::include_inactive) / [`set_include_inactive(Option<bool>)`](crate::operation::get_blueprints::builders::GetBlueprintsFluentBuilder::set_include_inactive):<br>required: **false**<br><p>A Boolean value that indicates whether to include inactive (unavailable) blueprints in the response of your request.</p><br>
7 /// - [`page_token(impl Into<String>)`](crate::operation::get_blueprints::builders::GetBlueprintsFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::get_blueprints::builders::GetBlueprintsFluentBuilder::set_page_token):<br>required: **false**<br><p>The token to advance to the next page of results from your request.</p> <p>To get a page token, perform an initial <code>GetBlueprints</code> request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.</p><br>
8 /// - [`app_category(AppCategory)`](crate::operation::get_blueprints::builders::GetBlueprintsFluentBuilder::app_category) / [`set_app_category(Option<AppCategory>)`](crate::operation::get_blueprints::builders::GetBlueprintsFluentBuilder::set_app_category):<br>required: **false**<br><p>Returns a list of blueprints that are specific to Lightsail for Research.</p><important> <p>You must use this parameter to view Lightsail for Research blueprints.</p> </important><br>
9 /// - On success, responds with [`GetBlueprintsOutput`](crate::operation::get_blueprints::GetBlueprintsOutput) with field(s):
10 /// - [`blueprints(Option<Vec::<Blueprint>>)`](crate::operation::get_blueprints::GetBlueprintsOutput::blueprints): <p>An array of key-value pairs that contains information about the available blueprints.</p>
11 /// - [`next_page_token(Option<String>)`](crate::operation::get_blueprints::GetBlueprintsOutput::next_page_token): <p>The token to advance to the next page of results from your request.</p> <p>A next page token is not returned if there are no more results to display.</p> <p>To get the next page of results, perform another <code>GetBlueprints</code> request and specify the next page token using the <code>pageToken</code> parameter.</p>
12 /// - On failure, responds with [`SdkError<GetBlueprintsError>`](crate::operation::get_blueprints::GetBlueprintsError)
13 pub fn get_blueprints(&self) -> crate::operation::get_blueprints::builders::GetBlueprintsFluentBuilder {
14 crate::operation::get_blueprints::builders::GetBlueprintsFluentBuilder::new(self.handle.clone())
15 }
16}