aws_sdk_iotsitewise/client/describe_execution.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 [`DescribeExecution`](crate::operation::describe_execution::builders::DescribeExecutionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`execution_id(impl Into<String>)`](crate::operation::describe_execution::builders::DescribeExecutionFluentBuilder::execution_id) / [`set_execution_id(Option<String>)`](crate::operation::describe_execution::builders::DescribeExecutionFluentBuilder::set_execution_id):<br>required: **true**<br><p>The ID of the execution.</p><br>
7 /// - On success, responds with [`DescribeExecutionOutput`](crate::operation::describe_execution::DescribeExecutionOutput) with field(s):
8 /// - [`execution_id(String)`](crate::operation::describe_execution::DescribeExecutionOutput::execution_id): <p>The ID of the execution.</p>
9 /// - [`action_type(Option<String>)`](crate::operation::describe_execution::DescribeExecutionOutput::action_type): <p>The type of action exectued.</p>
10 /// - [`target_resource(Option<TargetResource>)`](crate::operation::describe_execution::DescribeExecutionOutput::target_resource): <p>The resource the action will be taken on. This can include asset-based resources and computation model resources.</p>
11 /// - [`target_resource_version(String)`](crate::operation::describe_execution::DescribeExecutionOutput::target_resource_version): <p>The version of the target resource.</p>
12 /// - [`resolve_to(Option<ResolveTo>)`](crate::operation::describe_execution::DescribeExecutionOutput::resolve_to): <p>The detailed resource this execution resolves to.</p>
13 /// - [`execution_start_time(DateTime)`](crate::operation::describe_execution::DescribeExecutionOutput::execution_start_time): <p>The time the process started.</p>
14 /// - [`execution_end_time(Option<DateTime>)`](crate::operation::describe_execution::DescribeExecutionOutput::execution_end_time): <p>The time the process ended.</p>
15 /// - [`execution_status(Option<ExecutionStatus>)`](crate::operation::describe_execution::DescribeExecutionOutput::execution_status): <p>The status of the execution process.</p>
16 /// - [`execution_result(Option<HashMap::<String, String>>)`](crate::operation::describe_execution::DescribeExecutionOutput::execution_result): <p>The result of the execution.</p>
17 /// - [`execution_details(Option<HashMap::<String, String>>)`](crate::operation::describe_execution::DescribeExecutionOutput::execution_details): <p>Provides detailed information about the execution of your anomaly detection models. This includes model metrics and training timestamps for both training and inference actions.</p> <ul> <li> <p>The training action (Amazon Web Services/ANOMALY_DETECTION_TRAINING), includes performance metrics that help you compare different versions of your anomaly detection models. These metrics provide insights into the model's performance during the training process.</p></li> <li> <p>The inference action (Amazon Web Services/ANOMALY_DETECTION_INFERENCE), includes information about the results of executing your anomaly detection models. This helps you understand the output of your models and assess their performance.</p></li> </ul>
18 /// - [`execution_entity_version(Option<String>)`](crate::operation::describe_execution::DescribeExecutionOutput::execution_entity_version): <p>Entity version used for the execution.</p>
19 /// - On failure, responds with [`SdkError<DescribeExecutionError>`](crate::operation::describe_execution::DescribeExecutionError)
20 pub fn describe_execution(&self) -> crate::operation::describe_execution::builders::DescribeExecutionFluentBuilder {
21 crate::operation::describe_execution::builders::DescribeExecutionFluentBuilder::new(self.handle.clone())
22 }
23}