DeleteMethodCommand

Deletes an existing Method resource.

Example Syntax

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

import { APIGatewayClient, DeleteMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
// const { APIGatewayClient, DeleteMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
const client = new APIGatewayClient(config);
const input = { // DeleteMethodRequest
  restApiId: "STRING_VALUE", // required
  resourceId: "STRING_VALUE", // required
  httpMethod: "STRING_VALUE", // required
};
const command = new DeleteMethodCommand(input);
const response = await client.send(command);
// {};

DeleteMethodCommand Input

See DeleteMethodCommandInput for more details

Parameter
Type
Description
httpMethod
Required
string | undefined

The HTTP verb of the Method resource.

resourceId
Required
string | undefined

The Resource identifier for the Method resource.

restApiId
Required
string | undefined

The string identifier of the associated RestApi.

DeleteMethodCommand Output

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

Throws

Name
Fault
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.