RouteSettings - Amazon API Gateway

RouteSettings

Represents the route settings for a stage.

URI

/v2/apis/apiId/stages/stageName/routesettings/routeKey

HTTP Methods

DELETE

Operation ID: DeleteRouteSettings

Deletes the RouteSettings for a stage.

Path Parameters
Name Type Required Description
stageName String True

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

routeKey String True

The route key.

apiId String True

The API identifier.

Responses
Status Code Response Model Description
204 None

The request has succeeded, and there is no additional content to send in the response payload body.

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Schemas

Response Bodies

Example NotFoundException

{ "message": "string", "resourceType": "string" }

Example LimitExceededException

{ "message": "string", "limitType": "string" }

Properties

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

limitType

string

False

The limit type.

NotFoundException

The resource specified in the request was not found. See the message field for more information.

Property Type Required Description
message

string

False

Describes the error encountered.

resourceType

string

False

The resource type.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DeleteRouteSettings