:doc:`Omics <../../omics>` / Client / list_workflow_versions

**********************
list_workflow_versions
**********************



.. py:method:: Omics.Client.list_workflow_versions(**kwargs)

  

  Lists the workflow versions for the specified workflow. For more information, see `Workflow versioning in Amazon Web Services HealthOmics <https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html>`__ in the *Amazon Web Services HealthOmics User Guide*.

  

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


  **Request Syntax**
  ::

    response = client.list_workflow_versions(
        workflowId='string',
        type='PRIVATE'|'READY2RUN',
        workflowOwnerId='string',
        startingToken='string',
        maxResults=123
    )
    
  :type workflowId: string
  :param workflowId: **[REQUIRED]** 

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

    

  
  :type type: string
  :param type: 

    The workflow type.

    

  
  :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 startingToken: string
  :param startingToken: 

    Specify the pagination token from a previous request to retrieve the next page of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of workflows to return in one page of results.

    

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

    
    ::

      {
          'items': [
              {
                  'arn': 'string',
                  'workflowId': 'string',
                  'versionName': 'string',
                  'description': 'string',
                  'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETED'|'FAILED'|'INACTIVE',
                  'type': 'PRIVATE'|'READY2RUN',
                  'digest': 'string',
                  'creationTime': datetime(2015, 1, 1),
                  'metadata': {
                      'string': 'string'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **items** *(list) --* 

        A list of workflow version items.

        
        

        - *(dict) --* 

          A list of workflow version items.

          
          

          - **arn** *(string) --* 

            ARN of the workflow version.

            
          

          - **workflowId** *(string) --* 

            The workflow's ID.

            
          

          - **versionName** *(string) --* 

            The name of the workflow version.

            
          

          - **description** *(string) --* 

            The description of the workflow version.

            
          

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

            The status of the workflow version.

            
          

          - **type** *(string) --* 

            The type of the workflow version.

            
          

          - **digest** *(string) --* 

            The digist of the workflow version.

            
          

          - **creationTime** *(datetime) --* 

            The creation time of the workflow version.

            
          

          - **metadata** *(dict) --* 

            Metadata for the workflow version.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

      - **nextToken** *(string) --* 

        A pagination token that's included if more results are available.

        
  
  **Exceptions**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

  
  *   :py:class:`Omics.Client.exceptions.ServiceQuotaExceededException`

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

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

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

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

  
  *   :py:class:`Omics.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Omics.Client.exceptions.RequestTimeoutException`

  