Network.AWS.SWF.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 is swf:tagList.member.0 . * tagList.member.1 : The key is swf:tagList.member.1 . * tagList.member.2 : The key is swf:tagList.member.2 . * tagList.member.3 : The key is swf:tagList.member.3 . * tagList.member.4 : The key is swf:tagList.member.4 . * taskList : String constraint. The key is swf:taskList.name . * workflowType.name : String constraint. The key is swf:workflowType.name . * workflowType.version : String constraint. The key is swf:workflowType.version .

If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Creating a Request

startWorkflowExecution

Arguments

:: Text

sDomain

-> Text

sWorkflowId

-> WorkflowType

sWorkflowType

-> StartWorkflowExecution

Creates a value of StartWorkflowExecution with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sTagList - 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 .
• sTaskStartToCloseTimeout - 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. The value NONE can be used to specify unlimited duration.
• sLambdaRole - The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
• sInput - 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.
• sExecutionStartToCloseTimeout - 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 will cause 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.
• sTaskList - The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type. 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 contain the literal string quotarnquot.
• sTaskPriority - The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be 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 Simple Workflow Developer Guide .
• sChildPolicy - 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 will be terminated. * REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested 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 will be taken. The child executions will continue to run.
• sDomain - The name of the domain in which the workflow execution is created.
• sWorkflowId - 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. 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 contain the literal string quotarnquot.
• sWorkflowType - The type of the workflow to start.

data StartWorkflowExecution

See: startWorkflowExecution smart constructor.

Instances

Eq StartWorkflowExecution

Methods

(==) :: StartWorkflowExecution -> StartWorkflowExecution -> Bool

(/=) :: StartWorkflowExecution -> StartWorkflowExecution -> Bool

Data StartWorkflowExecution

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartWorkflowExecution -> c StartWorkflowExecution

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartWorkflowExecution

toConstr :: StartWorkflowExecution -> Constr

dataTypeOf :: StartWorkflowExecution -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartWorkflowExecution)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartWorkflowExecution)

gmapT :: (forall b. Data b => b -> b) -> StartWorkflowExecution -> StartWorkflowExecution

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartWorkflowExecution -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartWorkflowExecution -> r

gmapQ :: (forall d. Data d => d -> u) -> StartWorkflowExecution -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartWorkflowExecution -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartWorkflowExecution -> m StartWorkflowExecution

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartWorkflowExecution -> m StartWorkflowExecution

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartWorkflowExecution -> m StartWorkflowExecution

Read StartWorkflowExecution

Methods

readsPrec :: Int -> ReadS StartWorkflowExecution

readList :: ReadS [StartWorkflowExecution]

readPrec :: ReadPrec StartWorkflowExecution

readListPrec :: ReadPrec [StartWorkflowExecution]

Show StartWorkflowExecution

Methods

showsPrec :: Int -> StartWorkflowExecution -> ShowS

show :: StartWorkflowExecution -> String

showList :: [StartWorkflowExecution] -> ShowS

Generic StartWorkflowExecution

Associated Types

type Rep StartWorkflowExecution :: * -> *

Methods

from :: StartWorkflowExecution -> Rep StartWorkflowExecution x

to :: Rep StartWorkflowExecution x -> StartWorkflowExecution

Hashable StartWorkflowExecution

Methods

hashWithSalt :: Int -> StartWorkflowExecution -> Int

hash :: StartWorkflowExecution -> Int

ToJSON StartWorkflowExecution

Methods

toJSON :: StartWorkflowExecution -> Value

toEncoding :: StartWorkflowExecution -> Encoding

toJSONList :: [StartWorkflowExecution] -> Value

toEncodingList :: [StartWorkflowExecution] -> Encoding

NFData StartWorkflowExecution

Methods

rnf :: StartWorkflowExecution -> ()

AWSRequest StartWorkflowExecution

Associated Types

type Rs StartWorkflowExecution :: *

Methods

request :: StartWorkflowExecution -> Request StartWorkflowExecution

response :: MonadResource m => Logger -> Service -> Proxy * StartWorkflowExecution -> ClientResponse -> m (Response StartWorkflowExecution)

ToPath StartWorkflowExecution

Methods

toPath :: StartWorkflowExecution -> ByteString

ToHeaders StartWorkflowExecution

Methods

toHeaders :: StartWorkflowExecution -> [Header]

ToQuery StartWorkflowExecution

Methods

toQuery :: StartWorkflowExecution -> QueryString

type Rep StartWorkflowExecution

type Rep StartWorkflowExecution = D1 (MetaData "StartWorkflowExecution" "Network.AWS.SWF.StartWorkflowExecution" "amazonka-swf-1.4.5-JrgP3TYd23IIXxQppO5YqL" False) (C1 (MetaCons "StartWorkflowExecution'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sTagList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_sTaskStartToCloseTimeout") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_sLambdaRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sInput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sExecutionStartToCloseTimeout") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sTaskList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TaskList))) ((:*:) (S1 (MetaSel (Just Symbol "_sTaskPriority") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sChildPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ChildPolicy))))) ((:*:) (S1 (MetaSel (Just Symbol "_sDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_sWorkflowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_sWorkflowType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkflowType)))))))

type Rs StartWorkflowExecution

type Rs StartWorkflowExecution = StartWorkflowExecutionResponse

Request Lenses

sTagList :: Lens' StartWorkflowExecution [Text]

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 .

sTaskStartToCloseTimeout :: Lens' StartWorkflowExecution (Maybe Text)

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. The value NONE can be used to specify unlimited duration.

sLambdaRole :: Lens' StartWorkflowExecution (Maybe Text)

The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

sInput :: Lens' StartWorkflowExecution (Maybe Text)

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.

sExecutionStartToCloseTimeout :: Lens' StartWorkflowExecution (Maybe Text)

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 will cause 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.

sTaskList :: Lens' StartWorkflowExecution (Maybe 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. 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 contain the literal string quotarnquot.

sTaskPriority :: Lens' StartWorkflowExecution (Maybe Text)

The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be 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 Simple Workflow Developer Guide .

sChildPolicy :: Lens' StartWorkflowExecution (Maybe 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 will be terminated. * REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested 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 will be taken. The child executions will continue to run.

sDomain :: Lens' StartWorkflowExecution Text

The name of the domain in which the workflow execution is created.

sWorkflowId :: Lens' StartWorkflowExecution Text

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. 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 contain the literal string quotarnquot.

sWorkflowType :: Lens' StartWorkflowExecution WorkflowType

The type of the workflow to start.

Destructuring the Response

startWorkflowExecutionResponse

Arguments

:: Int

swersResponseStatus

-> StartWorkflowExecutionResponse

Creates a value of StartWorkflowExecutionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• swersRunId - The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.
• swersResponseStatus - -- | The response status code.

data StartWorkflowExecutionResponse

Specifies the runId of a workflow execution.

See: startWorkflowExecutionResponse smart constructor.

Instances

Eq StartWorkflowExecutionResponse

Methods

(==) :: StartWorkflowExecutionResponse -> StartWorkflowExecutionResponse -> Bool

(/=) :: StartWorkflowExecutionResponse -> StartWorkflowExecutionResponse -> Bool

Data StartWorkflowExecutionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartWorkflowExecutionResponse -> c StartWorkflowExecutionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartWorkflowExecutionResponse

toConstr :: StartWorkflowExecutionResponse -> Constr

dataTypeOf :: StartWorkflowExecutionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartWorkflowExecutionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartWorkflowExecutionResponse)

gmapT :: (forall b. Data b => b -> b) -> StartWorkflowExecutionResponse -> StartWorkflowExecutionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartWorkflowExecutionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartWorkflowExecutionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> StartWorkflowExecutionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartWorkflowExecutionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartWorkflowExecutionResponse -> m StartWorkflowExecutionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartWorkflowExecutionResponse -> m StartWorkflowExecutionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartWorkflowExecutionResponse -> m StartWorkflowExecutionResponse

Read StartWorkflowExecutionResponse

Methods

readsPrec :: Int -> ReadS StartWorkflowExecutionResponse

readList :: ReadS [StartWorkflowExecutionResponse]

readPrec :: ReadPrec StartWorkflowExecutionResponse

readListPrec :: ReadPrec [StartWorkflowExecutionResponse]

Show StartWorkflowExecutionResponse

Methods

showsPrec :: Int -> StartWorkflowExecutionResponse -> ShowS

show :: StartWorkflowExecutionResponse -> String

showList :: [StartWorkflowExecutionResponse] -> ShowS

Generic StartWorkflowExecutionResponse

Associated Types

type Rep StartWorkflowExecutionResponse :: * -> *

Methods

from :: StartWorkflowExecutionResponse -> Rep StartWorkflowExecutionResponse x

to :: Rep StartWorkflowExecutionResponse x -> StartWorkflowExecutionResponse

NFData StartWorkflowExecutionResponse

Methods

rnf :: StartWorkflowExecutionResponse -> ()

type Rep StartWorkflowExecutionResponse

type Rep StartWorkflowExecutionResponse = D1 (MetaData "StartWorkflowExecutionResponse" "Network.AWS.SWF.StartWorkflowExecution" "amazonka-swf-1.4.5-JrgP3TYd23IIXxQppO5YqL" False) (C1 (MetaCons "StartWorkflowExecutionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_swersRunId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_swersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

swersRunId :: Lens' StartWorkflowExecutionResponse (Maybe Text)

The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.

swersResponseStatus :: Lens' StartWorkflowExecutionResponse Int

• - | The response status code.