imagebuilder / Paginator / ListWorkflows

ListWorkflows¶

class imagebuilder.Paginator.ListWorkflows¶

paginator = client.get_paginator('list_workflows')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from imagebuilder.Client.list_workflows().

Request Syntax

response_iterator = paginator.paginate(
    owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    byName=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

owner (string) – Filters results based on the workflow owner. By default, this request returns the workflows that your account owns ( Self). Specify Amazon to list the workflows that Image Builder manages. Image Builder rejects the Shared and ThirdParty owner values for workflows, and AWSMarketplace returns no results.
filters (list) –
Filters to narrow the list of workflows. You can filter on name, version, description, and type.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  - name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - values (list) –
    
    The filter values. Filter values are case-sensitive.
    - (string) –
byName (boolean) – Specifies whether to return one entry per workflow name, with all versions of each workflow aggregated. Defaults to false, which returns one entry per workflow version. You can’t combine this option with the version filter.
PaginationConfig (dict) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'workflowVersionList': [
        {
            'arn': 'string',
            'name': 'string',
            'version': 'string',
            'description': 'string',
            'type': 'BUILD'|'TEST'|'DISTRIBUTION',
            'owner': 'string',
            'dateCreated': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- workflowVersionList (list) –
  
  A list of workflow versions that match the request criteria.
  - (dict) –
    
    Contains details about this version of the workflow.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the workflow resource.
    - name (string) –
      
      The name of the workflow.
    - version (string) –
      
      The semantic version of the workflow resource. The format includes three nodes: <major>.<minor>.<patch>.
    - description (string) –
      
      Describes the workflow.
    - type (string) –
      
      The image creation stage that this workflow applies to.
    - owner (string) –
      
      The owner of the workflow resource.
    - dateCreated (string) –
      
      The timestamp when Image Builder created the workflow version.
- NextToken (string) –
  
  A token to resume pagination.