ECS / Client / stop_service_deployment

stop_service_deployment

ECS.Client.stop_service_deployment(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.stop_service_deployment(
    serviceDeploymentArn='string',
    stopType='ABORT'|'ROLLBACK'
)
Parameters:

  • serviceDeploymentArn (string) –

    [REQUIRED]

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

  • stopType (string) –

    How you want Amazon ECS to stop the service.

    The valid values are ROLLBACK.

Return type:

dict

Returns:

Response Syntax

{
    'serviceDeploymentArn': 'string'
}

Response Structure

  • (dict) –

    • serviceDeploymentArn (string) –

      The ARN of the stopped service deployment.

Exceptions