Skip to content

get_models

Operation

get_models

get_models(request: GetModelsInput | GetModelsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetModelsInputDict]) -> GetModelsOutput

Describes existing Models defined for a RestApi resource.

Parameters:

Name Type Description Default
request GetModelsInput | GetModelsInputDict | 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[GetModelsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetModelsOutput

An instance of GetModelsOutput.

get_models async

get_models(request: GetModelsInput | GetModelsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetModelsInputDict]) -> GetModelsOutput

Describes existing Models defined for a RestApi resource.

Parameters:

Name Type Description Default
request GetModelsInput | GetModelsInputDict | 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[GetModelsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetModelsOutput

An instance of GetModelsOutput.

Input

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

GetModelsInputDict

Bases: TypedDict

Dictionary form of GetModelsInput.

Attributes

limit instance-attribute
limit: int | None

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position instance-attribute
position: str | None

The current pagination position in the paged result set.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

GetModelsInput dataclass

Bases: _SerdeShape

Request to list existing Models defined for a RestApi resource.

Attributes

limit class-attribute instance-attribute
limit: int | None = ...

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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

The current pagination position in the paged result set.

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

The string identifier of the associated RestApi.

Output

GetModelsOutput dataclass

Bases: _SerdeShape

Represents a collection of Model resources.

Attributes

items class-attribute instance-attribute
items: list[Model] | None = ...

The current page of elements from this collection.

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

The current pagination position in the paged result set.

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.