imagebuilder / Client / list_component_build_versions

list_component_build_versions#

imagebuilder.Client.list_component_build_versions(**kwargs)#

Returns the list of component build versions for the specified semantic version.

Note

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

See also: AWS API Documentation

Request Syntax

response = client.list_component_build_versions(
    componentVersionArn='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

componentVersionArn (string) –
[REQUIRED]

The component version Amazon Resource Name (ARN) whose versions you want to list.
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

{
    'requestId': 'string',
    'componentSummaryList': [
        {
            'arn': 'string',
            'name': 'string',
            'version': 'string',
            'platform': 'Windows'|'Linux',
            'supportedOsVersions': [
                'string',
            ],
            'state': {
                'status': 'DEPRECATED',
                'reason': 'string'
            },
            'type': 'BUILD'|'TEST',
            'owner': 'string',
            'description': 'string',
            'changeDescription': 'string',
            'dateCreated': 'string',
            'tags': {
                'string': 'string'
            },
            'publisher': 'string',
            'obfuscate': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- componentSummaryList (list) –
  
  The list of component summaries for the specified semantic version.
  - (dict) –
    
    A high-level summary of a component.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the component.
    - name (string) –
      
      The name of the component.
    - version (string) –
      
      The version of the component.
    - platform (string) –
      
      The operating system platform of the component.
    - supportedOsVersions (list) –
      
      The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
      - (string) –
    - state (dict) –
      
      Describes the current status of the component.
      - status (string) –
        
        The current state of the component.
      - reason (string) –
        
        Describes how or why the component changed state.
    - type (string) –
      
      The component type specifies whether Image Builder uses the component to build the image or only to test it.
    - owner (string) –
      
      The owner of the component.
    - description (string) –
      
      The description of the component.
    - changeDescription (string) –
      
      The change description for the current version of the component.
    - dateCreated (string) –
      
      The original creation date of the component.
    - tags (dict) –
      
      The tags that apply to the component.
      - (string) –
        
        (string) –
    - publisher (string) –
      
      Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
    - obfuscate (boolean) –
      
      Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
- nextToken (string) –
  
  The next token used for paginated responses. When this is not empty, there are additional elements that the service has not 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