Skip to content

get_stages

Operation

get_stages

get_stages(request: GetStagesInput | GetStagesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetStagesInputDict]) -> GetStagesOutput

Gets information about one or more Stage resources.

Parameters:

Name Type Description Default
request GetStagesInput | GetStagesInputDict | 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[GetStagesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetStagesOutput

An instance of GetStagesOutput.

get_stages async

get_stages(request: GetStagesInput | GetStagesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetStagesInputDict]) -> GetStagesOutput

Gets information about one or more Stage resources.

Parameters:

Name Type Description Default
request GetStagesInput | GetStagesInputDict | 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[GetStagesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetStagesOutput

An instance of GetStagesOutput.

Input

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

GetStagesInputDict

Bases: TypedDict

Dictionary form of GetStagesInput.

Attributes

deployment_id instance-attribute
deployment_id: str | None

The stages' deployment identifiers.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

GetStagesInput dataclass

Bases: _SerdeShape

Requests API Gateway to get information about one or more Stage resources.

Attributes

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

The stages' deployment identifiers.

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

The string identifier of the associated RestApi.

Output

GetStagesOutput dataclass

Bases: _SerdeShape

A list of Stage resources that are associated with the ApiKey resource.

Attributes

item class-attribute instance-attribute
item: list[Stage] | None = ...

The current page of elements from this collection.

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.