aws_sdk_mwaaserverless/client/
start_workflow_run.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 [`StartWorkflowRun`](crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workflow_arn(impl Into<String>)`](crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder::workflow_arn) / [`set_workflow_arn(Option<String>)`](crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder::set_workflow_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the workflow you want to run.</p><br>
7    ///   - [`client_token(impl Into<String>)`](crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow run requests.</p><br>
8    ///   - [`override_parameters(impl Into<String>, Document)`](crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder::override_parameters) / [`set_override_parameters(Option<HashMap::<String, Document>>)`](crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder::set_override_parameters):<br>required: **false**<br><p>Optional parameters to override default workflow parameters for this specific run. These parameters are passed to the workflow during execution and can be used to customize behavior without modifying the workflow definition. Parameters are made available as environment variables to tasks and you can reference them within the YAML workflow definition using standard parameter substitution syntax.</p><br>
9    ///   - [`workflow_version(impl Into<String>)`](crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder::workflow_version) / [`set_workflow_version(Option<String>)`](crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder::set_workflow_version):<br>required: **false**<br><p>Optional. The specific version of the workflow to execute. If not specified, the latest version is used.</p><br>
10    /// - On success, responds with [`StartWorkflowRunOutput`](crate::operation::start_workflow_run::StartWorkflowRunOutput) with field(s):
11    ///   - [`run_id(Option<String>)`](crate::operation::start_workflow_run::StartWorkflowRunOutput::run_id): <p>The unique identifier of the newly started workflow run.</p>
12    ///   - [`status(Option<WorkflowRunStatus>)`](crate::operation::start_workflow_run::StartWorkflowRunOutput::status): <p>The initial status of the workflow run. This is typically <code>STARTING</code> when you first create the run.</p>
13    ///   - [`started_at(Option<DateTime>)`](crate::operation::start_workflow_run::StartWorkflowRunOutput::started_at): <p>The timestamp when the workflow run was started, in ISO 8601 date-time format.</p>
14    /// - On failure, responds with [`SdkError<StartWorkflowRunError>`](crate::operation::start_workflow_run::StartWorkflowRunError)
15    pub fn start_workflow_run(&self) -> crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder {
16        crate::operation::start_workflow_run::builders::StartWorkflowRunFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_mwaaserverless/client/start_workflow_run.rs

aws_sdk_mwaaserverless/client/
start_workflow_run.rs
