stopFlow method

Future<StopFlowResponse> stopFlow({
  1. required String flowName,
})

Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.

May throw ConflictException. May throw InternalServerException. May throw ResourceNotFoundException. May throw UnsupportedOperationException.

Parameter flowName : The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Implementation

Future<StopFlowResponse> stopFlow({
  required String flowName,
}) async {
  final $payload = <String, dynamic>{
    'flowName': flowName,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/stop-flow',
    exceptionFnMap: _exceptionFns,
  );
  return StopFlowResponse.fromJson(response);
}