imagebuilder / Client / list_image_packages

list_image_packages

imagebuilder.Client.list_image_packages(**kwargs)

Lists the packages that are associated with an image build version, as determined by Amazon Web Services Systems Manager Inventory at build time.

See also: AWS API Documentation

Request Syntax

response = client.list_image_packages(
    imageBuildVersionArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:
  • imageBuildVersionArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the image build version whose packages you want to list. The value must be a full build version ARN.

  • 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',
    'imagePackageList': [
        {
            'packageName': 'string',
            'packageVersion': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • requestId (string) –

      The request ID that uniquely identifies this request.

    • imagePackageList (list) –

      The list of Image Packages returned in the response.

      • (dict) –

        A software package that’s installed on an image, as detected by Amazon Web Services Systems Manager Inventory at build time. The list includes packages that shipped with the base image.

        • packageName (string) –

          The name of the package that’s reported to the operating system package manager.

        • packageVersion (string) –

          The version of the package that’s reported to the operating system package manager.

    • 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.ResourceNotFoundException

  • imagebuilder.Client.exceptions.ForbiddenException

  • imagebuilder.Client.exceptions.CallRateLimitExceededException