ListImagesCommand

Suggest an Edit

Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.

Example Syntax

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

import { ImagebuilderClient, ListImagesCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import
// const { ImagebuilderClient, ListImagesCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import
const client = new ImagebuilderClient(config);
const input = { // ListImagesRequest
  owner: "Self" || "Shared" || "Amazon" || "ThirdParty" || "AWSMarketplace",
  filters: [ // FilterList
    { // Filter
      name: "STRING_VALUE",
      values: [ // FilterValues
        "STRING_VALUE",
      ],
    },
  ],
  byName: true || false,
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  includeDeprecated: true || false,
};
const command = new ListImagesCommand(input);
const response = await client.send(command);
// { // ListImagesResponse
//   requestId: "STRING_VALUE",
//   imageVersionList: [ // ImageVersionList
//     { // ImageVersion
//       arn: "STRING_VALUE",
//       name: "STRING_VALUE",
//       type: "AMI" || "DOCKER",
//       version: "STRING_VALUE",
//       platform: "Windows" || "Linux" || "macOS",
//       osVersion: "STRING_VALUE",
//       owner: "STRING_VALUE",
//       dateCreated: "STRING_VALUE",
//       buildType: "USER_INITIATED" || "SCHEDULED" || "IMPORT" || "IMPORT_ISO",
//       imageSource: "AMAZON_MANAGED" || "AWS_MARKETPLACE" || "IMPORTED" || "CUSTOM",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListImagesCommand Input

See ListImagesCommandInput for more details

Parameter
Type
Description
byName
boolean | undefined

Requests a list of images with a specific recipe name.

filters
Filter[] | undefined

Use the following filters to streamline results:

  • name

  • osVersion

  • platform

  • type

  • version

includeDeprecated
boolean | undefined

Includes deprecated images in the response list.

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.

owner
Ownership | undefined

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

ListImagesCommand Output

See ListImagesCommandOutput for details

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

The list of image semantic versions.

The semantic version has four nodes: ../. 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.

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.

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.