aws_sdk_iotsitewise/client/
describe_computation_model.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 [`DescribeComputationModel`](crate::operation::describe_computation_model::builders::DescribeComputationModelFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`computation_model_id(impl Into<String>)`](crate::operation::describe_computation_model::builders::DescribeComputationModelFluentBuilder::computation_model_id) / [`set_computation_model_id(Option<String>)`](crate::operation::describe_computation_model::builders::DescribeComputationModelFluentBuilder::set_computation_model_id):<br>required: **true**<br><p>The ID of the computation model.</p><br>
7    ///   - [`computation_model_version(impl Into<String>)`](crate::operation::describe_computation_model::builders::DescribeComputationModelFluentBuilder::computation_model_version) / [`set_computation_model_version(Option<String>)`](crate::operation::describe_computation_model::builders::DescribeComputationModelFluentBuilder::set_computation_model_version):<br>required: **false**<br><p>The version of the computation model.</p><br>
8    /// - On success, responds with [`DescribeComputationModelOutput`](crate::operation::describe_computation_model::DescribeComputationModelOutput) with field(s):
9    ///   - [`computation_model_id(String)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_id): <p>The ID of the computation model.</p>
10    ///   - [`computation_model_arn(String)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_arn): <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the computation model, which has the following format.</p> <p><code>arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}</code></p>
11    ///   - [`computation_model_name(String)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_name): <p>The name of the computation model.</p>
12    ///   - [`computation_model_description(Option<String>)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_description): <p>The description of the computation model.</p>
13    ///   - [`computation_model_configuration(Option<ComputationModelConfiguration>)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_configuration): <p>The configuration for the computation model.</p>
14    ///   - [`computation_model_data_binding(HashMap::<String, ComputationModelDataBindingValue>)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_data_binding): <p>The data binding for the computation model. Key is a variable name defined in configuration. Value is a <code>ComputationModelDataBindingValue</code> referenced by the variable.</p>
15    ///   - [`computation_model_creation_date(DateTime)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_creation_date): <p>The model creation date, in Unix epoch time.</p>
16    ///   - [`computation_model_last_update_date(DateTime)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_last_update_date): <p>The date the model was last updated, in Unix epoch time.</p>
17    ///   - [`computation_model_status(Option<ComputationModelStatus>)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_status): <p>The current status of the asset model, which contains a state and an error message if any.</p>
18    ///   - [`computation_model_version(String)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::computation_model_version): <p>The version of the computation model.</p>
19    ///   - [`action_definitions(Vec::<ActionDefinition>)`](crate::operation::describe_computation_model::DescribeComputationModelOutput::action_definitions): <p>The available actions for this computation model.</p>
20    /// - On failure, responds with [`SdkError<DescribeComputationModelError>`](crate::operation::describe_computation_model::DescribeComputationModelError)
21    pub fn describe_computation_model(&self) -> crate::operation::describe_computation_model::builders::DescribeComputationModelFluentBuilder {
22        crate::operation::describe_computation_model::builders::DescribeComputationModelFluentBuilder::new(self.handle.clone())
23    }
24}