AWS Snowball
API Reference

ListCompatibleImages

This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snowball Edge device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace.

Request Syntax

{ "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "CompatibleImages": [ { "AmiId": "string", "Name": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CompatibleImages

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

Type: Array of CompatibleImage objects

NextToken

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

Type: String

Length Constraints: Minimum length of 1.

Errors

For information about the errors that are common to all actions, see Common Errors.

Ec2RequestFailedException

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

HTTP Status Code: 400

InvalidNextTokenException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: