DeleteAttachmentCommand

Suggest an Edit

Deletes an attachment. Supports all attachment types.

Example Syntax

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

import { NetworkManagerClient, DeleteAttachmentCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import
// const { NetworkManagerClient, DeleteAttachmentCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import
const client = new NetworkManagerClient(config);
const input = { // DeleteAttachmentRequest
  AttachmentId: "STRING_VALUE", // required
};
const command = new DeleteAttachmentCommand(input);
const response = await client.send(command);
// { // DeleteAttachmentResponse
//   Attachment: { // Attachment
//     CoreNetworkId: "STRING_VALUE",
//     CoreNetworkArn: "STRING_VALUE",
//     AttachmentId: "STRING_VALUE",
//     OwnerAccountId: "STRING_VALUE",
//     AttachmentType: "CONNECT" || "SITE_TO_SITE_VPN" || "VPC" || "DIRECT_CONNECT_GATEWAY" || "TRANSIT_GATEWAY_ROUTE_TABLE",
//     State: "REJECTED" || "PENDING_ATTACHMENT_ACCEPTANCE" || "CREATING" || "FAILED" || "AVAILABLE" || "UPDATING" || "PENDING_NETWORK_UPDATE" || "PENDING_TAG_ACCEPTANCE" || "DELETING",
//     EdgeLocation: "STRING_VALUE",
//     EdgeLocations: [ // ExternalRegionCodeList
//       "STRING_VALUE",
//     ],
//     ResourceArn: "STRING_VALUE",
//     AttachmentPolicyRuleNumber: Number("int"),
//     SegmentName: "STRING_VALUE",
//     NetworkFunctionGroupName: "STRING_VALUE",
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     ProposedSegmentChange: { // ProposedSegmentChange
//       Tags: [
//         {
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//       AttachmentPolicyRuleNumber: Number("int"),
//       SegmentName: "STRING_VALUE",
//     },
//     ProposedNetworkFunctionGroupChange: { // ProposedNetworkFunctionGroupChange
//       Tags: [
//         {
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//       AttachmentPolicyRuleNumber: Number("int"),
//       NetworkFunctionGroupName: "STRING_VALUE",
//     },
//     CreatedAt: new Date("TIMESTAMP"),
//     UpdatedAt: new Date("TIMESTAMP"),
//     LastModificationErrors: [ // AttachmentErrorList
//       { // AttachmentError
//         Code: "VPC_NOT_FOUND" || "SUBNET_NOT_FOUND" || "SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE" || "SUBNET_NO_FREE_ADDRESSES" || "SUBNET_UNSUPPORTED_AVAILABILITY_ZONE" || "SUBNET_NO_IPV6_CIDRS" || "VPN_CONNECTION_NOT_FOUND" || "MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED" || "DIRECT_CONNECT_GATEWAY_NOT_FOUND" || "DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS" || "DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF",
//         Message: "STRING_VALUE",
//         ResourceArn: "STRING_VALUE",
//         RequestId: "STRING_VALUE",
//       },
//     ],
//   },
// };

DeleteAttachmentCommand Input

See DeleteAttachmentCommandInput for more details

Parameter
Type
Description
AttachmentId
Required
string | undefined

The ID of the attachment to delete.

DeleteAttachmentCommand Output

See DeleteAttachmentCommandOutput for details

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

Information about the deleted attachment.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

InternalServerException
server

The request has failed due to an internal error.

ResourceNotFoundException
client

The specified resource could not be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints.

NetworkManagerServiceException
Base exception class for all service exceptions from NetworkManager service.