C# Class Amazon.CloudWatchEvents.AmazonCloudWatchEventsClient

Implementation for accessing CloudWatchEvents Amazon CloudWatch Events helps you to respond to state changes in your AWS resources. When your resources change state they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a pre-determined schedule. For example, you can configure rules to:

Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
Direct specific API records from CloudTrail to an Amazon Kinesis stream for detailed analysis of potential security or availability risks.
Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

For more information about Amazon CloudWatch Events features, see the Amazon CloudWatch Developer Guide.

Inheritance: AmazonServiceClient, IAmazonCloudWatchEvents

显示文件 Open project: aws/aws-sdk-net

Public Methods

Method	Description
AmazonCloudWatchEventsClient ( ) : System	Constructs AmazonCloudWatchEventsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
AmazonCloudWatchEventsClient ( AWSCredentials credentials ) : System	Constructs AmazonCloudWatchEventsClient with AWS Credentials
AmazonCloudWatchEventsClient ( AWSCredentials credentials, AmazonCloudWatchEventsConfig clientConfig ) : System	Constructs AmazonCloudWatchEventsClient with AWS Credentials and an AmazonCloudWatchEventsClient Configuration object.
AmazonCloudWatchEventsClient ( AWSCredentials credentials, RegionEndpoint region ) : System	Constructs AmazonCloudWatchEventsClient with AWS Credentials
AmazonCloudWatchEventsClient ( AmazonCloudWatchEventsConfig config ) : System	Constructs AmazonCloudWatchEventsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
AmazonCloudWatchEventsClient ( RegionEndpoint region ) : System	Constructs AmazonCloudWatchEventsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System	Constructs AmazonCloudWatchEventsClient with AWS Access Key ID and AWS Secret Key
AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonCloudWatchEventsConfig clientConfig ) : System	Constructs AmazonCloudWatchEventsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchEventsClient Configuration object.
AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System	Constructs AmazonCloudWatchEventsClient with AWS Access Key ID and AWS Secret Key
AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System	Constructs AmazonCloudWatchEventsClient with AWS Access Key ID and AWS Secret Key
AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCloudWatchEventsConfig clientConfig ) : System	Constructs AmazonCloudWatchEventsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchEventsClient Configuration object.
AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System	Constructs AmazonCloudWatchEventsClient with AWS Access Key ID and AWS Secret Key
BeginDeleteRule ( DeleteRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DeleteRule operation.
BeginDescribeRule ( DescribeRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DescribeRule operation.
BeginDisableRule ( DisableRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DisableRule operation.
BeginEnableRule ( EnableRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the EnableRule operation.
BeginListRuleNamesByTarget ( ListRuleNamesByTargetRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListRuleNamesByTarget operation.
BeginListRules ( ListRulesRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListRules operation.
BeginListTargetsByRule ( ListTargetsByRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListTargetsByRule operation.
BeginPutEvents ( PutEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the PutEvents operation.
BeginPutRule ( PutRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the PutRule operation.
BeginPutTargets ( PutTargetsRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the PutTargets operation.
BeginRemoveTargets ( RemoveTargetsRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the RemoveTargets operation.
BeginTestEventPattern ( TestEventPatternRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the TestEventPattern operation.
DeleteRule ( DeleteRuleRequest request ) : DeleteRuleResponse	Deletes a rule. You must remove all targets from a rule using RemoveTargets before you can delete the rule. Note: When you delete a rule, incoming events might still continue to match to the deleted rule. Please allow a short period of time for changes to take effect.
DeleteRuleAsync ( DeleteRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DeleteRule operation.
DescribeRule ( DescribeRuleRequest request ) : DescribeRuleResponse	Describes the details of the specified rule.
DescribeRuleAsync ( DescribeRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DescribeRule operation.
DisableRule ( DisableRuleRequest request ) : DisableRuleResponse	Disables a rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. Note: When you disable a rule, incoming events might still continue to match to the disabled rule. Please allow a short period of time for changes to take effect.
DisableRuleAsync ( DisableRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DisableRule operation.
EnableRule ( EnableRuleRequest request ) : EnableRuleResponse	Enables a rule. If the rule does not exist, the operation fails. Note: When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.
EnableRuleAsync ( EnableRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the EnableRule operation.
EndDeleteRule ( IAsyncResult asyncResult ) : DeleteRuleResponse	Finishes the asynchronous execution of the DeleteRule operation.
EndDescribeRule ( IAsyncResult asyncResult ) : DescribeRuleResponse	Finishes the asynchronous execution of the DescribeRule operation.
EndDisableRule ( IAsyncResult asyncResult ) : DisableRuleResponse	Finishes the asynchronous execution of the DisableRule operation.
EndEnableRule ( IAsyncResult asyncResult ) : EnableRuleResponse	Finishes the asynchronous execution of the EnableRule operation.
EndListRuleNamesByTarget ( IAsyncResult asyncResult ) : ListRuleNamesByTargetResponse	Finishes the asynchronous execution of the ListRuleNamesByTarget operation.
EndListRules ( IAsyncResult asyncResult ) : ListRulesResponse	Finishes the asynchronous execution of the ListRules operation.
EndListTargetsByRule ( IAsyncResult asyncResult ) : ListTargetsByRuleResponse	Finishes the asynchronous execution of the ListTargetsByRule operation.
EndPutEvents ( IAsyncResult asyncResult ) : PutEventsResponse	Finishes the asynchronous execution of the PutEvents operation.
EndPutRule ( IAsyncResult asyncResult ) : PutRuleResponse	Finishes the asynchronous execution of the PutRule operation.
EndPutTargets ( IAsyncResult asyncResult ) : PutTargetsResponse	Finishes the asynchronous execution of the PutTargets operation.
EndRemoveTargets ( IAsyncResult asyncResult ) : RemoveTargetsResponse	Finishes the asynchronous execution of the RemoveTargets operation.
EndTestEventPattern ( IAsyncResult asyncResult ) : TestEventPatternResponse	Finishes the asynchronous execution of the TestEventPattern operation.
ListRuleNamesByTarget ( ListRuleNamesByTargetRequest request ) : ListRuleNamesByTargetResponse	Lists the names of the rules that the given target is put to. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRulesByTarget until the NextToken in the response is returned as null.
ListRuleNamesByTargetAsync ( ListRuleNamesByTargetRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListRuleNamesByTarget operation.
ListRules ( ) : ListRulesResponse	Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRules until the NextToken in the response is returned as null.
ListRules ( ListRulesRequest request ) : ListRulesResponse	Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRules until the NextToken in the response is returned as null.
ListRulesAsync ( ListRulesRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListRules operation.
ListRulesAsync ( System cancellationToken = default(CancellationToken) ) : Task	Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRules until the NextToken in the response is returned as null.
ListTargetsByRule ( ListTargetsByRuleRequest request ) : ListTargetsByRuleResponse	Lists of targets assigned to the rule.
ListTargetsByRuleAsync ( ListTargetsByRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListTargetsByRule operation.
PutEvents ( PutEventsRequest request ) : PutEventsResponse	Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
PutEventsAsync ( PutEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the PutEvents operation.
PutRule ( PutRuleRequest request ) : PutRuleResponse	Creates or updates a rule. Rules are enabled by default, or based on value of the State parameter. You can disable a rule using DisableRule. Note: When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule will trigger on matching events as well as on a schedule. Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
PutRuleAsync ( PutRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the PutRule operation.
PutTargets ( PutTargetsRequest request ) : PutTargetsResponse	Adds target(s) to a rule. Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets. Updates the target(s) if they are already associated with the role. In other words, if there is already a target with the given target ID, then the target associated with that ID is updated. In order to be able to make API calls against the resources you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For Amazon Kinesis streams, CloudWatch Events relies on IAM roles. For more information, see Permissions for Sending Events to Targets in the *Amazon CloudWatch Developer Guide. Input* and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target: Neither Input nor InputPath is specified, then the entire event is passed to the target in JSON form. InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed). Input is specified in the form of a valid JSON, then the matched event is overridden with this constant. Note: When you add targets to a rule, when the associated rule triggers, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.
PutTargetsAsync ( PutTargetsRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the PutTargets operation.
RemoveTargets ( RemoveTargetsRequest request ) : RemoveTargetsResponse	Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked. Note: When you remove a target, when the associated rule triggers, removed targets might still continue to be invoked. Please allow a short period of time for changes to take effect.
RemoveTargetsAsync ( RemoveTargetsRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the RemoveTargets operation.
TestEventPattern ( TestEventPatternRequest request ) : TestEventPatternResponse	Tests whether an event pattern matches the provided event. Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
TestEventPatternAsync ( TestEventPatternRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the TestEventPattern operation.

Protected Methods

Method	Description
CreateSigner ( ) : AbstractAWSSigner	Creates the signer for the service.
Dispose ( bool disposing ) : void	Disposes the service client.

Method Details

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public AmazonCloudWatchEventsClient ( ) : System
return	System

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with AWS Credentials

public AmazonCloudWatchEventsClient ( AWSCredentials credentials ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
return	System

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with AWS Credentials and an AmazonCloudWatchEventsClient Configuration object.

public AmazonCloudWatchEventsClient ( AWSCredentials credentials, AmazonCloudWatchEventsConfig clientConfig ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
clientConfig	AmazonCloudWatchEventsConfig	The AmazonCloudWatchEventsClient Configuration Object
return	System

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with AWS Credentials

public AmazonCloudWatchEventsClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
region	RegionEndpoint	The region to connect.
return	System

AmazonCloudWatchEventsClient() public method

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public AmazonCloudWatchEventsClient ( AmazonCloudWatchEventsConfig config ) : System
config	AmazonCloudWatchEventsConfig	The AmazonCloudWatchEventsClient Configuration Object
return	System

AmazonCloudWatchEventsClient() public method

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public AmazonCloudWatchEventsClient ( RegionEndpoint region ) : System
region	RegionEndpoint	The region to connect.
return	System

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with AWS Access Key ID and AWS Secret Key

public AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
return	System

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchEventsClient Configuration object.

public AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonCloudWatchEventsConfig clientConfig ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
clientConfig	AmazonCloudWatchEventsConfig	The AmazonCloudWatchEventsClient Configuration Object
return	System

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with AWS Access Key ID and AWS Secret Key

public AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
region	RegionEndpoint	The region to connect.
return	System

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with AWS Access Key ID and AWS Secret Key

public AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
awsSessionToken	string	AWS Session Token
return	System

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchEventsClient Configuration object.

public AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCloudWatchEventsConfig clientConfig ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
awsSessionToken	string	AWS Session Token
clientConfig	AmazonCloudWatchEventsConfig	The AmazonCloudWatchEventsClient Configuration Object
return	System

AmazonCloudWatchEventsClient() public method

Constructs AmazonCloudWatchEventsClient with AWS Access Key ID and AWS Secret Key

public AmazonCloudWatchEventsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
awsSessionToken	string	AWS Session Token
region	RegionEndpoint	The region to connect.
return	System

BeginDeleteRule() public method

Initiates the asynchronous execution of the DeleteRule operation.

public BeginDeleteRule ( DeleteRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.DeleteRuleRequest	Container for the necessary parameters to execute the DeleteRule operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDescribeRule() public method

Initiates the asynchronous execution of the DescribeRule operation.

public BeginDescribeRule ( DescribeRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.DescribeRuleRequest	Container for the necessary parameters to execute the DescribeRule operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDisableRule() public method

Initiates the asynchronous execution of the DisableRule operation.

public BeginDisableRule ( DisableRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.DisableRuleRequest	Container for the necessary parameters to execute the DisableRule operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginEnableRule() public method

Initiates the asynchronous execution of the EnableRule operation.

public BeginEnableRule ( EnableRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.EnableRuleRequest	Container for the necessary parameters to execute the EnableRule operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListRuleNamesByTarget() public method

Initiates the asynchronous execution of the ListRuleNamesByTarget operation.

public BeginListRuleNamesByTarget ( ListRuleNamesByTargetRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.ListRuleNamesByTargetRequest	Container for the necessary parameters to execute the ListRuleNamesByTarget operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListRules() public method

Initiates the asynchronous execution of the ListRules operation.

public BeginListRules ( ListRulesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.ListRulesRequest	Container for the necessary parameters to execute the ListRules operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListTargetsByRule() public method

Initiates the asynchronous execution of the ListTargetsByRule operation.

public BeginListTargetsByRule ( ListTargetsByRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.ListTargetsByRuleRequest	Container for the necessary parameters to execute the ListTargetsByRule operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginPutEvents() public method

Initiates the asynchronous execution of the PutEvents operation.

public BeginPutEvents ( PutEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.PutEventsRequest	Container for the necessary parameters to execute the PutEvents operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginPutRule() public method

Initiates the asynchronous execution of the PutRule operation.

public BeginPutRule ( PutRuleRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.PutRuleRequest	Container for the necessary parameters to execute the PutRule operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginPutTargets() public method

Initiates the asynchronous execution of the PutTargets operation.

public BeginPutTargets ( PutTargetsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.PutTargetsRequest	Container for the necessary parameters to execute the PutTargets operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginRemoveTargets() public method

Initiates the asynchronous execution of the RemoveTargets operation.

public BeginRemoveTargets ( RemoveTargetsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.RemoveTargetsRequest	Container for the necessary parameters to execute the RemoveTargets operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginTestEventPattern() public method

Initiates the asynchronous execution of the TestEventPattern operation.

public BeginTestEventPattern ( TestEventPatternRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.CloudWatchEvents.Model.TestEventPatternRequest	Container for the necessary parameters to execute the TestEventPattern operation on AmazonCloudWatchEventsClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

CreateSigner() protected method

Creates the signer for the service.

protected CreateSigner ( ) : AbstractAWSSigner
return	Amazon.Runtime.Internal.Auth.AbstractAWSSigner

DeleteRule() public method

Deletes a rule. You must remove all targets from a rule using RemoveTargets before you can delete the rule.

Note: When you delete a rule, incoming events might still continue to match to the deleted rule. Please allow a short period of time for changes to take effect.

/// This exception occurs if there is concurrent modification on rule or target. /// /// This exception occurs due to unexpected causes. ///

public DeleteRule ( DeleteRuleRequest request ) : DeleteRuleResponse
request	Amazon.CloudWatchEvents.Model.DeleteRuleRequest	Container for the necessary parameters to execute the DeleteRule service method.
return	DeleteRuleResponse

DeleteRuleAsync() public method

Initiates the asynchronous execution of the DeleteRule operation.

public DeleteRuleAsync ( DeleteRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.DeleteRuleRequest	Container for the necessary parameters to execute the DeleteRule operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DescribeRule() public method

Describes the details of the specified rule.

/// This exception occurs due to unexpected causes. /// /// The rule does not exist. ///

public DescribeRule ( DescribeRuleRequest request ) : DescribeRuleResponse
request	Amazon.CloudWatchEvents.Model.DescribeRuleRequest	Container for the necessary parameters to execute the DescribeRule service method.
return	Amazon.CloudWatchEvents.Model.DescribeRuleResponse

DescribeRuleAsync() public method

Initiates the asynchronous execution of the DescribeRule operation.

public DescribeRuleAsync ( DescribeRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.DescribeRuleRequest	Container for the necessary parameters to execute the DescribeRule operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DisableRule() public method

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

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

/// This exception occurs if there is concurrent modification on rule or target. /// /// This exception occurs due to unexpected causes. /// /// The rule does not exist. ///

public DisableRule ( DisableRuleRequest request ) : DisableRuleResponse
request	Amazon.CloudWatchEvents.Model.DisableRuleRequest	Container for the necessary parameters to execute the DisableRule service method.
return	DisableRuleResponse

DisableRuleAsync() public method

Initiates the asynchronous execution of the DisableRule operation.

public DisableRuleAsync ( DisableRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.DisableRuleRequest	Container for the necessary parameters to execute the DisableRule operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

Dispose() protected method

Disposes the service client.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

EnableRule() public method

Enables a rule. If the rule does not exist, the operation fails.

Note: When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.

/// This exception occurs if there is concurrent modification on rule or target. /// /// This exception occurs due to unexpected causes. /// /// The rule does not exist. ///

public EnableRule ( EnableRuleRequest request ) : EnableRuleResponse
request	Amazon.CloudWatchEvents.Model.EnableRuleRequest	Container for the necessary parameters to execute the EnableRule service method.
return	EnableRuleResponse

EnableRuleAsync() public method

Initiates the asynchronous execution of the EnableRule operation.

public EnableRuleAsync ( EnableRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.EnableRuleRequest	Container for the necessary parameters to execute the EnableRule operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

EndDeleteRule() public method

Finishes the asynchronous execution of the DeleteRule operation.

public EndDeleteRule ( IAsyncResult asyncResult ) : DeleteRuleResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDeleteRule.
return	DeleteRuleResponse

EndDescribeRule() public method

Finishes the asynchronous execution of the DescribeRule operation.

public EndDescribeRule ( IAsyncResult asyncResult ) : DescribeRuleResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDescribeRule.
return	Amazon.CloudWatchEvents.Model.DescribeRuleResponse

EndDisableRule() public method

Finishes the asynchronous execution of the DisableRule operation.

public EndDisableRule ( IAsyncResult asyncResult ) : DisableRuleResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDisableRule.
return	DisableRuleResponse

EndEnableRule() public method

Finishes the asynchronous execution of the EnableRule operation.

public EndEnableRule ( IAsyncResult asyncResult ) : EnableRuleResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginEnableRule.
return	EnableRuleResponse

EndListRuleNamesByTarget() public method

Finishes the asynchronous execution of the ListRuleNamesByTarget operation.

public EndListRuleNamesByTarget ( IAsyncResult asyncResult ) : ListRuleNamesByTargetResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListRuleNamesByTarget.
return	Amazon.CloudWatchEvents.Model.ListRuleNamesByTargetResponse

EndListRules() public method

Finishes the asynchronous execution of the ListRules operation.

public EndListRules ( IAsyncResult asyncResult ) : ListRulesResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListRules.
return	Amazon.CloudWatchEvents.Model.ListRulesResponse

EndListTargetsByRule() public method

Finishes the asynchronous execution of the ListTargetsByRule operation.

public EndListTargetsByRule ( IAsyncResult asyncResult ) : ListTargetsByRuleResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListTargetsByRule.
return	Amazon.CloudWatchEvents.Model.ListTargetsByRuleResponse

EndPutEvents() public method

Finishes the asynchronous execution of the PutEvents operation.

public EndPutEvents ( IAsyncResult asyncResult ) : PutEventsResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginPutEvents.
return	Amazon.CloudWatchEvents.Model.PutEventsResponse

EndPutRule() public method

Finishes the asynchronous execution of the PutRule operation.

public EndPutRule ( IAsyncResult asyncResult ) : PutRuleResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginPutRule.
return	Amazon.CloudWatchEvents.Model.PutRuleResponse

EndPutTargets() public method

Finishes the asynchronous execution of the PutTargets operation.

public EndPutTargets ( IAsyncResult asyncResult ) : PutTargetsResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginPutTargets.
return	Amazon.CloudWatchEvents.Model.PutTargetsResponse

EndRemoveTargets() public method

Finishes the asynchronous execution of the RemoveTargets operation.

public EndRemoveTargets ( IAsyncResult asyncResult ) : RemoveTargetsResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginRemoveTargets.
return	Amazon.CloudWatchEvents.Model.RemoveTargetsResponse

EndTestEventPattern() public method

Finishes the asynchronous execution of the TestEventPattern operation.

public EndTestEventPattern ( IAsyncResult asyncResult ) : TestEventPatternResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginTestEventPattern.
return	Amazon.CloudWatchEvents.Model.TestEventPatternResponse

ListRuleNamesByTarget() public method

Lists the names of the rules that the given target is put to. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRulesByTarget until the NextToken in the response is returned as null.

/// This exception occurs due to unexpected causes. ///

public ListRuleNamesByTarget ( ListRuleNamesByTargetRequest request ) : ListRuleNamesByTargetResponse
request	Amazon.CloudWatchEvents.Model.ListRuleNamesByTargetRequest	Container for the necessary parameters to execute the ListRuleNamesByTarget service method.
return	Amazon.CloudWatchEvents.Model.ListRuleNamesByTargetResponse

ListRuleNamesByTargetAsync() public method

Initiates the asynchronous execution of the ListRuleNamesByTarget operation.

public ListRuleNamesByTargetAsync ( ListRuleNamesByTargetRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.ListRuleNamesByTargetRequest	Container for the necessary parameters to execute the ListRuleNamesByTarget operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListRules() public method

Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRules until the NextToken in the response is returned as null.

/// This exception occurs due to unexpected causes. ///

public ListRules ( ) : ListRulesResponse
return	Amazon.CloudWatchEvents.Model.ListRulesResponse

ListRules() public method

/// This exception occurs due to unexpected causes. ///

public ListRules ( ListRulesRequest request ) : ListRulesResponse
request	Amazon.CloudWatchEvents.Model.ListRulesRequest	Container for the necessary parameters to execute the ListRules service method.
return	Amazon.CloudWatchEvents.Model.ListRulesResponse

ListRulesAsync() public method

Initiates the asynchronous execution of the ListRules operation.

public ListRulesAsync ( ListRulesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.ListRulesRequest	Container for the necessary parameters to execute the ListRules operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListRulesAsync() public method

/// This exception occurs due to unexpected causes. ///

public ListRulesAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListTargetsByRule() public method

Lists of targets assigned to the rule.

/// This exception occurs due to unexpected causes. /// /// The rule does not exist. ///

public ListTargetsByRule ( ListTargetsByRuleRequest request ) : ListTargetsByRuleResponse
request	Amazon.CloudWatchEvents.Model.ListTargetsByRuleRequest	Container for the necessary parameters to execute the ListTargetsByRule service method.
return	Amazon.CloudWatchEvents.Model.ListTargetsByRuleResponse

ListTargetsByRuleAsync() public method

Initiates the asynchronous execution of the ListTargetsByRule operation.

public ListTargetsByRuleAsync ( ListTargetsByRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.ListTargetsByRuleRequest	Container for the necessary parameters to execute the ListTargetsByRule operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

PutEvents() public method

Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.

/// This exception occurs due to unexpected causes. ///

public PutEvents ( PutEventsRequest request ) : PutEventsResponse
request	Amazon.CloudWatchEvents.Model.PutEventsRequest	Container for the necessary parameters to execute the PutEvents service method.
return	Amazon.CloudWatchEvents.Model.PutEventsResponse

PutEventsAsync() public method

Initiates the asynchronous execution of the PutEvents operation.

public PutEventsAsync ( PutEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.PutEventsRequest	Container for the necessary parameters to execute the PutEvents operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

PutRule() public method

Creates or updates a rule. Rules are enabled by default, or based on value of the State parameter. You can disable a rule using DisableRule.

Note: When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule will trigger on matching events as well as on a schedule.

Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

/// This exception occurs if there is concurrent modification on rule or target. /// /// This exception occurs due to unexpected causes. /// /// The event pattern is invalid. /// /// This exception occurs if you try to create more rules or add more targets to a rule /// than allowed by default. ///

public PutRule ( PutRuleRequest request ) : PutRuleResponse
request	Amazon.CloudWatchEvents.Model.PutRuleRequest	Container for the necessary parameters to execute the PutRule service method.
return	Amazon.CloudWatchEvents.Model.PutRuleResponse

PutRuleAsync() public method

Initiates the asynchronous execution of the PutRule operation.

public PutRuleAsync ( PutRuleRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.PutRuleRequest	Container for the necessary parameters to execute the PutRule operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

PutTargets() public method

Adds target(s) to a rule. Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets. Updates the target(s) if they are already associated with the role. In other words, if there is already a target with the given target ID, then the target associated with that ID is updated.

In order to be able to make API calls against the resources you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For Amazon Kinesis streams, CloudWatch Events relies on IAM roles. For more information, see Permissions for Sending Events to Targets in the Amazon CloudWatch Developer Guide.

Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target:

Neither Input nor InputPath is specified, then the entire event is passed to the target in JSON form.
InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed).
Input is specified in the form of a valid JSON, then the matched event is overridden with this constant.

Note: When you add targets to a rule, when the associated rule triggers, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.

/// This exception occurs if there is concurrent modification on rule or target. /// /// This exception occurs due to unexpected causes. /// /// This exception occurs if you try to create more rules or add more targets to a rule /// than allowed by default. /// /// The rule does not exist. ///

public PutTargets ( PutTargetsRequest request ) : PutTargetsResponse
request	Amazon.CloudWatchEvents.Model.PutTargetsRequest	Container for the necessary parameters to execute the PutTargets service method.
return	Amazon.CloudWatchEvents.Model.PutTargetsResponse

PutTargetsAsync() public method

Initiates the asynchronous execution of the PutTargets operation.

public PutTargetsAsync ( PutTargetsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.PutTargetsRequest	Container for the necessary parameters to execute the PutTargets operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

RemoveTargets() public method

Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked.

Note: When you remove a target, when the associated rule triggers, removed targets might still continue to be invoked. Please allow a short period of time for changes to take effect.

/// This exception occurs if there is concurrent modification on rule or target. /// /// This exception occurs due to unexpected causes. /// /// The rule does not exist. ///

public RemoveTargets ( RemoveTargetsRequest request ) : RemoveTargetsResponse
request	Amazon.CloudWatchEvents.Model.RemoveTargetsRequest	Container for the necessary parameters to execute the RemoveTargets service method.
return	Amazon.CloudWatchEvents.Model.RemoveTargetsResponse

RemoveTargetsAsync() public method

Initiates the asynchronous execution of the RemoveTargets operation.

public RemoveTargetsAsync ( RemoveTargetsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.RemoveTargetsRequest	Container for the necessary parameters to execute the RemoveTargets operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

TestEventPattern() public method

Tests whether an event pattern matches the provided event.

/// This exception occurs due to unexpected causes. /// /// The event pattern is invalid. ///

public TestEventPattern ( TestEventPatternRequest request ) : TestEventPatternResponse
request	Amazon.CloudWatchEvents.Model.TestEventPatternRequest	Container for the necessary parameters to execute the TestEventPattern service method.
return	Amazon.CloudWatchEvents.Model.TestEventPatternResponse

TestEventPatternAsync() public method

Initiates the asynchronous execution of the TestEventPattern operation.

public TestEventPatternAsync ( TestEventPatternRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.CloudWatchEvents.Model.TestEventPatternRequest	Container for the necessary parameters to execute the TestEventPattern operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task