Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]



Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.

An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--dry-run | --no-dry-run]
--input-storage-location <value>
[--logs-storage-location <value>]
[--description <value>]
[--name <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--input-storage-location (structure)

The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

Shorthand Syntax:


JSON Syntax:

  "Bucket": "string",
  "Key": "string"

--logs-storage-location (structure)

The location in Amazon S3 for the output logs.

Shorthand Syntax:


JSON Syntax:

  "Bucket": "string",
  "Key": "string"

--description (string)

A description for the AFI.

--name (string)

A name for the AFI.

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To create an Amazon FPGA image

This example creates an AFI from the specified tarball in the specified bucket.


aws ec2 create-fpga-image --name my-afi --description test-afi --input-storage-location Bucket=my-fpga-bucket,Key=dcp/17_12_22-103226.Developer_CL.tar --logs-storage-location Bucket=my-fpga-bucket,Key=logs


  "FpgaImageId": "afi-0d123e123bfc85abc",
  "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc"


FpgaImageId -> (string)

The FPGA image identifier (AFI ID).

FpgaImageGlobalId -> (string)

The global FPGA image identifier (AGFI ID).