aws_sdk_robomaker/client/
describe_world.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 [`DescribeWorld`](crate::operation::describe_world::builders::DescribeWorldFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`world(impl Into<String>)`](crate::operation::describe_world::builders::DescribeWorldFluentBuilder::world) / [`set_world(Option<String>)`](crate::operation::describe_world::builders::DescribeWorldFluentBuilder::set_world):<br>required: **true**<br><p>The Amazon Resource Name (arn) of the world you want to describe.</p><br>
7    /// - On success, responds with [`DescribeWorldOutput`](crate::operation::describe_world::DescribeWorldOutput) with field(s):
8    ///   - [`arn(Option<String>)`](crate::operation::describe_world::DescribeWorldOutput::arn): <p>The Amazon Resource Name (arn) of the world.</p>
9    ///   - [`generation_job(Option<String>)`](crate::operation::describe_world::DescribeWorldOutput::generation_job): <p>The Amazon Resource Name (arn) of the world generation job that generated the world.</p>
10    ///   - [`template(Option<String>)`](crate::operation::describe_world::DescribeWorldOutput::template): <p>The world template.</p>
11    ///   - [`created_at(Option<DateTime>)`](crate::operation::describe_world::DescribeWorldOutput::created_at): <p>The time, in milliseconds since the epoch, when the world was created.</p>
12    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_world::DescribeWorldOutput::tags): <p>A map that contains tag keys and tag values that are attached to the world.</p>
13    ///   - [`world_description_body(Option<String>)`](crate::operation::describe_world::DescribeWorldOutput::world_description_body): <p>Returns the JSON formatted string that describes the contents of your world.</p>
14    /// - On failure, responds with [`SdkError<DescribeWorldError>`](crate::operation::describe_world::DescribeWorldError)
15    pub fn describe_world(&self) -> crate::operation::describe_world::builders::DescribeWorldFluentBuilder {
16        crate::operation::describe_world::builders::DescribeWorldFluentBuilder::new(self.handle.clone())
17    }
18}