imagebuilder / Client / list_component_build_versions

list_component_build_versions¶

imagebuilder.Client.list_component_build_versions(**kwargs)¶

Returns a list of component build versions for the specified component version ARN. You can only list build versions for components that your account owns. Deprecated build versions aren’t included in the results.

Request Syntax

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

Parameters:

componentVersionArn (string) – The component version ARN whose build versions you want to list. The ARN must specify an exact version, without a build number suffix. If you don’t specify an ARN, Image Builder returns build versions for the components that your account owns.
maxResults (integer) – The maximum number of items to return in a single request.
nextToken (string) – A token to specify where to start paginating. Use the nextToken value from a previously truncated response.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'componentSummaryList': [
        {
            'arn': 'string',
            'name': 'string',
            'version': 'string',
            'platform': 'Windows'|'Linux'|'macOS',
            'supportedOsVersions': [
                'string',
            ],
            'state': {
                'status': 'DEPRECATED'|'DISABLED'|'ACTIVE',
                '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. Each summary represents one build version of the specified component version, or of the components that your account owns if you didn’t specify an ARN. Deprecated build versions aren’t included.
  - (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. Components with a status of DEPRECATED or DISABLED can’t be added to new recipes.
      - 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. The value is your account ID for components that you own, the sharing account’s ID for shared components, or Amazon, ThirdParty, or AWSMarketplace.
    - description (string) –
      
      The description of the component.
    - changeDescription (string) –
      
      The change description for this version of the component.
    - dateCreated (string) –
      
      The date that Image Builder created this version 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 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