Skip to content

EC2  >  Operations  >  create_fpga_image

create_fpga_image

Operation

create_fpga_image async

create_fpga_image(input: CreateFpgaImageInput, plugins: list[Plugin] | None = None) -> CreateFpgaImageOutput

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

The create operation is asynchronous. To verify that the AFI was successfully created and 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 Web Services FPGA Hardware Development Kit.

Parameters:

Name Type Description Default
input CreateFpgaImageInput

An instance of CreateFpgaImageInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateFpgaImageOutput

An instance of CreateFpgaImageOutput.

Input

CreateFpgaImageInput dataclass

Bases: _SerdeShape

Dataclass for CreateFpgaImageInput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | None = ...

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

description class-attribute instance-attribute
description: str | None = ...

A description for the AFI.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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 class-attribute instance-attribute
input_storage_location: StorageLocation | None = ...

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

logs_storage_location class-attribute instance-attribute
logs_storage_location: StorageLocation | None = ...

The location in Amazon S3 for the output logs.

name class-attribute instance-attribute
name: str | None = ...

A name for the AFI.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The tags to apply to the FPGA image during creation.

Output

CreateFpgaImageOutput dataclass

Bases: _SerdeShape

Dataclass for CreateFpgaImageOutput structure.

Attributes

fpga_image_global_id class-attribute instance-attribute
fpga_image_global_id: str | None = ...

The global FPGA image identifier (AGFI ID).

fpga_image_id class-attribute instance-attribute
fpga_image_id: str | None = ...

The FPGA image identifier (AFI ID).

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.