Skip to content

Api Gateway  >  Operations  >  get_documentation_part

get_documentation_part

Operation

get_documentation_part async 

get_documentation_part(input: GetDocumentationPartInput, plugins: list[Plugin] | None = None) -> GetDocumentationPartOutput

Gets a documentation part.

Parameters:

Name Type Description Default
input GetDocumentationPartInput

An instance of GetDocumentationPartInput.

 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
GetDocumentationPartOutput

An instance of GetDocumentationPartOutput.

Input

GetDocumentationPartInput dataclass

Gets a specified documentation part of a given API.

Attributes

documentation_part_id class-attribute instance-attribute 
documentation_part_id: str | None = None

The string identifier of the associated RestApi.

rest_api_id class-attribute instance-attribute 
rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

GetDocumentationPartOutput dataclass

A documentation part for a targeted API entity.

Attributes

id class-attribute instance-attribute 
id: str | None = None

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

location class-attribute instance-attribute 
location: DocumentationPartLocation | None = None

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

properties class-attribute instance-attribute 
properties: str | None = None

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ "description": "The API does ..." }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.