Skip to content

get_deployments

Operation

get_deployments

get_deployments(request: GetDeploymentsInput | GetDeploymentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDeploymentsInputDict]) -> GetDeploymentsOutput

Gets information about a Deployments collection.

Parameters:

Name Type Description Default
request GetDeploymentsInput | GetDeploymentsInputDict | 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[GetDeploymentsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDeploymentsOutput

An instance of GetDeploymentsOutput.

get_deployments async

get_deployments(request: GetDeploymentsInput | GetDeploymentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDeploymentsInputDict]) -> GetDeploymentsOutput

Gets information about a Deployments collection.

Parameters:

Name Type Description Default
request GetDeploymentsInput | GetDeploymentsInputDict | 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[GetDeploymentsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDeploymentsOutput

An instance of GetDeploymentsOutput.

Input

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

GetDeploymentsInputDict

Bases: TypedDict

Dictionary form of GetDeploymentsInput.

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.

GetDeploymentsInput dataclass

Bases: _SerdeShape

Requests API Gateway to get information about a Deployments collection.

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

GetDeploymentsOutput dataclass

Bases: _SerdeShape

Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.

Attributes

items class-attribute instance-attribute
items: list[Deployment] | 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.