AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.

This operation requires permissions to perform the kinesisanalytics:StopApplication action.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStopApplication and EndStopApplication.

Namespace: Amazon.KinesisAnalytics
Assembly: AWSSDK.KinesisAnalytics.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<StopApplicationResponse> StopApplicationAsync(
         StopApplicationRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.KinesisAnalytics.Model.StopApplicationRequest

Container for the necessary parameters to execute the StopApplication service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the StopApplication service method, as returned by KinesisAnalytics.

Exceptions

ExceptionCondition
ResourceInUseException Application is not available for this operation.
ResourceNotFoundException Specified application can't be found.
UnsupportedOperationException The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also