aws-sdk-imagebuilder 1.126.0

AWS SDK for EC2 Image Builder
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetWorkflowStepExecution`](crate::operation::get_workflow_step_execution::builders::GetWorkflowStepExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`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>
    /// - On success, responds with [`GetWorkflowStepExecutionOutput`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput) with field(s):
    ///   - [`request_id(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::request_id): <p>The request ID that uniquely identifies this request.</p>
    ///   - [`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>
    ///   - [`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>
    ///   - [`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>
    ///   - [`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>
    ///   - [`name(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::name): <p>The name of the specified runtime instance of the workflow step.</p>
    ///   - [`description(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::description): <p>Describes the specified workflow step.</p>
    ///   - [`action(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::action): <p>The name of the action that the specified step performs.</p>
    ///   - [`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>
    ///   - [`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>
    ///   - [`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>
    ///   - [`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>
    ///   - [`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>
    ///   - [`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>
    ///   - [`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>
    ///   - [`on_failure(Option<String>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::on_failure): <p>The action to perform if the workflow step fails.</p>
    ///   - [`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>
    ///   - [`attempt_number(Option<i32>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::attempt_number): <p>The current attempt number for the specified runtime instance of the workflow step. The first run is attempt one. The number increases by one for each retry.</p>
    ///   - [`max_attempts(Option<i32>)`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionOutput::max_attempts): <p>The maximum number of attempts allowed for the specified runtime instance of the workflow step, based on the retry configuration in the workflow document. If the step doesn't configure retries, the maximum is one attempt.</p>
    /// - On failure, responds with [`SdkError<GetWorkflowStepExecutionError>`](crate::operation::get_workflow_step_execution::GetWorkflowStepExecutionError)
    pub fn get_workflow_step_execution(&self) -> crate::operation::get_workflow_step_execution::builders::GetWorkflowStepExecutionFluentBuilder {
        crate::operation::get_workflow_step_execution::builders::GetWorkflowStepExecutionFluentBuilder::new(self.handle.clone())
    }
}