aws_sdk_imagebuilder/client/
get_workflow_step_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 [`GetWorkflowStepExecution`](crate::operation::get_workflow_step_execution::builders::GetWorkflowStepExecutionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`step_execution_id(impl Into<String>)`](crate::operation::get_workflow_step_execution::builders::GetWorkflowStepExecutionFluentBuilder::step_execution_id) / [`set_step_execution_id(Option<String>)`](crate::operation::get_workflow_step_execution::builders::GetWorkflowStepExecutionFluentBuilder::set_step_execution_id):<br>required: **true**<br><p>Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.</p><br>
7    /// - On success, responds with [`GetWorkflowStepExecutionOutput`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput) with field(s):
8    ///   - [`request_id(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::request_id): <p>The request ID that uniquely identifies this request.</p>
9    ///   - [`step_execution_id(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::step_execution_id): <p>The unique identifier for the runtime version of the workflow step that you specified in the request.</p>
10    ///   - [`workflow_build_version_arn(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::workflow_build_version_arn): <p>The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.</p>
11    ///   - [`workflow_execution_id(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::workflow_execution_id): <p>The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.</p>
12    ///   - [`image_build_version_arn(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::image_build_version_arn): <p>The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.</p>
13    ///   - [`name(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::name): <p>The name of the specified runtime instance of the workflow step.</p>
14    ///   - [`description(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::description): <p>Describes the specified workflow step.</p>
15    ///   - [`action(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::action): <p>The name of the action that the specified step performs.</p>
16    ///   - [`status(Option<WorkflowStepExecutionStatus>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::status): <p>The current status for the specified runtime version of the workflow step.</p>
17    ///   - [`rollback_status(Option<WorkflowStepExecutionRollbackStatus>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::rollback_status): <p>Reports on the rollback status of the specified runtime version of the workflow step, if applicable.</p>
18    ///   - [`message(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::message): <p>The output message from the specified runtime instance of the workflow step, if applicable.</p>
19    ///   - [`inputs(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::inputs): <p>Input parameters that Image Builder provided for the specified runtime instance of the workflow step.</p>
20    ///   - [`outputs(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::outputs): <p>The file names that the specified runtime version of the workflow step created as output.</p>
21    ///   - [`start_time(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::start_time): <p>The timestamp when the specified runtime version of the workflow step started.</p>
22    ///   - [`end_time(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::end_time): <p>The timestamp when the specified runtime instance of the workflow step finished.</p>
23    ///   - [`on_failure(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::on_failure): <p>The action to perform if the workflow step fails.</p>
24    ///   - [`timeout_seconds(Option<i32>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::timeout_seconds): <p>The maximum duration in seconds for this step to complete its action.</p>
25    /// - On failure, responds with [`SdkError<GetWorkflowStepExecutionError>`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionError)
26    pub fn get_workflow_step_execution(&self) -> crate::operation::get_workflow_step_execution::builders::GetWorkflowStepExecutionFluentBuilder {
27        crate::operation::get_workflow_step_execution::builders::GetWorkflowStepExecutionFluentBuilder::new(self.handle.clone())
28    }
29}
aws_sdk_imagebuilder/client/get_workflow_step_execution.rs

aws_sdk_imagebuilder/client/
get_workflow_step_execution.rs
