#[non_exhaustive]pub struct StartChildWorkflowExecutionDecisionAttributes {
pub workflow_type: Option<WorkflowType>,
pub workflow_id: String,
pub control: Option<String>,
pub input: Option<String>,
pub execution_start_to_close_timeout: Option<String>,
pub task_list: Option<TaskList>,
pub task_priority: Option<String>,
pub task_start_to_close_timeout: Option<String>,
pub child_policy: Option<ChildPolicy>,
pub tag_list: Option<Vec<String>>,
pub lambda_role: Option<String>,
}
Expand description
Provides the details of the StartChildWorkflowExecution
decision.
Access Control
You can use IAM policies to control this decision'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.N
– The key is "swf:tagList.N" where N is the tag number from 0 to 4, inclusive. -
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.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.workflow_type: Option<WorkflowType>
The type of the workflow execution to be started.
workflow_id: String
The workflowId
of the workflow execution.
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
.
control: Option<String>
The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.
input: Option<String>
The input to be provided to the workflow execution.
execution_start_to_close_timeout: 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
. You can use NONE
to specify unlimited duration.
An execution 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 execution start-to-close timeout was specified at registration time then a fault is returned.
task_list: Option<TaskList>
The name of the task list to be used for decision tasks of the child workflow execution.
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 start or end with whitespace. It 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
.
task_priority: Option<String>
A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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.
task_start_to_close_timeout: 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.
child_policy: Option<ChildPolicy>
If set, specifies the policy to use for the child workflow executions if the workflow execution being started 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.
tag_list: Option<Vec<String>>
The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions
or ListClosedWorkflowExecutions
and specifying a TagFilter
.
lambda_role: Option<String>
The IAM role attached to the child workflow execution.
Implementations§
source§impl StartChildWorkflowExecutionDecisionAttributes
impl StartChildWorkflowExecutionDecisionAttributes
sourcepub fn workflow_type(&self) -> Option<&WorkflowType>
pub fn workflow_type(&self) -> Option<&WorkflowType>
The type of the workflow execution to be started.
sourcepub fn workflow_id(&self) -> &str
pub fn workflow_id(&self) -> &str
The workflowId
of the workflow execution.
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 control(&self) -> Option<&str>
pub fn control(&self) -> Option<&str>
The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.
sourcepub fn execution_start_to_close_timeout(&self) -> Option<&str>
pub fn execution_start_to_close_timeout(&self) -> Option<&str>
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
. You can use NONE
to specify unlimited duration.
An execution 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 execution start-to-close timeout was specified at registration time then a fault is returned.
sourcepub fn task_list(&self) -> Option<&TaskList>
pub fn task_list(&self) -> Option<&TaskList>
The name of the task list to be used for decision tasks of the child workflow execution.
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 start or end with whitespace. It 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) -> Option<&str>
pub fn task_priority(&self) -> Option<&str>
A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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 task_start_to_close_timeout(&self) -> Option<&str>
pub fn task_start_to_close_timeout(&self) -> Option<&str>
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) -> Option<&ChildPolicy>
pub fn child_policy(&self) -> Option<&ChildPolicy>
If set, specifies the policy to use for the child workflow executions if the workflow execution being started 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 tag_list(&self) -> &[String]
pub fn tag_list(&self) -> &[String]
The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions
or ListClosedWorkflowExecutions
and specifying a TagFilter
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_list.is_none()
.
sourcepub fn lambda_role(&self) -> Option<&str>
pub fn lambda_role(&self) -> Option<&str>
The IAM role attached to the child workflow execution.
source§impl StartChildWorkflowExecutionDecisionAttributes
impl StartChildWorkflowExecutionDecisionAttributes
sourcepub fn builder() -> StartChildWorkflowExecutionDecisionAttributesBuilder
pub fn builder() -> StartChildWorkflowExecutionDecisionAttributesBuilder
Creates a new builder-style object to manufacture StartChildWorkflowExecutionDecisionAttributes
.
Trait Implementations§
source§impl Clone for StartChildWorkflowExecutionDecisionAttributes
impl Clone for StartChildWorkflowExecutionDecisionAttributes
source§fn clone(&self) -> StartChildWorkflowExecutionDecisionAttributes
fn clone(&self) -> StartChildWorkflowExecutionDecisionAttributes
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for StartChildWorkflowExecutionDecisionAttributes
impl PartialEq for StartChildWorkflowExecutionDecisionAttributes
source§fn eq(&self, other: &StartChildWorkflowExecutionDecisionAttributes) -> bool
fn eq(&self, other: &StartChildWorkflowExecutionDecisionAttributes) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for StartChildWorkflowExecutionDecisionAttributes
Auto Trait Implementations§
impl Freeze for StartChildWorkflowExecutionDecisionAttributes
impl RefUnwindSafe for StartChildWorkflowExecutionDecisionAttributes
impl Send for StartChildWorkflowExecutionDecisionAttributes
impl Sync for StartChildWorkflowExecutionDecisionAttributes
impl Unpin for StartChildWorkflowExecutionDecisionAttributes
impl UnwindSafe for StartChildWorkflowExecutionDecisionAttributes
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more