delete_deployment¶
Operation¶
delete_deployment
¶
delete_deployment(request: DeleteDeploymentInput | DeleteDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDeploymentInputDict]) -> DeleteDeploymentOutput
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteDeploymentInput | DeleteDeploymentInputDict | 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[DeleteDeploymentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteDeploymentOutput
|
An instance of |
delete_deployment
async
¶
delete_deployment(request: DeleteDeploymentInput | DeleteDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDeploymentInputDict]) -> DeleteDeploymentOutput
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteDeploymentInput | DeleteDeploymentInputDict | 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[DeleteDeploymentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteDeploymentOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
DeleteDeploymentOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteDeploymentOutput structure.