aws_sdk_iottwinmaker/client/get_scene.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 [`GetScene`](crate::operation::get_scene::builders::GetSceneFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`workspace_id(impl Into<String>)`](crate::operation::get_scene::builders::GetSceneFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::get_scene::builders::GetSceneFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace that contains the scene.</p><br>
7 /// - [`scene_id(impl Into<String>)`](crate::operation::get_scene::builders::GetSceneFluentBuilder::scene_id) / [`set_scene_id(Option<String>)`](crate::operation::get_scene::builders::GetSceneFluentBuilder::set_scene_id):<br>required: **true**<br><p>The ID of the scene.</p><br>
8 /// - On success, responds with [`GetSceneOutput`](crate::operation::get_scene::GetSceneOutput) with field(s):
9 /// - [`workspace_id(String)`](crate::operation::get_scene::GetSceneOutput::workspace_id): <p>The ID of the workspace that contains the scene.</p>
10 /// - [`scene_id(String)`](crate::operation::get_scene::GetSceneOutput::scene_id): <p>The ID of the scene.</p>
11 /// - [`content_location(String)`](crate::operation::get_scene::GetSceneOutput::content_location): <p>The relative path that specifies the location of the content definition file.</p>
12 /// - [`arn(String)`](crate::operation::get_scene::GetSceneOutput::arn): <p>The ARN of the scene.</p>
13 /// - [`creation_date_time(DateTime)`](crate::operation::get_scene::GetSceneOutput::creation_date_time): <p>The date and time when the scene was created.</p>
14 /// - [`update_date_time(DateTime)`](crate::operation::get_scene::GetSceneOutput::update_date_time): <p>The date and time when the scene was last updated.</p>
15 /// - [`description(Option<String>)`](crate::operation::get_scene::GetSceneOutput::description): <p>The description of the scene.</p>
16 /// - [`capabilities(Option<Vec::<String>>)`](crate::operation::get_scene::GetSceneOutput::capabilities): <p>A list of capabilities that the scene uses to render.</p>
17 /// - [`scene_metadata(Option<HashMap::<String, String>>)`](crate::operation::get_scene::GetSceneOutput::scene_metadata): <p>The response metadata.</p>
18 /// - [`generated_scene_metadata(Option<HashMap::<String, String>>)`](crate::operation::get_scene::GetSceneOutput::generated_scene_metadata): <p>The generated scene metadata.</p>
19 /// - [`error(Option<SceneError>)`](crate::operation::get_scene::GetSceneOutput::error): <p>The SceneResponse error.</p>
20 /// - On failure, responds with [`SdkError<GetSceneError>`](crate::operation::get_scene::GetSceneError)
21 pub fn get_scene(&self) -> crate::operation::get_scene::builders::GetSceneFluentBuilder {
22 crate::operation::get_scene::builders::GetSceneFluentBuilder::new(self.handle.clone())
23 }
24}