aws_sdk_imagebuilder/client/list_workflow_step_executions.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 [`ListWorkflowStepExecutions`](crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`max_results(i32)`](crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum items to return in a request.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</p><br>
9 /// - [`workflow_execution_id(impl Into<String>)`](crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder::workflow_execution_id) / [`set_workflow_execution_id(Option<String>)`](crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder::set_workflow_execution_id):<br>required: **true**<br><p>The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.</p><br>
10 /// - On success, responds with [`ListWorkflowStepExecutionsOutput`](crate::operation::list_workflow_step_executions::ListWorkflowStepExecutionsOutput) with field(s):
11 /// - [`request_id(Option<String>)`](crate::operation::list_workflow_step_executions::ListWorkflowStepExecutionsOutput::request_id): <p>The request ID that uniquely identifies this request.</p>
12 /// - [`steps(Option<Vec::<WorkflowStepMetadata>>)`](crate::operation::list_workflow_step_executions::ListWorkflowStepExecutionsOutput::steps): <p>Contains an array of runtime details that represents each step in this runtime instance of the workflow.</p>
13 /// - [`workflow_build_version_arn(Option<String>)`](crate::operation::list_workflow_step_executions::ListWorkflowStepExecutionsOutput::workflow_build_version_arn): <p>The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.</p>
14 /// - [`workflow_execution_id(Option<String>)`](crate::operation::list_workflow_step_executions::ListWorkflowStepExecutionsOutput::workflow_execution_id): <p>The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.</p>
15 /// - [`image_build_version_arn(Option<String>)`](crate::operation::list_workflow_step_executions::ListWorkflowStepExecutionsOutput::image_build_version_arn): <p>The image build version resource ARN that's associated with the specified runtime instance of the workflow.</p>
16 /// - [`message(Option<String>)`](crate::operation::list_workflow_step_executions::ListWorkflowStepExecutionsOutput::message): <p>The output message from the list action, if applicable.</p>
17 /// - [`next_token(Option<String>)`](crate::operation::list_workflow_step_executions::ListWorkflowStepExecutionsOutput::next_token): <p>The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.</p>
18 /// - On failure, responds with [`SdkError<ListWorkflowStepExecutionsError>`](crate::operation::list_workflow_step_executions::ListWorkflowStepExecutionsError)
19 pub fn list_workflow_step_executions(
20 &self,
21 ) -> crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder {
22 crate::operation::list_workflow_step_executions::builders::ListWorkflowStepExecutionsFluentBuilder::new(self.handle.clone())
23 }
24}