:doc:`NovaActService <../../nova-act>` / Client / create_workflow_run

*******************
create_workflow_run
*******************



.. py:method:: NovaActService.Client.create_workflow_run(**kwargs)

  

  Creates a new execution instance of a workflow definition with specified parameters.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/CreateWorkflowRun>`_  


  **Request Syntax**
  ::

    response = client.create_workflow_run(
        workflowDefinitionName='string',
        modelId='string',
        clientToken='string',
        logGroupName='string',
        clientInfo={
            'compatibilityVersion': 123,
            'sdkVersion': 'string'
        }
    )
    
  :type workflowDefinitionName: string
  :param workflowDefinitionName: **[REQUIRED]** 

    The name of the workflow definition to execute.

    

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

    The ID of the AI model to use for workflow execution.

    

  
  :type clientToken: string
  :param clientToken: 

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  
  :type logGroupName: string
  :param logGroupName: 

    The CloudWatch log group name for storing workflow execution logs.

    

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

    Information about the client making the request, including compatibility version and SDK version.

    

  
    - **compatibilityVersion** *(integer) --* **[REQUIRED]** 

      The compatibility version of the client, used to ensure API compatibility.

      

    
    - **sdkVersion** *(string) --* 

      The version of the SDK being used by the client.

      

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

    
    ::

      {
          'workflowRunId': 'string',
          'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'DELETING'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **workflowRunId** *(string) --* 

        The unique identifier for the created workflow run.

        
      

      - **status** *(string) --* 

        The initial status of the workflow run after creation.

        
  
  **Exceptions**
  
  *   :py:class:`NovaActService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`NovaActService.Client.exceptions.ConflictException`

  
  *   :py:class:`NovaActService.Client.exceptions.ThrottlingException`

  
  *   :py:class:`NovaActService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`NovaActService.Client.exceptions.InternalServerException`

  
  *   :py:class:`NovaActService.Client.exceptions.ValidationException`

  