Struct aws_sdk_swf::operation::start_workflow_execution::builders::StartWorkflowExecutionFluentBuilder
source · pub struct StartWorkflowExecutionFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartWorkflowExecution
.
Starts an execution of the workflow type in the specified domain using the provided workflowId
and input data.
This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
Constrain the following parameters by using a
Condition
element with the appropriate keys.-
tagList.member.0
: The key isswf:tagList.member.0
. -
tagList.member.1
: The key isswf:tagList.member.1
. -
tagList.member.2
: The key isswf:tagList.member.2
. -
tagList.member.3
: The key isswf:tagList.member.3
. -
tagList.member.4
: The key isswf:tagList.member.4
. -
taskList
: String constraint. The key isswf:taskList.name
. -
workflowType.name
: String constraint. The key isswf:workflowType.name
. -
workflowType.version
: String constraint. The key isswf:workflowType.version
.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause
parameter is set to OPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Implementations§
source§impl StartWorkflowExecutionFluentBuilder
impl StartWorkflowExecutionFluentBuilder
sourcepub fn as_input(&self) -> &StartWorkflowExecutionInputBuilder
pub fn as_input(&self) -> &StartWorkflowExecutionInputBuilder
Access the StartWorkflowExecution as a reference.
sourcepub async fn send(
self
) -> Result<StartWorkflowExecutionOutput, SdkError<StartWorkflowExecutionError, HttpResponse>>
pub async fn send( self ) -> Result<StartWorkflowExecutionOutput, SdkError<StartWorkflowExecutionError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<StartWorkflowExecutionOutput, StartWorkflowExecutionError, Self>
pub fn customize( self ) -> CustomizableOperation<StartWorkflowExecutionOutput, StartWorkflowExecutionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn domain(self, input: impl Into<String>) -> Self
pub fn domain(self, input: impl Into<String>) -> Self
The name of the domain in which the workflow execution is created.
The specified string must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be the literal string arn
.
sourcepub fn set_domain(self, input: Option<String>) -> Self
pub fn set_domain(self, input: Option<String>) -> Self
The name of the domain in which the workflow execution is created.
The specified string must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be the literal string arn
.
sourcepub fn get_domain(&self) -> &Option<String>
pub fn get_domain(&self) -> &Option<String>
The name of the domain in which the workflow execution is created.
The specified string must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be the literal string arn
.
sourcepub fn workflow_id(self, input: impl Into<String>) -> Self
pub fn workflow_id(self, input: impl Into<String>) -> Self
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 restart of a previous execution. You cannot have two open workflow executions with the same workflowId
at the same time within the same domain.
The specified string must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be the literal string arn
.
sourcepub fn set_workflow_id(self, input: Option<String>) -> Self
pub fn set_workflow_id(self, input: Option<String>) -> Self
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 restart of a previous execution. You cannot have two open workflow executions with the same workflowId
at the same time within the same domain.
The specified string must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be the literal string arn
.
sourcepub fn get_workflow_id(&self) -> &Option<String>
pub fn get_workflow_id(&self) -> &Option<String>
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 restart of a previous execution. You cannot have two open workflow executions with the same workflowId
at the same time within the same domain.
The specified string must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be the literal string arn
.
sourcepub fn workflow_type(self, input: WorkflowType) -> Self
pub fn workflow_type(self, input: WorkflowType) -> Self
The type of the workflow to start.
sourcepub fn set_workflow_type(self, input: Option<WorkflowType>) -> Self
pub fn set_workflow_type(self, input: Option<WorkflowType>) -> Self
The type of the workflow to start.
sourcepub fn get_workflow_type(&self) -> &Option<WorkflowType>
pub fn get_workflow_type(&self) -> &Option<WorkflowType>
The type of the workflow to start.
sourcepub fn task_list(self, input: TaskList) -> Self
pub fn task_list(self, input: TaskList) -> Self
The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList
specified when registering the workflow type.
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.
The specified string must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be the literal string arn
.
sourcepub fn set_task_list(self, input: Option<TaskList>) -> Self
pub fn set_task_list(self, input: Option<TaskList>) -> Self
The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList
specified when registering the workflow type.
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.
The specified string must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be the literal string arn
.
sourcepub fn get_task_list(&self) -> &Option<TaskList>
pub fn get_task_list(&self) -> &Option<TaskList>
The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList
specified when registering the workflow type.
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.
The specified string must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be the literal string arn
.
sourcepub fn task_priority(self, input: impl Into<String>) -> Self
pub fn task_priority(self, input: impl Into<String>) -> Self
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 Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
sourcepub fn set_task_priority(self, input: Option<String>) -> Self
pub fn set_task_priority(self, input: Option<String>) -> Self
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 Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
sourcepub fn get_task_priority(&self) -> &Option<String>
pub fn get_task_priority(&self) -> &Option<String>
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 Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
sourcepub fn input(self, input: impl Into<String>) -> Self
pub fn input(self, input: impl Into<String>) -> Self
The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input
is made available to the new workflow execution in the WorkflowExecutionStarted
history event.
sourcepub fn set_input(self, input: Option<String>) -> Self
pub fn set_input(self, input: Option<String>) -> Self
The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input
is made available to the new workflow execution in the WorkflowExecutionStarted
history event.
sourcepub fn get_input(&self) -> &Option<String>
pub fn get_input(&self) -> &Option<String>
The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input
is made available to the new workflow execution in the WorkflowExecutionStarted
history event.
sourcepub fn execution_start_to_close_timeout(self, input: impl Into<String>) -> Self
pub fn execution_start_to_close_timeout(self, input: impl Into<String>) -> Self
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0
. 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.
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.
sourcepub fn set_execution_start_to_close_timeout(self, input: Option<String>) -> Self
pub fn set_execution_start_to_close_timeout(self, input: Option<String>) -> Self
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0
. 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.
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.
sourcepub fn get_execution_start_to_close_timeout(&self) -> &Option<String>
pub fn get_execution_start_to_close_timeout(&self) -> &Option<String>
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0
. 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.
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.
sourcepub fn tag_list(self, input: impl Into<String>) -> Self
pub fn tag_list(self, input: impl Into<String>) -> Self
Appends an item to tagList
.
To override the contents of this collection use set_tag_list
.
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 ListOpenWorkflowExecutions
or ListClosedWorkflowExecutions
and specifying a TagFilter
.
sourcepub fn set_tag_list(self, input: Option<Vec<String>>) -> Self
pub fn set_tag_list(self, input: Option<Vec<String>>) -> Self
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 ListOpenWorkflowExecutions
or ListClosedWorkflowExecutions
and specifying a TagFilter
.
sourcepub fn get_tag_list(&self) -> &Option<Vec<String>>
pub fn get_tag_list(&self) -> &Option<Vec<String>>
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 ListOpenWorkflowExecutions
or ListClosedWorkflowExecutions
and specifying a TagFilter
.
sourcepub fn task_start_to_close_timeout(self, input: impl Into<String>) -> Self
pub fn task_start_to_close_timeout(self, input: impl Into<String>) -> Self
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType
.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use NONE
to specify unlimited duration.
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.
sourcepub fn set_task_start_to_close_timeout(self, input: Option<String>) -> Self
pub fn set_task_start_to_close_timeout(self, input: Option<String>) -> Self
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType
.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use NONE
to specify unlimited duration.
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.
sourcepub fn get_task_start_to_close_timeout(&self) -> &Option<String>
pub fn get_task_start_to_close_timeout(&self) -> &Option<String>
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType
.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use NONE
to specify unlimited duration.
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.
sourcepub fn child_policy(self, input: ChildPolicy) -> Self
pub fn child_policy(self, input: ChildPolicy) -> Self
If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution
action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType
.
The supported child policies are:
-
TERMINATE
– The child executions are terminated. -
REQUEST_CANCEL
– A request to cancel is attempted for each child execution by recording aWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. -
ABANDON
– No action is taken. The child executions continue to run.
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.
sourcepub fn set_child_policy(self, input: Option<ChildPolicy>) -> Self
pub fn set_child_policy(self, input: Option<ChildPolicy>) -> Self
If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution
action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType
.
The supported child policies are:
-
TERMINATE
– The child executions are terminated. -
REQUEST_CANCEL
– A request to cancel is attempted for each child execution by recording aWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. -
ABANDON
– No action is taken. The child executions continue to run.
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.
sourcepub fn get_child_policy(&self) -> &Option<ChildPolicy>
pub fn get_child_policy(&self) -> &Option<ChildPolicy>
If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution
action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType
.
The supported child policies are:
-
TERMINATE
– The child executions are terminated. -
REQUEST_CANCEL
– A request to cancel is attempted for each child execution by recording aWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. -
ABANDON
– No action is taken. The child executions continue to run.
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.
sourcepub fn lambda_role(self, input: impl Into<String>) -> Self
pub fn lambda_role(self, input: impl Into<String>) -> Self
The IAM role to attach to this workflow execution.
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 ScheduleLambdaFunctionFailed
history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
sourcepub fn set_lambda_role(self, input: Option<String>) -> Self
pub fn set_lambda_role(self, input: Option<String>) -> Self
The IAM role to attach to this workflow execution.
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 ScheduleLambdaFunctionFailed
history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
sourcepub fn get_lambda_role(&self) -> &Option<String>
pub fn get_lambda_role(&self) -> &Option<String>
The IAM role to attach to this workflow execution.
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 ScheduleLambdaFunctionFailed
history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
Trait Implementations§
source§impl Clone for StartWorkflowExecutionFluentBuilder
impl Clone for StartWorkflowExecutionFluentBuilder
source§fn clone(&self) -> StartWorkflowExecutionFluentBuilder
fn clone(&self) -> StartWorkflowExecutionFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more