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.

Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

When you disable a rule, incoming events might continue to match to the disabled rule. Please allow a short period of time for changes to take effect.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DisableRuleAsync.

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

Syntax

C#
public virtual DisableRuleResponse DisableRule(
         DisableRuleRequest request
)
Parameters
request
Type: Amazon.CloudWatchEvents.Model.DisableRuleRequest

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

Return Value
The response from the DisableRule service method, as returned by CloudWatchEvents.

Exceptions

ExceptionCondition
ConcurrentModificationException There is concurrent modification on a rule or target.
InternalException This exception occurs due to unexpected causes.
ResourceNotFoundException An entity that you specified does not exist.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also