Skip to content

create_documentation_version

Operation

create_documentation_version

create_documentation_version(request: CreateDocumentationVersionInput | CreateDocumentationVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDocumentationVersionInputDict]) -> CreateDocumentationVersionOutput

Creates a documentation version

Parameters:

Name Type Description Default
request CreateDocumentationVersionInput | CreateDocumentationVersionInputDict | 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[CreateDocumentationVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateDocumentationVersionOutput

An instance of CreateDocumentationVersionOutput.

create_documentation_version async

create_documentation_version(request: CreateDocumentationVersionInput | CreateDocumentationVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDocumentationVersionInputDict]) -> CreateDocumentationVersionOutput

Creates a documentation version

Parameters:

Name Type Description Default
request CreateDocumentationVersionInput | CreateDocumentationVersionInputDict | 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[CreateDocumentationVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateDocumentationVersionOutput

An instance of CreateDocumentationVersionOutput.

Input

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

CreateDocumentationVersionInputDict

Bases: TypedDict

Dictionary form of CreateDocumentationVersionInput.

Attributes

description instance-attribute
description: str | None

A description about the new documentation snapshot.

documentation_version instance-attribute
documentation_version: Required[str]

The version identifier of the new snapshot.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

stage_name instance-attribute
stage_name: str | None

The stage name to be associated with the new documentation snapshot.

CreateDocumentationVersionInput dataclass

Bases: _SerdeShape

Creates a new documentation version of a given API.

Attributes

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

A description about the new documentation snapshot.

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

The version identifier of the new snapshot.

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

The string identifier of the associated RestApi.

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

The stage name to be associated with the new documentation snapshot.

Output

CreateDocumentationVersionOutput dataclass

Bases: _SerdeShape

A snapshot of the documentation of an API.

Attributes

created_date class-attribute instance-attribute
created_date: datetime | None = ...

The date when the API documentation snapshot is created.

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

The description of the API documentation snapshot.

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.

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

The version identifier of the API documentation snapshot.