aws_sdk_kinesisanalyticsv2/client/stop_application.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`StopApplication`](crate::operation::stop_application::builders::StopApplicationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`application_name(impl Into<String>)`](crate::operation::stop_application::builders::StopApplicationFluentBuilder::application_name) / [`set_application_name(Option<String>)`](crate::operation::stop_application::builders::StopApplicationFluentBuilder::set_application_name):<br>required: **true**<br><p>The name of the running application to stop.</p><br>
7 /// - [`force(bool)`](crate::operation::stop_application::builders::StopApplicationFluentBuilder::force) / [`set_force(Option<bool>)`](crate::operation::stop_application::builders::StopApplicationFluentBuilder::set_force):<br>required: **false**<br><p>Set to <code>true</code> to force the application to stop. If you set <code>Force</code> to <code>true</code>, Managed Service for Apache Flink stops the application without taking a snapshot.</p><note> <p>Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.</p> </note> <p>You can only force stop a Managed Service for Apache Flink application. You can't force stop a SQL-based Kinesis Data Analytics application.</p> <p>The application must be in the <code>STARTING</code>, <code>UPDATING</code>, <code>STOPPING</code>, <code>AUTOSCALING</code>, or <code>RUNNING</code> status.</p><br>
8 /// - On success, responds with [`StopApplicationOutput`](crate::operation::stop_application::StopApplicationOutput) with field(s):
9 /// - [`operation_id(Option<String>)`](crate::operation::stop_application::StopApplicationOutput::operation_id): <p>The operation ID that can be used to track the request.</p>
10 /// - On failure, responds with [`SdkError<StopApplicationError>`](crate::operation::stop_application::StopApplicationError)
11 pub fn stop_application(&self) -> crate::operation::stop_application::builders::StopApplicationFluentBuilder {
12 crate::operation::stop_application::builders::StopApplicationFluentBuilder::new(self.handle.clone())
13 }
14}