Skip to content

ECS  >  Operations  >  stop_service_deployment

stop_service_deployment

Operation

stop_service_deployment async 

stop_service_deployment(input: StopServiceDeploymentInput, plugins: list[Plugin] | None = None) -> 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
input StopServiceDeploymentInput

An instance of StopServiceDeploymentInput.

 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
StopServiceDeploymentOutput

An instance of StopServiceDeploymentOutput.

Input

StopServiceDeploymentInput dataclass

Bases: _SerdeShape

Dataclass for StopServiceDeploymentInput structure.

Attributes

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

The ARN of the service deployment that you want to stop.

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

How you want Amazon ECS to stop the service.

The valid values are ROLLBACK.

Output

StopServiceDeploymentOutput dataclass

Bases: _SerdeShape

Dataclass for StopServiceDeploymentOutput structure.

Attributes

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.

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

The ARN of the stopped service deployment.