CreateFpgaImage - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateFpgaImage

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 Amazon FPGA Hardware Development Kit.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientToken

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

Type: String

Required: No

Description

A description for the AFI.

Type: String

Required: No

DryRun

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.

Type: Boolean

Required: No

InputStorageLocation

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

Type: StorageLocation object

Required: Yes

LogsStorageLocation

The location in Amazon S3 for the output logs.

Type: StorageLocation object

Required: No

Name

A name for the AFI.

Type: String

Required: No

TagSpecification.N

The tags to apply to the FPGA image during creation.

Type: Array of TagSpecification objects

Required: No

Response Elements

The following elements are returned by the service.

fpgaImageGlobalId

The global FPGA image identifier (AGFI ID).

Type: String

fpgaImageId

The FPGA image identifier (AFI ID).

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example

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

Sample Request

https://ec2.amazonaws.com/?Action=CreateFpgaImage &Name=my-afi &Description=test-afi &InputStorageLocation.Bucket=my-fpga-bucket &InputStorageLocation.Key=dcp/17_12_22-103226.Developer_CL.tar &LogsStorageLocation.Bucket=my-fpga-bucket &LogsStorageLocation.Key=logs &AUTHPARAMS

Sample Response

<CreateFpgaImageResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>d97baa5e-d3dd-4ead-9586-c68example</requestId> <fpgaImageId>afi-0d123e123bfc85abc</fpgaImageId> <fpgaImageGlobalId>agfi-123cb27b5e84a0abc</fpgaImageGlobalId> </CreateFpgaImageResponse>