Skip to content

update_deployment

Operation

update_deployment

update_deployment(request: UpdateDeploymentInput | UpdateDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDeploymentInputDict]) -> UpdateDeploymentOutput

Changes information about a Deployment resource.

Parameters:

Name Type Description Default
request UpdateDeploymentInput | UpdateDeploymentInputDict | 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[UpdateDeploymentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDeploymentOutput

An instance of UpdateDeploymentOutput.

update_deployment async

update_deployment(request: UpdateDeploymentInput | UpdateDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDeploymentInputDict]) -> UpdateDeploymentOutput

Changes information about a Deployment resource.

Parameters:

Name Type Description Default
request UpdateDeploymentInput | UpdateDeploymentInputDict | 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[UpdateDeploymentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDeploymentOutput

An instance of UpdateDeploymentOutput.

Input

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

UpdateDeploymentInputDict

Bases: TypedDict

Dictionary form of UpdateDeploymentInput.

Attributes

deployment_id instance-attribute
deployment_id: Required[str]

The replacement identifier for the Deployment resource to change information about.

patch_operations instance-attribute
patch_operations: Sequence[PatchOperation | PatchOperationDict] | None

For more information about supported patch operations, see Patch Operations.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

UpdateDeploymentInput dataclass

Bases: _SerdeShape

Requests API Gateway to change information about a Deployment resource.

Attributes

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

The replacement identifier for the Deployment resource to change information about.

patch_operations class-attribute instance-attribute
patch_operations: list[PatchOperation] | None = ...

For more information about supported patch operations, see Patch Operations.

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

The string identifier of the associated RestApi.

Output

UpdateDeploymentOutput dataclass

Bases: _SerdeShape

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

api_summary class-attribute instance-attribute
api_summary: dict[str, dict[str, MethodSnapshot]] | None = ...

A summary of the RestApi at the date and time that the deployment resource was created.

created_date class-attribute instance-attribute
created_date: datetime | None = ...

The date and time that the deployment resource was created.

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

The description for the deployment resource.

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

The identifier for the deployment resource.

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.