ListCompatibleImagesCommand

This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.

Example Syntax

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

import { SnowballClient, ListCompatibleImagesCommand } from "@aws-sdk/client-snowball"; // ES Modules import
// const { SnowballClient, ListCompatibleImagesCommand } = require("@aws-sdk/client-snowball"); // CommonJS import
const client = new SnowballClient(config);
const input = { // ListCompatibleImagesRequest
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListCompatibleImagesCommand(input);
const response = await client.send(command);
// { // ListCompatibleImagesResult
//   CompatibleImages: [ // CompatibleImageList
//     { // CompatibleImage
//       AmiId: "STRING_VALUE",
//       Name: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListCompatibleImagesCommand Input

Parameter
Type
Description
MaxResults
number | undefined

The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.

NextToken
string | undefined

HTTP requests are stateless. To identify what object comes "next" in the list of compatible images, you can specify a value for NextToken as the starting point for your list of returned images.

ListCompatibleImagesCommand Output

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

A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI.

NextToken
string | undefined

Because HTTP requests are stateless, this is the starting point for your next list of returned images.

Throws

Name
Fault
Details
Ec2RequestFailedException
client

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

InvalidNextTokenException
client

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

SnowballServiceException
Base exception class for all service exceptions from Snowball service.