DeleteFpgaImageCommand

Suggest an Edit

Deletes the specified Amazon FPGA Image (AFI).

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DeleteFpgaImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DeleteFpgaImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DeleteFpgaImageRequest
  DryRun: true || false,
  FpgaImageId: "STRING_VALUE", // required
};
const command = new DeleteFpgaImageCommand(input);
const response = await client.send(command);
// { // DeleteFpgaImageResult
//   Return: true || false,
// };

DeleteFpgaImageCommand Input

See DeleteFpgaImageCommandInput for more details

Parameter
Type
Description
FpgaImageId
Required
string | undefined

The ID of the AFI.

DryRun
boolean | undefined

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.

DeleteFpgaImageCommand Output

See DeleteFpgaImageCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Return
boolean | undefined

Is true if the request succeeds, and an error otherwise.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.