RejectTransitGatewayPeeringAttachmentCommand

Suggest an Edit

Rejects a transit gateway peering attachment request.

Example Syntax

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

import { EC2Client, RejectTransitGatewayPeeringAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, RejectTransitGatewayPeeringAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // RejectTransitGatewayPeeringAttachmentRequest
  TransitGatewayAttachmentId: "STRING_VALUE", // required
  DryRun: true || false,
};
const command = new RejectTransitGatewayPeeringAttachmentCommand(input);
const response = await client.send(command);
// { // RejectTransitGatewayPeeringAttachmentResult
//   TransitGatewayPeeringAttachment: { // TransitGatewayPeeringAttachment
//     TransitGatewayAttachmentId: "STRING_VALUE",
//     AccepterTransitGatewayAttachmentId: "STRING_VALUE",
//     RequesterTgwInfo: { // PeeringTgwInfo
//       TransitGatewayId: "STRING_VALUE",
//       CoreNetworkId: "STRING_VALUE",
//       OwnerId: "STRING_VALUE",
//       Region: "STRING_VALUE",
//     },
//     AccepterTgwInfo: {
//       TransitGatewayId: "STRING_VALUE",
//       CoreNetworkId: "STRING_VALUE",
//       OwnerId: "STRING_VALUE",
//       Region: "STRING_VALUE",
//     },
//     Options: { // TransitGatewayPeeringAttachmentOptions
//       DynamicRouting: "enable" || "disable",
//     },
//     Status: { // PeeringAttachmentStatus
//       Code: "STRING_VALUE",
//       Message: "STRING_VALUE",
//     },
//     State: "initiating" || "initiatingRequest" || "pendingAcceptance" || "rollingBack" || "pending" || "available" || "modifying" || "deleting" || "deleted" || "failed" || "rejected" || "rejecting" || "failing",
//     CreationTime: new Date("TIMESTAMP"),
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//   },
// };

RejectTransitGatewayPeeringAttachmentCommand Input

See RejectTransitGatewayPeeringAttachmentCommandInput for more details

Parameter
Type
Description
TransitGatewayAttachmentId
Required
string | undefined

The ID of the transit gateway peering attachment.

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.

RejectTransitGatewayPeeringAttachmentCommand Output

See RejectTransitGatewayPeeringAttachmentCommandOutput for details

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

The transit gateway peering attachment.

Throws

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