stop_service_deployment¶
Operation¶
stop_service_deployment
¶
stop_service_deployment(request: StopServiceDeploymentInput | StopServiceDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopServiceDeploymentInputDict]) -> StopServiceDeploymentOutput
Stops an ongoing service deployment.
The following stop types are avaiable:
- ROLLBACK - This option rolls back the service deployment to the previous service revision.
You can use this option even if you didn't configure the service deployment for the rollback option.
For more information, see Stopping Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StopServiceDeploymentInput | StopServiceDeploymentInputDict | 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[StopServiceDeploymentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StopServiceDeploymentOutput
|
An instance of |
stop_service_deployment
async
¶
stop_service_deployment(request: StopServiceDeploymentInput | StopServiceDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopServiceDeploymentInputDict]) -> StopServiceDeploymentOutput
Stops an ongoing service deployment.
The following stop types are avaiable:
- ROLLBACK - This option rolls back the service deployment to the previous service revision.
You can use this option even if you didn't configure the service deployment for the rollback option.
For more information, see Stopping Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StopServiceDeploymentInput | StopServiceDeploymentInputDict | 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[StopServiceDeploymentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StopServiceDeploymentOutput
|
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¶
StopServiceDeploymentOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StopServiceDeploymentOutput structure.