- 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.
DeleteDeploymentCommand
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { APIGatewayClient, DeleteDeploymentCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
// const { APIGatewayClient, DeleteDeploymentCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
const client = new APIGatewayClient(config);
const input = { // DeleteDeploymentRequest
restApiId: "STRING_VALUE", // required
deploymentId: "STRING_VALUE", // required
};
const command = new DeleteDeploymentCommand(input);
const response = await client.send(command);
// {};
DeleteDeploymentCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
deploymentIdRequired | string | undefined | The identifier of the Deployment resource to delete. |
restApiIdRequired | string | undefined | The string identifier of the associated RestApi. |
DeleteDeploymentCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequestException | client | The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details. |
| ConflictException | client | The request configuration has conflicts. For details, see the accompanying error message. |
| LimitExceededException | client | The request exceeded the rate limit. Retry after the specified time period. |
| NotFoundException | client | The requested resource is not found. Make sure that the request URI is correct. |
| TooManyRequestsException | client | The request has reached its throttling limit. Retry after the specified time period. |
| UnauthorizedException | client | The request is denied because the caller has insufficient permissions. |
| APIGatewayServiceException | Base exception class for all service exceptions from APIGateway service. |