RejectVpcPeeringConnectionCommand

Suggest an Edit

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

Example Syntax

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

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

RejectVpcPeeringConnectionCommand Input

See RejectVpcPeeringConnectionCommandInput for more details

Parameter
Type
Description
VpcPeeringConnectionId
Required
string | undefined

The ID of the VPC peering connection.

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.

RejectVpcPeeringConnectionCommand Output

See RejectVpcPeeringConnectionCommandOutput for details

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

Returns true if the request succeeds; otherwise, it returns an error.

Throws

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