get_deployments¶
Operation¶
async
¶
get_deployments(input: GetDeploymentsInput, plugins: list[Plugin] | None = None) -> GetDeploymentsOutput
Gets information about a Deployments collection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetDeploymentsInput
|
An instance of |
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 |
|---|---|
GetDeploymentsOutput
|
An instance of |
Input¶
dataclass
¶
Requests API Gateway to get information about a Deployments collection.
Attributes¶
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.
class-attribute
instance-attribute
¶
position: str | None = None
The current pagination position in the paged result set.
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
Output¶
dataclass
¶
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¶
class-attribute
instance-attribute
¶
items: list[Deployment] | None = None
The current page of elements from this collection.
class-attribute
instance-attribute
¶
position: str | None = None
The current pagination position in the paged result set.