imagebuilder / Paginator / ListComponentBuildVersions

ListComponentBuildVersions

class imagebuilder.Paginator.ListComponentBuildVersions

paginator = client.get_paginator('list_component_build_versions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    componentVersionArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• 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

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

    A token to resume pagination.