Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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 Web Services FPGA Hardware Development Kit.
Synopsis
- data CreateFpgaImage = CreateFpgaImage' {}
- newCreateFpgaImage :: StorageLocation -> CreateFpgaImage
- createFpgaImage_clientToken :: Lens' CreateFpgaImage (Maybe Text)
- createFpgaImage_description :: Lens' CreateFpgaImage (Maybe Text)
- createFpgaImage_dryRun :: Lens' CreateFpgaImage (Maybe Bool)
- createFpgaImage_logsStorageLocation :: Lens' CreateFpgaImage (Maybe StorageLocation)
- createFpgaImage_name :: Lens' CreateFpgaImage (Maybe Text)
- createFpgaImage_tagSpecifications :: Lens' CreateFpgaImage (Maybe [TagSpecification])
- createFpgaImage_inputStorageLocation :: Lens' CreateFpgaImage StorageLocation
- data CreateFpgaImageResponse = CreateFpgaImageResponse' {}
- newCreateFpgaImageResponse :: Int -> CreateFpgaImageResponse
- createFpgaImageResponse_fpgaImageGlobalId :: Lens' CreateFpgaImageResponse (Maybe Text)
- createFpgaImageResponse_fpgaImageId :: Lens' CreateFpgaImageResponse (Maybe Text)
- createFpgaImageResponse_httpStatus :: Lens' CreateFpgaImageResponse Int
Creating a Request
data CreateFpgaImage Source #
See: newCreateFpgaImage
smart constructor.
CreateFpgaImage' | |
|
Instances
Create a value of CreateFpgaImage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateFpgaImage
, createFpgaImage_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see
Ensuring Idempotency.
CreateFpgaImage
, createFpgaImage_description
- A description for the AFI.
$sel:dryRun:CreateFpgaImage'
, createFpgaImage_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
.
$sel:logsStorageLocation:CreateFpgaImage'
, createFpgaImage_logsStorageLocation
- The location in Amazon S3 for the output logs.
CreateFpgaImage
, createFpgaImage_name
- A name for the AFI.
CreateFpgaImage
, createFpgaImage_tagSpecifications
- The tags to apply to the FPGA image during creation.
$sel:inputStorageLocation:CreateFpgaImage'
, createFpgaImage_inputStorageLocation
- The location of the encrypted design checkpoint in Amazon S3. The input
must be a tarball.
Request Lenses
createFpgaImage_clientToken :: Lens' CreateFpgaImage (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
createFpgaImage_description :: Lens' CreateFpgaImage (Maybe Text) Source #
A description for the AFI.
createFpgaImage_dryRun :: Lens' CreateFpgaImage (Maybe Bool) Source #
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
.
createFpgaImage_logsStorageLocation :: Lens' CreateFpgaImage (Maybe StorageLocation) Source #
The location in Amazon S3 for the output logs.
createFpgaImage_name :: Lens' CreateFpgaImage (Maybe Text) Source #
A name for the AFI.
createFpgaImage_tagSpecifications :: Lens' CreateFpgaImage (Maybe [TagSpecification]) Source #
The tags to apply to the FPGA image during creation.
createFpgaImage_inputStorageLocation :: Lens' CreateFpgaImage StorageLocation Source #
The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
Destructuring the Response
data CreateFpgaImageResponse Source #
See: newCreateFpgaImageResponse
smart constructor.
CreateFpgaImageResponse' | |
|
Instances
newCreateFpgaImageResponse Source #
Create a value of CreateFpgaImageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateFpgaImageResponse
, createFpgaImageResponse_fpgaImageGlobalId
- The global FPGA image identifier (AGFI ID).
CreateFpgaImageResponse
, createFpgaImageResponse_fpgaImageId
- The FPGA image identifier (AFI ID).
$sel:httpStatus:CreateFpgaImageResponse'
, createFpgaImageResponse_httpStatus
- The response's http status code.
Response Lenses
createFpgaImageResponse_fpgaImageGlobalId :: Lens' CreateFpgaImageResponse (Maybe Text) Source #
The global FPGA image identifier (AGFI ID).
createFpgaImageResponse_fpgaImageId :: Lens' CreateFpgaImageResponse (Maybe Text) Source #
The FPGA image identifier (AFI ID).
createFpgaImageResponse_httpStatus :: Lens' CreateFpgaImageResponse Int Source #
The response's http status code.