ListImagePackagesCommand

Suggest an Edit

List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ImagebuilderClient, ListImagePackagesCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
// const { ImagebuilderClient, ListImagePackagesCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
const client = new ImagebuilderClient(config);
const input = { // ListImagePackagesRequest
  imageBuildVersionArn: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListImagePackagesCommand(input);
const response = await client.send(command);
// { // ListImagePackagesResponse
//   requestId: "STRING_VALUE",
//   imagePackageList: [ // ImagePackageList
//     { // ImagePackage
//       packageName: "STRING_VALUE",
//       packageVersion: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListImagePackagesCommand Input

See ListImagePackagesCommandInput for more details

Parameter
Type
Description
imageBuildVersionArn
Required
string | undefined

Filter results for the ListImagePackages request by the Image Build Version ARN

maxResults
number | undefined

The maximum items to return in a request.

nextToken
string | undefined

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

ListImagePackagesCommand Output

See ListImagePackagesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
imagePackageList
ImagePackage[] | undefined

The list of Image Packages returned in the response.

nextToken
string | undefined

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.

requestId
string | undefined

The request ID that uniquely identifies this request.

Throws

Name
Fault
Details
CallRateLimitExceededException
client

You have exceeded the permitted request rate for the specific operation.

ClientException
client

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

ForbiddenException
client

You are not authorized to perform the requested operation.

InvalidPaginationTokenException
client

You have provided an invalid pagination token in your request.

InvalidRequestException
client

You have requested an action that that the service doesn't support.

ResourceNotFoundException
client

At least one of the resources referenced by your request does not exist.

ServiceException
server

This exception is thrown when the service encounters an unrecoverable exception.

ServiceUnavailableException
server

The service is unable to process your request at this time.

ImagebuilderServiceException
Base exception class for all service exceptions from Imagebuilder service.