- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteTransitGatewayPrefixListReferenceCommand
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EC2Client, DeleteTransitGatewayPrefixListReferenceCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DeleteTransitGatewayPrefixListReferenceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DeleteTransitGatewayPrefixListReferenceRequest
TransitGatewayRouteTableId: "STRING_VALUE", // required
PrefixListId: "STRING_VALUE", // required
DryRun: true || false,
};
const command = new DeleteTransitGatewayPrefixListReferenceCommand(input);
const response = await client.send(command);
// { // DeleteTransitGatewayPrefixListReferenceResult
// TransitGatewayPrefixListReference: { // TransitGatewayPrefixListReference
// TransitGatewayRouteTableId: "STRING_VALUE",
// PrefixListId: "STRING_VALUE",
// PrefixListOwnerId: "STRING_VALUE",
// State: "pending" || "available" || "modifying" || "deleting",
// Blackhole: true || false,
// TransitGatewayAttachment: { // TransitGatewayPrefixListAttachment
// TransitGatewayAttachmentId: "STRING_VALUE",
// ResourceType: "vpc" || "vpn" || "direct-connect-gateway" || "connect" || "peering" || "tgw-peering",
// ResourceId: "STRING_VALUE",
// },
// },
// };
DeleteTransitGatewayPrefixListReferenceCommand Input
See DeleteTransitGatewayPrefixListReferenceCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
PrefixListId Required | string | undefined | The ID of the prefix list. |
TransitGatewayRouteTableId Required | string | undefined | The ID of the route table. |
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 |
DeleteTransitGatewayPrefixListReferenceCommand Output
See DeleteTransitGatewayPrefixListReferenceCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
TransitGatewayPrefixListReference | TransitGatewayPrefixListReference | undefined | Information about the deleted prefix list reference. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
EC2ServiceException | Base exception class for all service exceptions from EC2 service. |