Api Gateway  >  Operations  >  delete_rest_api

delete_rest_api

Operation

delete_rest_api async

delete_rest_api(input: DeleteRestApiInput, plugins: list[Plugin] | None = None) -> DeleteRestApiOutput

Deletes the specified API.

Parameters:

Name	Type	Description	Default
input	DeleteRestApiInput	An instance of DeleteRestApiInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
DeleteRestApiOutput	An instance of DeleteRestApiOutput.

Input

DeleteRestApiInput dataclass

Request to delete the specified API from your collection.

Attributes

rest_api_id class-attribute instance-attribute

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

DeleteRestApiOutput dataclass

Dataclass for DeleteRestApiOutput structure.