imagebuilder / Client / list_workflow_build_versions

list_workflow_build_versions#

imagebuilder.Client.list_workflow_build_versions(**kwargs)#

Returns a list of build versions for a specific workflow resource.

Request Syntax

response = client.list_workflow_build_versions(
    workflowVersionArn='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

workflowVersionArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.
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

{
    '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) –
  
  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