aws_sdk_iotfleetwise/client/
get_state_template.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 [`GetStateTemplate`](crate::operation::get_state_template::builders::GetStateTemplateFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identifier(impl Into<String>)`](crate::operation::get_state_template::builders::GetStateTemplateFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_state_template::builders::GetStateTemplateFluentBuilder::set_identifier):<br>required: **true**<br><p>A unique, service-generated identifier.</p><br>
7    /// - On success, responds with [`GetStateTemplateOutput`](crate::operation::get_state_template::GetStateTemplateOutput) with field(s):
8    ///   - [`name(Option<String>)`](crate::operation::get_state_template::GetStateTemplateOutput::name): <p>The name of the state template.</p>
9    ///   - [`arn(Option<String>)`](crate::operation::get_state_template::GetStateTemplateOutput::arn): <p>The Amazon Resource Name (ARN) of the state template.</p>
10    ///   - [`description(Option<String>)`](crate::operation::get_state_template::GetStateTemplateOutput::description): <p>A brief description of the state template.</p>
11    ///   - [`signal_catalog_arn(Option<String>)`](crate::operation::get_state_template::GetStateTemplateOutput::signal_catalog_arn): <p>The ARN of the signal catalog associated with the state template.</p>
12    ///   - [`state_template_properties(Option<Vec::<String>>)`](crate::operation::get_state_template::GetStateTemplateOutput::state_template_properties): <p>A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.</p>
13    ///   - [`data_extra_dimensions(Option<Vec::<String>>)`](crate::operation::get_state_template::GetStateTemplateOutput::data_extra_dimensions): <p>A list of vehicle attributes associated with the payload published on the state template's MQTT topic.</p> <p>Default: An empty array</p>
14    ///   - [`metadata_extra_dimensions(Option<Vec::<String>>)`](crate::operation::get_state_template::GetStateTemplateOutput::metadata_extra_dimensions): <p>A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.</p> <p>Default: An empty array</p>
15    ///   - [`creation_time(Option<DateTime>)`](crate::operation::get_state_template::GetStateTemplateOutput::creation_time): <p>The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).</p>
16    ///   - [`last_modification_time(Option<DateTime>)`](crate::operation::get_state_template::GetStateTemplateOutput::last_modification_time): <p>The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).</p>
17    ///   - [`id(Option<String>)`](crate::operation::get_state_template::GetStateTemplateOutput::id): <p>The unique ID of the state template.</p>
18    /// - On failure, responds with [`SdkError<GetStateTemplateError>`](crate::operation::get_state_template::GetStateTemplateError)
19    pub fn get_state_template(&self) -> crate::operation::get_state_template::builders::GetStateTemplateFluentBuilder {
20        crate::operation::get_state_template::builders::GetStateTemplateFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_iotfleetwise/client/get_state_template.rs

aws_sdk_iotfleetwise/client/
get_state_template.rs
