1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartWorkflowExecution`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain(impl Into<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain in which the workflow execution is created.</p> <p>The specified string must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (<code>\u0000-\u001f</code> | <code>\u007f-\u009f</code>). Also, it must <i>not</i> be the literal string <code>arn</code>.</p><br>
    ///   - [`workflow_id(impl Into<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::workflow_id) / [`set_workflow_id(Option<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_workflow_id):<br>required: **true**<br><p>The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a <i>restart</i> of a previous execution. You cannot have two open workflow executions with the same <code>workflowId</code> at the same time within the same domain.</p> <p>The specified string must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (<code>\u0000-\u001f</code> | <code>\u007f-\u009f</code>). Also, it must <i>not</i> be the literal string <code>arn</code>.</p><br>
    ///   - [`workflow_type(WorkflowType)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::workflow_type) / [`set_workflow_type(Option<WorkflowType>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_workflow_type):<br>required: **true**<br><p>The type of the workflow to start.</p><br>
    ///   - [`task_list(TaskList)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::task_list) / [`set_task_list(Option<TaskList>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_task_list):<br>required: **false**<br><p>The task list to use for the decision tasks generated for this workflow execution. This overrides the <code>defaultTaskList</code> specified when registering the workflow type.</p><note>  <p>A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.</p> </note> <p>The specified string must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (<code>\u0000-\u001f</code> | <code>\u007f-\u009f</code>). Also, it must <i>not</i> be the literal string <code>arn</code>.</p><br>
    ///   - [`task_priority(impl Into<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::task_priority) / [`set_task_priority(Option<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_task_priority):<br>required: **false**<br><p>The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647). Higher numbers indicate higher priority.</p> <p>For more information about setting task priority, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html">Setting Task Priority</a> in the <i>Amazon SWF Developer Guide</i>.</p><br>
    ///   - [`input(impl Into<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::input) / [`set_input(Option<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_input):<br>required: **false**<br><p>The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This <code>input</code> is made available to the new workflow execution in the <code>WorkflowExecutionStarted</code> history event.</p><br>
    ///   - [`execution_start_to_close_timeout(impl Into<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::execution_start_to_close_timeout) / [`set_execution_start_to_close_timeout(Option<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_execution_start_to_close_timeout):<br>required: **false**<br><p>The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.</p> <p>The duration is specified in seconds; an integer greater than or equal to <code>0</code>. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.</p><note>  <p>An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.</p> </note><br>
    ///   - [`tag_list(impl Into<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::tag_list) / [`set_tag_list(Option<Vec::<String>>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_tag_list):<br>required: **false**<br><p>The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling <code>ListOpenWorkflowExecutions</code> or <code>ListClosedWorkflowExecutions</code> and specifying a <code>TagFilter</code>.</p><br>
    ///   - [`task_start_to_close_timeout(impl Into<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::task_start_to_close_timeout) / [`set_task_start_to_close_timeout(Option<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_task_start_to_close_timeout):<br>required: **false**<br><p>Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the <code>defaultTaskStartToCloseTimout</code> specified when registering the workflow type using <code>RegisterWorkflowType</code>.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p><note>  <p>A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.</p> </note><br>
    ///   - [`child_policy(ChildPolicy)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::child_policy) / [`set_child_policy(Option<ChildPolicy>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_child_policy):<br>required: **false**<br><p>If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the <code>TerminateWorkflowExecution</code> action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using <code>RegisterWorkflowType</code>.</p> <p>The supported child policies are:</p> <ul>  <li>   <p><code>TERMINATE</code> – The child executions are terminated.</p></li>  <li>   <p><code>REQUEST_CANCEL</code> – A request to cancel is attempted for each child execution by recording a <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.</p></li>  <li>   <p><code>ABANDON</code> – No action is taken. The child executions continue to run.</p></li> </ul><note>  <p>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.</p> </note><br>
    ///   - [`lambda_role(impl Into<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::lambda_role) / [`set_lambda_role(Option<String>)`](crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::set_lambda_role):<br>required: **false**<br><p>The IAM role to attach to this workflow execution.</p><note>  <p>Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a <code>ScheduleLambdaFunctionFailed</code> history event. For more information, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html">https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html</a> in the <i>Amazon SWF Developer Guide</i>.</p> </note><br>
    /// - On success, responds with [`StartWorkflowExecutionOutput`](crate::operation::start_workflow_execution::StartWorkflowExecutionOutput) with field(s):
    ///   - [`run_id(Option<String>)`](crate::operation::start_workflow_execution::StartWorkflowExecutionOutput::run_id): <p>The <code>runId</code> of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.</p>
    /// - On failure, responds with [`SdkError<StartWorkflowExecutionError>`](crate::operation::start_workflow_execution::StartWorkflowExecutionError)
    pub fn start_workflow_execution(&self) -> crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder {
        crate::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder::new(self.handle.clone())
    }
}