:doc:`imagebuilder <../../imagebuilder>` / Paginator / ListWorkflowBuildVersions

*************************
ListWorkflowBuildVersions
*************************



.. py:class:: imagebuilder.Paginator.ListWorkflowBuildVersions

  ::

    
    paginator = client.get_paginator('list_workflow_build_versions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`imagebuilder.Client.list_workflow_build_versions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWorkflowBuildVersions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          workflowVersionArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type workflowVersionArn: string
    :param workflowVersionArn: 

      The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.

      

    
    :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**

      
      ::

        {
            'workflowSummaryList': [
                {
                    'arn': 'string',
                    'name': 'string',
                    'version': 'string',
                    'description': 'string',
                    'changeDescription': 'string',
                    'type': 'BUILD'|'TEST'|'DISTRIBUTION',
                    'owner': 'string',
                    'state': {
                        'status': 'DEPRECATED',
                        'reason': 'string'
                    },
                    'dateCreated': 'string',
                    'tags': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **workflowSummaryList** *(list) --* 

          A list that contains metadata for the workflow builds that have run for the workflow resource specified in the request.

          
          

          - *(dict) --* 

            Contains metadata about the workflow resource.

            
            

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

              The Amazon Resource Name (ARN) of the workflow resource.

              
            

            - **name** *(string) --* 

              The name of the workflow.

              
            

            - **version** *(string) --* 

              The version of the workflow.

              
            

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

              Describes the workflow.

              
            

            - **changeDescription** *(string) --* 

              The change description for the current version of the workflow resource.

              
            

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

              The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows.

              
            

            - **owner** *(string) --* 

              The owner of the workflow resource.

              
            

            - **state** *(dict) --* 

              Describes the current state of the workflow resource.

              
              

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

                The current state of the workflow.

                
              

              - **reason** *(string) --* 

                Describes how or why the workflow changed state.

                
          
            

            - **dateCreated** *(string) --* 

              The original creation date of the workflow resource.

              
            

            - **tags** *(dict) --* 

              Contains a list of tags that are defined for the workflow.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    