stopServiceDeployment method

Future<StopServiceDeploymentResponse> stopServiceDeployment({
  1. required String serviceDeploymentArn,
  2. StopServiceDeploymentStopType? stopType,
})

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.

May throw AccessDeniedException. May throw ClientException. May throw ConflictException. May throw InvalidParameterException. May throw ServerException. May throw ServiceDeploymentNotFoundException. May throw UnsupportedFeatureException.

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

Parameter stopType : How you want Amazon ECS to stop the service.

The valid values are ROLLBACK.

Implementation

Future<StopServiceDeploymentResponse> stopServiceDeployment({
  required String serviceDeploymentArn,
  StopServiceDeploymentStopType? stopType,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonEC2ContainerServiceV20141113.StopServiceDeployment'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'serviceDeploymentArn': serviceDeploymentArn,
      if (stopType != null) 'stopType': stopType.value,
    },
  );

  return StopServiceDeploymentResponse.fromJson(jsonResponse.body);
}