aws_sdk_iot1clickprojects/client/
list_placements.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 [`ListPlacements`](crate::operation::list_placements::builders::ListPlacementsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_placements::builders::ListPlacementsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`project_name(impl Into<String>)`](crate::operation::list_placements::builders::ListPlacementsFluentBuilder::project_name) / [`set_project_name(Option<String>)`](crate::operation::list_placements::builders::ListPlacementsFluentBuilder::set_project_name):<br>required: **true**<br><p>The project containing the placements to be listed.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_placements::builders::ListPlacementsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_placements::builders::ListPlacementsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to retrieve the next set of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_placements::builders::ListPlacementsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_placements::builders::ListPlacementsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per request. If not set, a default value of 100 is used.</p><br>
10    /// - On success, responds with [`ListPlacementsOutput`](crate::operation::list_placements::ListPlacementsOutput) with field(s):
11    ///   - [`placements(Vec::<PlacementSummary>)`](crate::operation::list_placements::ListPlacementsOutput::placements): <p>An object listing the requested placements.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_placements::ListPlacementsOutput::next_token): <p>The token used to retrieve the next set of results - will be effectively empty if there are no further results.</p>
13    /// - On failure, responds with [`SdkError<ListPlacementsError>`](crate::operation::list_placements::ListPlacementsError)
14    pub fn list_placements(&self) -> crate::operation::list_placements::builders::ListPlacementsFluentBuilder {
15        crate::operation::list_placements::builders::ListPlacementsFluentBuilder::new(self.handle.clone())
16    }
17}