aws_sdk_deadline/client/
get_step.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 [`GetStep`](crate::operation::get_step::builders::GetStepFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`farm_id(impl Into<String>)`](crate::operation::get_step::builders::GetStepFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::get_step::builders::GetStepFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID for the step.</p><br>
7    ///   - [`queue_id(impl Into<String>)`](crate::operation::get_step::builders::GetStepFluentBuilder::queue_id) / [`set_queue_id(Option<String>)`](crate::operation::get_step::builders::GetStepFluentBuilder::set_queue_id):<br>required: **true**<br><p>The queue ID for the step.</p><br>
8    ///   - [`job_id(impl Into<String>)`](crate::operation::get_step::builders::GetStepFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_step::builders::GetStepFluentBuilder::set_job_id):<br>required: **true**<br><p>The job ID for the step.</p><br>
9    ///   - [`step_id(impl Into<String>)`](crate::operation::get_step::builders::GetStepFluentBuilder::step_id) / [`set_step_id(Option<String>)`](crate::operation::get_step::builders::GetStepFluentBuilder::set_step_id):<br>required: **true**<br><p>The step ID.</p><br>
10    /// - On success, responds with [`GetStepOutput`](crate::operation::get_step::GetStepOutput) with field(s):
11    ///   - [`step_id(String)`](crate::operation::get_step::GetStepOutput::step_id): <p>The step ID.</p>
12    ///   - [`name(String)`](crate::operation::get_step::GetStepOutput::name): <p>The name of the step.</p>
13    ///   - [`lifecycle_status(StepLifecycleStatus)`](crate::operation::get_step::GetStepOutput::lifecycle_status): <p>The life cycle status of the step.</p>
14    ///   - [`lifecycle_status_message(Option<String>)`](crate::operation::get_step::GetStepOutput::lifecycle_status_message): <p>A message that describes the lifecycle status of the step.</p>
15    ///   - [`task_run_status(TaskRunStatus)`](crate::operation::get_step::GetStepOutput::task_run_status): <p>The task run status for the job.</p>
16    ///   - [`task_run_status_counts(HashMap::<TaskRunStatus, i32>)`](crate::operation::get_step::GetStepOutput::task_run_status_counts): <p>The number of tasks running on the job.</p>
17    ///   - [`task_failure_retry_count(Option<i32>)`](crate::operation::get_step::GetStepOutput::task_failure_retry_count): <p>The total number of times tasks from the step failed and were retried.</p>
18    ///   - [`target_task_run_status(Option<StepTargetTaskRunStatus>)`](crate::operation::get_step::GetStepOutput::target_task_run_status): <p>The task status with which the job started.</p>
19    ///   - [`created_at(DateTime)`](crate::operation::get_step::GetStepOutput::created_at): <p>The date and time the resource was created.</p>
20    ///   - [`created_by(String)`](crate::operation::get_step::GetStepOutput::created_by): <p>The user or system that created this resource.</p>
21    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_step::GetStepOutput::updated_at): <p>The date and time the resource was updated.</p>
22    ///   - [`updated_by(Option<String>)`](crate::operation::get_step::GetStepOutput::updated_by): <p>The user or system that updated this resource.</p>
23    ///   - [`started_at(Option<DateTime>)`](crate::operation::get_step::GetStepOutput::started_at): <p>The date and time the resource started running.</p>
24    ///   - [`ended_at(Option<DateTime>)`](crate::operation::get_step::GetStepOutput::ended_at): <p>The date and time the resource ended running.</p>
25    ///   - [`dependency_counts(Option<DependencyCounts>)`](crate::operation::get_step::GetStepOutput::dependency_counts): <p>The number of dependencies in the step.</p>
26    ///   - [`required_capabilities(Option<StepRequiredCapabilities>)`](crate::operation::get_step::GetStepOutput::required_capabilities): <p>The required capabilities of the step.</p>
27    ///   - [`parameter_space(Option<ParameterSpace>)`](crate::operation::get_step::GetStepOutput::parameter_space): <p>A list of step parameters and the combination expression for the step.</p>
28    ///   - [`description(Option<String>)`](crate::operation::get_step::GetStepOutput::description): <p>The description of the step.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
29    /// - On failure, responds with [`SdkError<GetStepError>`](crate::operation::get_step::GetStepError)
30    pub fn get_step(&self) -> crate::operation::get_step::builders::GetStepFluentBuilder {
31        crate::operation::get_step::builders::GetStepFluentBuilder::new(self.handle.clone())
32    }
33}
aws_sdk_deadline/client/get_step.rs

aws_sdk_deadline/client/
get_step.rs
