imagebuilder / Client / list_workflows

list_workflows#

imagebuilder.Client.list_workflows(**kwargs)#

Lists workflow build versions based on filtering parameters.

Request Syntax

response = client.list_workflows(
    owner='Self'|'Shared'|'Amazon'|'ThirdParty',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    byName=True|False,
    maxResults=123,
    nextToken='string'
)

Parameters:

owner (string) – Used to get a list of workflow build version filtered by the identity of the creator.
filters (list) –
Used to streamline search results.
- (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) – Specify all or part of the workflow name to streamline results.
maxResults (integer) – The maximum items to return in a request.
nextToken (string) – A token to specify where to start paginating. This is the nextToken from a previously truncated 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 build 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. Image Builder currently supports build and test stage workflows.
    - owner (string) –
      
      The owner of the workflow resource.
    - dateCreated (string) –
      
      The timestamp when Image Builder created the workflow version.
- nextToken (string) –
  
  The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

Exceptions

imagebuilder.Client.exceptions.ServiceException
imagebuilder.Client.exceptions.ClientException
imagebuilder.Client.exceptions.ServiceUnavailableException
imagebuilder.Client.exceptions.InvalidRequestException
imagebuilder.Client.exceptions.InvalidPaginationTokenException
imagebuilder.Client.exceptions.ForbiddenException
imagebuilder.Client.exceptions.CallRateLimitExceededException