aws_sdk_iottwinmaker/client/
list_scenes.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 [`ListScenes`](crate::operation::list_scenes::builders::ListScenesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_scenes::builders::ListScenesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workspace_id(impl Into<String>)`](crate::operation::list_scenes::builders::ListScenesFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::list_scenes::builders::ListScenesFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace that contains the scenes.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_scenes::builders::ListScenesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_scenes::builders::ListScenesFluentBuilder::set_max_results):<br>required: **false**<br><p>Specifies the maximum number of results to display.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_scenes::builders::ListScenesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_scenes::builders::ListScenesFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies the next page of results.</p><br>
10    /// - On success, responds with [`ListScenesOutput`](crate::operation::list_scenes::ListScenesOutput) with field(s):
11    ///   - [`scene_summaries(Option<Vec::<SceneSummary>>)`](crate::operation::list_scenes::ListScenesOutput::scene_summaries): <p>A list of objects that contain information about the scenes.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_scenes::ListScenesOutput::next_token): <p>The string that specifies the next page of results.</p>
13    /// - On failure, responds with [`SdkError<ListScenesError>`](crate::operation::list_scenes::ListScenesError)
14    pub fn list_scenes(&self) -> crate::operation::list_scenes::builders::ListScenesFluentBuilder {
15        crate::operation::list_scenes::builders::ListScenesFluentBuilder::new(self.handle.clone())
16    }
17}