Snowball / Client / list_compatible_images

list_compatible_images#

Snowball.Client.list_compatible_images(**kwargs)#

This action returns a list of the different Amazon EC2 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.

See also: AWS API Documentation

Request Syntax

response = client.list_compatible_images(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.

  • NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • CompatibleImages (list) –

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

      • (dict) –

        A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), including the ID and name for a Snow device AMI. This AMI is compatible with the device’s physical hardware requirements, and it should be able to be run in an SBE1 instance on the device.

        • AmiId (string) –

          The unique identifier for an individual Snow device AMI.

        • Name (string) –

          The optional name of a compatible image.

    • NextToken (string) –

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

Exceptions

  • Snowball.Client.exceptions.InvalidNextTokenException

  • Snowball.Client.exceptions.Ec2RequestFailedException