Skip to content

list_compatible_images

list_compatible_images(
    *,
    config_overrides: Optional[SnowballClientConfig] = None,
    max_results: Optional[ListLimit] = None,
    next_token: Optional[String] = None,
) -> ListCompatibleImagesResult

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.

Parameters:

  • max_results (Optional[ListLimit], default: None ) –

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

  • next_token (Optional[String], default: None ) –

    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.

Raises:

  • Ec2RequestFailedException –

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

  • InvalidNextTokenException –

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

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_snowball/_services/snowball.py
def list_compatible_images(
    self,
    *,
    config_overrides: Optional[SnowballClientConfig] = None,
    max_results: Optional["capo_snowball.types.list_limit.ListLimit"] = None,
    next_token: Optional["capo_snowball.types.string.String"] = None,
) -> "capo_snowball.types.list_compatible_images_result.ListCompatibleImagesResult":
    """<p>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.</p>

    Args:
        max_results: <p>The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.</p>
        next_token: <p>HTTP requests are stateless. To identify what object comes "next" in the list of compatible images, you can specify a value for <code>NextToken</code> as the starting point for your list of returned images.</p>

    Raises:
        capo_snowball.errors.ec2_request_failed_exception.Ec2RequestFailedException: <p>Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.</p>
        capo_snowball.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> string was altered unexpectedly, and the operation has stopped. Run the operation without changing the <code>NextToken</code> string, and try again.</p>
        capo_snowball.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_snowball.types.list_compatible_images_request.ListCompatibleImagesRequest]",
    ) -> OperationResponse[
        "capo_snowball.types.list_compatible_images_result.ListCompatibleImagesResult"
    ]:
        import capo_snowball._operations.awsie_snowball_job_management_service.list_compatible_images

        output, http_response = (
            capo_snowball._operations.awsie_snowball_job_management_service.list_compatible_images.list_compatible_images(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCompatibleImages")
    )
    input_: capo_snowball.types.list_compatible_images_request.ListCompatibleImagesRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output