C# (CSharp) Amazon.CloudWatchEvents.Model Пространство имен

Пространства имен

Amazon.CloudWatchEvents.Model.Internal

Классы

Имя Описание
ConcurrentModificationException
DeleteRuleRequest Container for the parameters to the DeleteRule operation. 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.

DescribeRuleRequest Container for the parameters to the DescribeRule operation. Describes the details of the specified rule.
DescribeRuleResponse The result of the DescribeRule operation.
DisableRuleRequest Container for the parameters to the DisableRule operation. 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.

EnableRuleRequest Container for the parameters to the EnableRule operation. 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.

InternalException
InvalidEventPatternException
LimitExceededException
ListRuleNamesByTargetRequest Container for the parameters to the ListRuleNamesByTarget operation. 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.
ListRuleNamesByTargetResponse The result of the ListRuleNamesByTarget operation.
ListRulesRequest Container for the parameters to the ListRules operation. 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.
ListRulesResponse The result of the ListRules operation.
ListTargetsByRuleRequest Container for the parameters to the ListTargetsByRule operation. Lists of targets assigned to the rule.
ListTargetsByRuleResponse The result of the ListTargetsByRule operation.
PutEventsRequest Container for the parameters to the PutEvents operation. Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
PutEventsRequestEntry Contains information about the event to be used in PutEvents.
PutEventsResponse The result of the PutEvents operation.
PutEventsResultEntry A PutEventsResult contains a list of PutEventsResultEntry.
PutRuleRequest Container for the parameters to the PutRule operation. 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.

PutRuleResponse The result of the PutRule operation.
PutTargetsRequest Container for the parameters to the PutTargets operation. 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.

PutTargetsResponse The result of the PutTargets operation.
PutTargetsResultEntry A PutTargetsResult contains a list of PutTargetsResultEntry.
RemoveTargetsRequest Container for the parameters to the RemoveTargets operation. 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.

RemoveTargetsResponse The result of the RemoveTargets operation.
RemoveTargetsResultEntry The ID of the target requested to be removed from the rule by Amazon CloudWatch Events.
ResourceNotFoundException
Rule Contains information about a rule in Amazon CloudWatch Events. A ListRulesResult contains a list of Rules.
Target 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.

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.
TestEventPatternRequest Container for the parameters to the TestEventPattern operation. 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.

TestEventPatternResponse The result of the TestEventPattern operation.