Api Gateway  >  Operations  >  delete_documentation_version

delete_documentation_version

Operation

delete_documentation_version async

delete_documentation_version(input: DeleteDocumentationVersionInput, plugins: list[Plugin] | None = None) -> DeleteDocumentationVersionOutput

Deletes a documentation version.

Parameters:

Name	Type	Description	Default
input	DeleteDocumentationVersionInput	An instance of DeleteDocumentationVersionInput.	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
DeleteDocumentationVersionOutput	An instance of DeleteDocumentationVersionOutput.

Input

DeleteDocumentationVersionInput dataclass

Deletes an existing documentation version of an API.

Attributes

documentation_version class-attribute instance-attribute

documentation_version: str | None = None

The version identifier of a to-be-deleted documentation snapshot.

rest_api_id class-attribute instance-attribute

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

DeleteDocumentationVersionOutput dataclass

Dataclass for DeleteDocumentationVersionOutput structure.