aws_sdk_mwaaserverless/client/
get_task_instance.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 [`GetTaskInstance`](crate::operation::get_task_instance::builders::GetTaskInstanceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workflow_arn(impl Into<String>)`](crate::operation::get_task_instance::builders::GetTaskInstanceFluentBuilder::workflow_arn) / [`set_workflow_arn(Option<String>)`](crate::operation::get_task_instance::builders::GetTaskInstanceFluentBuilder::set_workflow_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the workflow that contains the task instance.</p><br>
7    ///   - [`task_instance_id(impl Into<String>)`](crate::operation::get_task_instance::builders::GetTaskInstanceFluentBuilder::task_instance_id) / [`set_task_instance_id(Option<String>)`](crate::operation::get_task_instance::builders::GetTaskInstanceFluentBuilder::set_task_instance_id):<br>required: **true**<br><p>The unique identifier of the task instance to retrieve.</p><br>
8    ///   - [`run_id(impl Into<String>)`](crate::operation::get_task_instance::builders::GetTaskInstanceFluentBuilder::run_id) / [`set_run_id(Option<String>)`](crate::operation::get_task_instance::builders::GetTaskInstanceFluentBuilder::set_run_id):<br>required: **true**<br><p>The unique identifier of the workflow run that contains the task instance.</p><br>
9    /// - On success, responds with [`GetTaskInstanceOutput`](crate::operation::get_task_instance::GetTaskInstanceOutput) with field(s):
10    ///   - [`workflow_arn(String)`](crate::operation::get_task_instance::GetTaskInstanceOutput::workflow_arn): <p>The Amazon Resource Name (ARN) of the workflow that contains this task instance.</p>
11    ///   - [`run_id(String)`](crate::operation::get_task_instance::GetTaskInstanceOutput::run_id): <p>The unique identifier of the workflow run that contains this task instance.</p>
12    ///   - [`task_instance_id(String)`](crate::operation::get_task_instance::GetTaskInstanceOutput::task_instance_id): <p>The unique identifier of this task instance.</p>
13    ///   - [`workflow_version(Option<String>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::workflow_version): <p>The version of the workflow that contains this task instance.</p>
14    ///   - [`status(Option<TaskInstanceStatus>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::status): <p>The current status of the task instance.</p>
15    ///   - [`duration_in_seconds(Option<i32>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::duration_in_seconds): <p>The duration of the task instance execution in seconds. This value is null if the task is not complete.</p>
16    ///   - [`operator_name(Option<String>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::operator_name): <p>The name of the Apache Airflow operator used for this task instance.</p>
17    ///   - [`modified_at(Option<DateTime>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::modified_at): <p>The timestamp when the task instance was last modified, in ISO 8601 date-time format.</p>
18    ///   - [`ended_at(Option<DateTime>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::ended_at): <p>The timestamp when the task instance completed execution, in ISO 8601 date-time format. This value is null if the task is not complete.</p>
19    ///   - [`started_at(Option<DateTime>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::started_at): <p>The timestamp when the task instance started execution, in ISO 8601 date-time format. This value is null if the task has not started.</p>
20    ///   - [`attempt_number(Option<i32>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::attempt_number): <p>The attempt number for this task instance.</p>
21    ///   - [`error_message(Option<String>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::error_message): <p>The error message if the task instance failed. This value is null if the task completed successfully.</p>
22    ///   - [`task_id(Option<String>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::task_id): <p>The unique identifier of the task definition within the workflow.</p>
23    ///   - [`log_stream(Option<String>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::log_stream): <p>The CloudWatch log stream name for this task instance execution.</p>
24    ///   - [`xcom(Option<HashMap::<String, String>>)`](crate::operation::get_task_instance::GetTaskInstanceOutput::xcom): <p>Cross-communication data exchanged between tasks in the workflow execution.</p>
25    /// - On failure, responds with [`SdkError<GetTaskInstanceError>`](crate::operation::get_task_instance::GetTaskInstanceError)
26    pub fn get_task_instance(&self) -> crate::operation::get_task_instance::builders::GetTaskInstanceFluentBuilder {
27        crate::operation::get_task_instance::builders::GetTaskInstanceFluentBuilder::new(self.handle.clone())
28    }
29}