:doc:`SWF <../../swf>` / Client / start_workflow_execution

************************
start_workflow_execution
************************



.. py:method:: SWF.Client.start_workflow_execution(**kwargs)

  

  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 <https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html>`__ in the *Amazon SWF Developer Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/swf-2012-01-25/StartWorkflowExecution>`_  


  **Request Syntax**
  ::

    response = client.start_workflow_execution(
        domain='string',
        workflowId='string',
        workflowType={
            'name': 'string',
            'version': 'string'
        },
        taskList={
            'name': 'string'
        },
        taskPriority='string',
        input='string',
        executionStartToCloseTimeout='string',
        tagList=[
            'string',
        ],
        taskStartToCloseTimeout='string',
        childPolicy='TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
        lambdaRole='string'
    )
    
  :type domain: string
  :param domain: **[REQUIRED]** 

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

    

  
  :type workflowId: string
  :param workflowId: **[REQUIRED]** 

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

    

  
  :type workflowType: dict
  :param workflowType: **[REQUIRED]** 

    The type of the workflow to start.

    

  
    - **name** *(string) --* **[REQUIRED]** 

      The name of the workflow type.

       

      .. note::

        

        The combination of workflow type name and version must be unique with in a domain.

        

      

    
    - **version** *(string) --* **[REQUIRED]** 

      The version of the workflow type.

       

      .. note::

        

        The combination of workflow type name and version must be unique with in a domain.

        

      

    
  
  :type taskList: dict
  :param 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.

     

    .. note::

      

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

    

  
    - **name** *(string) --* **[REQUIRED]** 

      The name of the task list.

      

    
  
  :type taskPriority: string
  :param 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 <https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html>`__ in the *Amazon SWF Developer Guide*.

    

  
  :type input: string
  :param 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.

    

  
  :type executionStartToCloseTimeout: string
  :param 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.

     

    .. note::

      

      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.

      

    

  
  :type tagList: list
  :param 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.

    

  
    - *(string) --* 

    

  :type taskStartToCloseTimeout: string
  :param 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.

     

    .. note::

      

      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.

      

    

  
  :type childPolicy: string
  :param 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.
    

     

    .. note::

      

      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.

      

    

  
  :type lambdaRole: string
  :param lambdaRole: 

    The IAM role to attach to this workflow execution.

     

    .. note::

      

      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 <https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html>`__ in the *Amazon SWF Developer Guide*.

      

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'runId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Specifies the ``runId`` of a workflow execution.

      
      

      - **runId** *(string) --* 

        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.

        
  
  **Exceptions**
  
  *   :py:class:`SWF.Client.exceptions.UnknownResourceFault`

  
  *   :py:class:`SWF.Client.exceptions.TypeDeprecatedFault`

  
  *   :py:class:`SWF.Client.exceptions.WorkflowExecutionAlreadyStartedFault`

  
  *   :py:class:`SWF.Client.exceptions.LimitExceededFault`

  
  *   :py:class:`SWF.Client.exceptions.OperationNotPermittedFault`

  
  *   :py:class:`SWF.Client.exceptions.DefaultUndefinedFault`

  