update_deployment¶
Operation¶
async
¶
update_deployment(input: UpdateDeploymentInput, plugins: list[Plugin] | None = None) -> UpdateDeploymentOutput
Changes information about a Deployment resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateDeploymentInput
|
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 |
|---|---|
UpdateDeploymentOutput
|
An instance of |
Input¶
dataclass
¶
Requests API Gateway to change information about a Deployment resource.
Attributes¶
class-attribute
instance-attribute
¶
deployment_id: str | None = None
The replacement identifier for the Deployment resource to change information about.
class-attribute
instance-attribute
¶
patch_operations: list[PatchOperation] | None = None
For more information about supported patch operations, see Patch Operations.
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
Output¶
dataclass
¶
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
Attributes¶
class-attribute
instance-attribute
¶
api_summary: dict[str, dict[str, MethodSnapshot]] | None = None
A summary of the RestApi at the date and time that the deployment resource was created.
class-attribute
instance-attribute
¶
created_date: datetime | None = None
The date and time that the deployment resource was created.
class-attribute
instance-attribute
¶
description: str | None = None
The description for the deployment resource.
class-attribute
instance-attribute
¶
id: str | None = None
The identifier for the deployment resource.