:doc:`Omics <../../omics>` / Paginator / ListWorkflowVersions

********************
ListWorkflowVersions
********************



.. py:class:: Omics.Paginator.ListWorkflowVersions

  ::

    
    paginator = client.get_paginator('list_workflow_versions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Omics.Client.list_workflow_versions`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          workflowId='string',
          type='PRIVATE'|'READY2RUN',
          workflowOwnerId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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 token to resume pagination.

          
    