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.

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

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 BeginDescribeRule and EndDescribeRule.

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

Syntax

C#
public virtual Task<DescribeRuleResponse> DescribeRuleAsync(
         DescribeRuleRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudWatchEvents.Model.DescribeRuleRequest

Container for the necessary parameters to execute the DescribeRule 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 DescribeRule service method, as returned by CloudWatchEvents.

Exceptions

ExceptionCondition
InternalException This exception occurs due to unexpected causes.
ResourceNotFoundException An entity that you specified does not exist.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also