Api Gateway  >  Operations  >  get_documentation_version

get_documentation_version

Operation

get_documentation_version async

get_documentation_version(input: GetDocumentationVersionInput, plugins: list[Plugin] | None = None) -> GetDocumentationVersionOutput

Gets a documentation version.

Parameters:

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

Input

GetDocumentationVersionInput dataclass

Gets a documentation snapshot of an API.

Attributes

documentation_version class-attribute instance-attribute

documentation_version: str | None = None

The version identifier of the to-be-retrieved documentation snapshot.

rest_api_id class-attribute instance-attribute

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

GetDocumentationVersionOutput dataclass

A snapshot of the documentation of an API.

Attributes

created_date class-attribute instance-attribute

created_date: datetime | None = None

The date when the API documentation snapshot is created.

description class-attribute instance-attribute

description: str | None = None

The description of the API documentation snapshot.

version class-attribute instance-attribute

version: str | None = None

The version identifier of the API documentation snapshot.