:doc:`Omics <../../omics>` / Waiter / WorkflowVersionActive

*********************
WorkflowVersionActive
*********************



.. py:class:: Omics.Waiter.WorkflowVersionActive

  ::

    
    waiter = client.get_waiter('workflow_version_active')

  
  

  .. py:method:: wait(**kwargs)

    Polls :py:meth:`Omics.Client.get_workflow_version` every 3 seconds until a successful state is reached. An error is raised after 10 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetWorkflowVersion>`_    


    **Request Syntax**
    ::

      waiter.wait(
          workflowId='string',
          versionName='string',
          type='PRIVATE'|'READY2RUN',
          export=[
              'DEFINITION'|'README',
          ],
          workflowOwnerId='string',
          WaiterConfig={
              'Delay': 123,
              'MaxAttempts': 123
          }
      )
      
    :type workflowId: string
    :param workflowId: **[REQUIRED]** 

      The workflow's ID. The ``workflowId`` is not the UUID.

      

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

      The workflow version name.

      

    
    :type type: string
    :param type: 

      The workflow's type.

      

    
    :type export: list
    :param export: 

      The export format for the workflow.

      

    
      - *(string) --* 

      
  
    :type workflowOwnerId: string
    :param workflowOwnerId: 

      The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the ``GetShare`` API operation. If you are the workflow owner, you do not need to include this ID.

      

    
    :type WaiterConfig: dict
    :param WaiterConfig: 

      A dictionary that provides parameters to control waiting behavior.

      

    
      - **Delay** *(integer) --* 

        The amount of time in seconds to wait between attempts. Default: 3

        

      
      - **MaxAttempts** *(integer) --* 

        The maximum number of attempts to be made. Default: 10

        

      
    
    
    :returns: None