Skip to content

API Gateway  >  Operations  >  get_models

get_models

Operation

get_models async 

get_models(input: GetModelsInput, plugins: list[Plugin] | None = None) -> GetModelsOutput

Describes existing Models defined for a RestApi resource.

Parameters:

Name Type Description Default
input GetModelsInput

An instance of GetModelsInput.

 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
GetModelsOutput

An instance of GetModelsOutput.

Input

GetModelsInput dataclass

Request to list existing Models defined for a RestApi resource.

Attributes

limit class-attribute instance-attribute 
limit: int | None = 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 = None

The current pagination position in the paged result set.

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

The string identifier of the associated RestApi.

Output

GetModelsOutput dataclass

Represents a collection of Model resources.

Attributes

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

The current page of elements from this collection.

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

The current pagination position in the paged result set.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.