libZSservicesZSamazonka-swfZSamazonka-swf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SWF.StartWorkflowExecution

Description

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

Synopsis

Creating a Request

data StartWorkflowExecution Source #

See: newStartWorkflowExecution smart constructor.

Constructors

StartWorkflowExecution' 

Fields

  • tagList :: Maybe [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.

  • taskStartToCloseTimeout :: 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. 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.

  • lambdaRole :: Maybe Text

    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.

  • input :: 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.

  • executionStartToCloseTimeout :: 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 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.

  • taskList :: 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.

    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.

  • taskPriority :: Maybe Text

    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.

  • childPolicy :: 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 are terminated.
    • REQUEST_CANCEL – A request to cancel is 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 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.

  • domain :: Text

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

  • workflowId :: 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 within the same domain.

    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.

  • workflowType :: WorkflowType

    The type of the workflow to start.

Instances

Instances details
Eq StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Read StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Show StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Generic StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Associated Types

type Rep StartWorkflowExecution :: Type -> Type #

NFData StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Methods

rnf :: StartWorkflowExecution -> () #

Hashable StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

ToJSON StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

AWSRequest StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Associated Types

type AWSResponse StartWorkflowExecution #

ToHeaders StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

ToPath StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

ToQuery StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

type Rep StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

type Rep StartWorkflowExecution = D1 ('MetaData "StartWorkflowExecution" "Amazonka.SWF.StartWorkflowExecution" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "StartWorkflowExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "taskStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lambdaRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "taskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskList)) :*: (S1 ('MetaSel ('Just "taskPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "childPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChildPolicy)))) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkflowType))))))
type AWSResponse StartWorkflowExecution Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

newStartWorkflowExecution Source #

Create a value of StartWorkflowExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tagList:StartWorkflowExecution', startWorkflowExecution_tagList - 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.

$sel:taskStartToCloseTimeout:StartWorkflowExecution', startWorkflowExecution_taskStartToCloseTimeout - 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.

$sel:lambdaRole:StartWorkflowExecution', startWorkflowExecution_lambdaRole - 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.

$sel:input:StartWorkflowExecution', startWorkflowExecution_input - 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.

$sel:executionStartToCloseTimeout:StartWorkflowExecution', startWorkflowExecution_executionStartToCloseTimeout - 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.

$sel:taskList:StartWorkflowExecution', startWorkflowExecution_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 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.

$sel:taskPriority:StartWorkflowExecution', startWorkflowExecution_taskPriority - 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.

$sel:childPolicy:StartWorkflowExecution', startWorkflowExecution_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 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 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.

$sel:domain:StartWorkflowExecution', startWorkflowExecution_domain - The name of the domain in which the workflow execution is created.

$sel:workflowId:StartWorkflowExecution', startWorkflowExecution_workflowId - 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 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.

$sel:workflowType:StartWorkflowExecution', startWorkflowExecution_workflowType - The type of the workflow to start.

Request Lenses

startWorkflowExecution_tagList :: Lens' StartWorkflowExecution (Maybe [Text]) Source #

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.

startWorkflowExecution_taskStartToCloseTimeout :: Lens' StartWorkflowExecution (Maybe Text) Source #

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.

startWorkflowExecution_lambdaRole :: Lens' StartWorkflowExecution (Maybe Text) Source #

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.

startWorkflowExecution_input :: Lens' StartWorkflowExecution (Maybe Text) Source #

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.

startWorkflowExecution_executionStartToCloseTimeout :: Lens' StartWorkflowExecution (Maybe Text) Source #

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.

startWorkflowExecution_taskList :: Lens' StartWorkflowExecution (Maybe TaskList) Source #

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

startWorkflowExecution_taskPriority :: Lens' StartWorkflowExecution (Maybe Text) Source #

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.

startWorkflowExecution_childPolicy :: Lens' StartWorkflowExecution (Maybe ChildPolicy) Source #

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

startWorkflowExecution_domain :: Lens' StartWorkflowExecution Text Source #

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

startWorkflowExecution_workflowId :: Lens' StartWorkflowExecution Text Source #

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

Destructuring the Response

data StartWorkflowExecutionResponse Source #

Specifies the runId of a workflow execution.

See: newStartWorkflowExecutionResponse smart constructor.

Constructors

StartWorkflowExecutionResponse' 

Fields

  • runId :: 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq StartWorkflowExecutionResponse Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Read StartWorkflowExecutionResponse Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Show StartWorkflowExecutionResponse Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Generic StartWorkflowExecutionResponse Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

Associated Types

type Rep StartWorkflowExecutionResponse :: Type -> Type #

NFData StartWorkflowExecutionResponse Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

type Rep StartWorkflowExecutionResponse Source # 
Instance details

Defined in Amazonka.SWF.StartWorkflowExecution

type Rep StartWorkflowExecutionResponse = D1 ('MetaData "StartWorkflowExecutionResponse" "Amazonka.SWF.StartWorkflowExecution" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "StartWorkflowExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "runId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartWorkflowExecutionResponse Source #

Create a value of StartWorkflowExecutionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:runId:StartWorkflowExecutionResponse', startWorkflowExecutionResponse_runId - 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.

$sel:httpStatus:StartWorkflowExecutionResponse', startWorkflowExecutionResponse_httpStatus - The response's http status code.

Response Lenses

startWorkflowExecutionResponse_runId :: Lens' StartWorkflowExecutionResponse (Maybe Text) Source #

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.