Skip to content

get_documentation_part

Operation

get_documentation_part

get_documentation_part(request: GetDocumentationPartInput | GetDocumentationPartInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDocumentationPartInputDict]) -> GetDocumentationPartOutput

Gets a documentation part.

Parameters:

Name Type Description Default
request GetDocumentationPartInput | GetDocumentationPartInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetDocumentationPartInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDocumentationPartOutput

An instance of GetDocumentationPartOutput.

get_documentation_part async

get_documentation_part(request: GetDocumentationPartInput | GetDocumentationPartInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDocumentationPartInputDict]) -> GetDocumentationPartOutput

Gets a documentation part.

Parameters:

Name Type Description Default
request GetDocumentationPartInput | GetDocumentationPartInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetDocumentationPartInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDocumentationPartOutput

An instance of GetDocumentationPartOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetDocumentationPartInputDict

Bases: TypedDict

Dictionary form of GetDocumentationPartInput.

Attributes

documentation_part_id instance-attribute
documentation_part_id: Required[str]

The string identifier of the associated RestApi.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

GetDocumentationPartInput dataclass

Bases: _SerdeShape

Gets a specified documentation part of a given API.

Attributes

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

The string identifier of the associated RestApi.

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

The string identifier of the associated RestApi.

Output

GetDocumentationPartOutput dataclass

Bases: _SerdeShape

A documentation part for a targeted API entity.

Attributes

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

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

location class-attribute instance-attribute
location: DocumentationPartLocation | 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 = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.