- 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.
DeleteVPCConnectionCommand
Deletes a VPC connection.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, DeleteVPCConnectionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, DeleteVPCConnectionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // DeleteVPCConnectionRequest
AwsAccountId: "STRING_VALUE", // required
VPCConnectionId: "STRING_VALUE", // required
};
const command = new DeleteVPCConnectionCommand(input);
const response = await client.send(command);
// { // DeleteVPCConnectionResponse
// Arn: "STRING_VALUE",
// VPCConnectionId: "STRING_VALUE",
// DeletionStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETION_IN_PROGRESS" || "DELETION_FAILED" || "DELETED",
// AvailabilityStatus: "AVAILABLE" || "UNAVAILABLE" || "PARTIALLY_AVAILABLE",
// RequestId: "STRING_VALUE",
// Status: Number("int"),
// };
DeleteVPCConnectionCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
AwsAccountIdRequired | string | undefined | The Amazon Web Services account ID of the account where you want to delete a VPC connection. |
VPCConnectionIdRequired | string | undefined | The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account. |
DeleteVPCConnectionCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Arn | string | undefined | The Amazon Resource Name (ARN) of the deleted VPC connection. |
AvailabilityStatus | VPCConnectionAvailabilityStatus | undefined | The availability status of the VPC connection. |
DeletionStatus | VPCConnectionResourceStatus | undefined | The deletion status of the VPC connection. |
RequestId | string | undefined | The Amazon Web Services request ID for this operation. |
Status | number | undefined | The HTTP status of the request. |
VPCConnectionId | string | undefined | The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials. |
| ConflictException | client | Updating or deleting a resource can cause an inconsistent state. |
| InternalFailureException | server | An internal failure occurred. |
| InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
| ResourceNotFoundException | client | One or more resources can't be found. |
| ThrottlingException | client | Access is throttled. |
| UnsupportedUserEditionException | client | This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition. |
| QuickSightServiceException | Base exception class for all service exceptions from QuickSight service. |