create_fpga_image¶
Operation¶
create_fpga_image
¶
create_fpga_image(request: CreateFpgaImageInput | CreateFpgaImageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateFpgaImageInputDict]) -> 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 |
|---|---|---|---|
request
|
CreateFpgaImageInput | CreateFpgaImageInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[CreateFpgaImageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateFpgaImageOutput
|
An instance of |
create_fpga_image
async
¶
create_fpga_image(request: CreateFpgaImageInput | CreateFpgaImageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateFpgaImageInputDict]) -> 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 |
|---|---|---|---|
request
|
CreateFpgaImageInput | CreateFpgaImageInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[CreateFpgaImageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateFpgaImageOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateFpgaImageInputDict
¶
Bases: TypedDict
Dictionary form of CreateFpgaImageInput.
Attributes¶
client_token
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.
dry_run
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
instance-attribute
¶
input_storage_location: Required[StorageLocation | StorageLocationDict]
The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
logs_storage_location
instance-attribute
¶
logs_storage_location: StorageLocation | StorageLocationDict | None
The location in Amazon S3 for the output logs.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to apply to the FPGA image during creation.
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.
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
¶
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.