- 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.
DeleteUsagePlanCommand
Deletes a usage plan of a given plan Id.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { APIGatewayClient, DeleteUsagePlanCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
// const { APIGatewayClient, DeleteUsagePlanCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
const client = new APIGatewayClient(config);
const input = { // DeleteUsagePlanRequest
usagePlanId: "STRING_VALUE", // required
};
const command = new DeleteUsagePlanCommand(input);
const response = await client.send(command);
// {};
DeleteUsagePlanCommand Input
See DeleteUsagePlanCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
usagePlanId Required | string | undefined | The Id of the to-be-deleted usage plan. |
DeleteUsagePlanCommand Output
See DeleteUsagePlanCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | 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. |
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. |