- 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.
DeleteSiteCommand
Deletes the specified site.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { OutpostsClient, DeleteSiteCommand } from "@aws-sdk/client-outposts"; // ES Modules import
// const { OutpostsClient, DeleteSiteCommand } = require("@aws-sdk/client-outposts"); // CommonJS import
const client = new OutpostsClient(config);
const input = { // DeleteSiteInput
SiteId: "STRING_VALUE", // required
};
const command = new DeleteSiteCommand(input);
const response = await client.send(command);
// {};
DeleteSiteCommand Input
See DeleteSiteCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
SiteId Required | string | undefined | The ID or the Amazon Resource Name (ARN) of the site. |
DeleteSiteCommand Output
See DeleteSiteCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have permission to perform this operation. |
ConflictException | client | Updating or deleting this resource can cause an inconsistent state. |
InternalServerException | server | An internal error has occurred. |
NotFoundException | client | The specified request is not valid. |
ValidationException | client | A parameter is not valid. |
OutpostsServiceException | Base exception class for all service exceptions from Outposts service. |