You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudWatchEvents::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



163
164
165
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 163

def initialize(*args)
  super
end

Instance Method Details

#delete_rule(params = {}) ⇒ Struct

Deletes the specified rule.

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

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

Examples:

Request syntax with placeholder values


resp = client.delete_rule({
  name: "RuleName", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the rule.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



193
194
195
196
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 193

def delete_rule(params = {}, options = {})
  req = build_request(:delete_rule, params)
  req.send_request(options)
end

#describe_event_bus(params = {}) ⇒ Types::DescribeEventBusResponse

Displays the external AWS accounts that are permitted to write events to your account using your account's event bus, and the associated policy. To enable your account to receive events from other accounts, use PutPermission.

Examples:

Response structure


resp.name #=> String
resp.arn #=> String
resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

See Also:



219
220
221
222
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 219

def describe_event_bus(params = {}, options = {})
  req = build_request(:describe_event_bus, params)
  req.send_request(options)
end

#describe_rule(params = {}) ⇒ Types::DescribeRuleResponse

Describes the specified rule.

Examples:

Request syntax with placeholder values


resp = client.describe_rule({
  name: "RuleName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.event_pattern #=> String
resp.schedule_expression #=> String
resp.state #=> String, one of "ENABLED", "DISABLED"
resp.description #=> String
resp.role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the rule.

Returns:

See Also:



259
260
261
262
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 259

def describe_rule(params = {}, options = {})
  req = build_request(:describe_rule, params)
  req.send_request(options)
end

#disable_rule(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.disable_rule({
  name: "RuleName", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the rule.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



286
287
288
289
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 286

def disable_rule(params = {}, options = {})
  req = build_request(:disable_rule, params)
  req.send_request(options)
end

#enable_rule(params = {}) ⇒ Struct

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

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.

Examples:

Request syntax with placeholder values


resp = client.enable_rule({
  name: "RuleName", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the rule.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



313
314
315
316
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 313

def enable_rule(params = {}, options = {})
  req = build_request(:enable_rule, params)
  req.send_request(options)
end

#list_rule_names_by_target(params = {}) ⇒ Types::ListRuleNamesByTargetResponse

Lists the rules for the specified target. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account.

Examples:

Request syntax with placeholder values


resp = client.list_rule_names_by_target({
  target_arn: "TargetArn", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.rule_names #=> Array
resp.rule_names[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :target_arn (required, String)

    The Amazon Resource Name (ARN) of the target resource.

  • :next_token (String)

    The token returned by a previous call to retrieve the next set of results.

  • :limit (Integer)

    The maximum number of results to return.

Returns:

See Also:



355
356
357
358
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 355

def list_rule_names_by_target(params = {}, options = {})
  req = build_request(:list_rule_names_by_target, params)
  req.send_request(options)
end

#list_rules(params = {}) ⇒ Types::ListRulesResponse

Lists your Amazon CloudWatch Events rules. You can either list all the rules or you can provide a prefix to match to the rule names.

Examples:

Request syntax with placeholder values


resp = client.list_rules({
  name_prefix: "RuleName",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.rules #=> Array
resp.rules[0].name #=> String
resp.rules[0].arn #=> String
resp.rules[0].event_pattern #=> String
resp.rules[0].state #=> String, one of "ENABLED", "DISABLED"
resp.rules[0].description #=> String
resp.rules[0].schedule_expression #=> String
resp.rules[0].role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name_prefix (String)

    The prefix matching the rule name.

  • :next_token (String)

    The token returned by a previous call to retrieve the next set of results.

  • :limit (Integer)

    The maximum number of results to return.

Returns:

See Also:



402
403
404
405
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 402

def list_rules(params = {}, options = {})
  req = build_request(:list_rules, params)
  req.send_request(options)
end

#list_targets_by_rule(params = {}) ⇒ Types::ListTargetsByRuleResponse

Lists the targets assigned to the specified rule.

Examples:

Request syntax with placeholder values


resp = client.list_targets_by_rule({
  rule: "RuleName", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.targets #=> Array
resp.targets[0].id #=> String
resp.targets[0].arn #=> String
resp.targets[0].role_arn #=> String
resp.targets[0].input #=> String
resp.targets[0].input_path #=> String
resp.targets[0].input_transformer.input_paths_map #=> Hash
resp.targets[0].input_transformer.input_paths_map["InputTransformerPathKey"] #=> String
resp.targets[0].input_transformer.input_template #=> String
resp.targets[0].kinesis_parameters.partition_key_path #=> String
resp.targets[0].run_command_parameters.run_command_targets #=> Array
resp.targets[0].run_command_parameters.run_command_targets[0].key #=> String
resp.targets[0].run_command_parameters.run_command_targets[0].values #=> Array
resp.targets[0].run_command_parameters.run_command_targets[0].values[0] #=> String
resp.targets[0].ecs_parameters.task_definition_arn #=> String
resp.targets[0].ecs_parameters.task_count #=> Integer
resp.targets[0].batch_parameters.job_definition #=> String
resp.targets[0].batch_parameters.job_name #=> String
resp.targets[0].batch_parameters.array_properties.size #=> Integer
resp.targets[0].batch_parameters.retry_strategy.attempts #=> Integer
resp.targets[0].sqs_parameters.message_group_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :rule (required, String)

    The name of the rule.

  • :next_token (String)

    The token returned by a previous call to retrieve the next set of results.

  • :limit (Integer)

    The maximum number of results to return.

Returns:

See Also:



461
462
463
464
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 461

def list_targets_by_rule(params = {}, options = {})
  req = build_request(:list_targets_by_rule, params)
  req.send_request(options)
end

#put_events(params = {}) ⇒ Types::PutEventsResponse

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

Examples:

Request syntax with placeholder values


resp = client.put_events({
  entries: [ # required
    {
      time: Time.now,
      source: "String",
      resources: ["EventResource"],
      detail_type: "String",
      detail: "String",
    },
  ],
})

Response structure


resp.failed_entry_count #=> Integer
resp.entries #=> Array
resp.entries[0].event_id #=> String
resp.entries[0].error_code #=> String
resp.entries[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :entries (required, Array<Types::PutEventsRequestEntry>)

    The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

Returns:

See Also:



505
506
507
508
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 505

def put_events(params = {}, options = {})
  req = build_request(:put_events, params)
  req.send_request(options)
end

#put_permission(params = {}) ⇒ Struct

Running PutPermission permits the specified AWS account to put events to your account's default event bus. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus.

For another account to send events to your account, that external account must have a CloudWatch Events rule with your account's default event bus as a target.

To enable multiple AWS accounts to put events to your default event bus, run PutPermission once for each of these accounts.

The permission policy on the default event bus cannot exceed 10KB in size.

Examples:

Request syntax with placeholder values


resp = client.put_permission({
  action: "Action", # required
  principal: "Principal", # required
  statement_id: "StatementId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :action (required, String)

    The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

  • :principal (required, String)

    The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

    If you specify "*", avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

  • :statement_id (required, String)

    An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



560
561
562
563
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 560

def put_permission(params = {}, options = {})
  req = build_request(:put_permission, params)
  req.send_request(options)
end

#put_rule(params = {}) ⇒ Types::PutRuleResponse

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

If you are updating an existing rule, the rule is completely replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values.

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 triggers on matching events as well as on a schedule.

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.

Examples:

Request syntax with placeholder values


resp = client.put_rule({
  name: "RuleName", # required
  schedule_expression: "ScheduleExpression",
  event_pattern: "EventPattern",
  state: "ENABLED", # accepts ENABLED, DISABLED
  description: "RuleDescription",
  role_arn: "RoleArn",
})

Response structure


resp.rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the rule that you are creating or updating.

  • :schedule_expression (String)

    The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

  • :event_pattern (String)

    The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

  • :state (String)

    Indicates whether the rule is enabled or disabled.

  • :description (String)

    A description of the rule.

  • :role_arn (String)

    The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Returns:

See Also:



639
640
641
642
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 639

def put_rule(params = {}, options = {})
  req = build_request(:put_rule, params)
  req.send_request(options)
end

#put_targets(params = {}) ⇒ Types::PutTargetsResponse

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

You can configure the following as targets for CloudWatch Events:

  • EC2 instances

  • AWS Lambda functions

  • Streams in Amazon Kinesis Streams

  • Delivery streams in Amazon Kinesis Firehose

  • Amazon ECS tasks

  • AWS Step Functions state machines

  • AWS Batch jobs

  • Pipelines in Amazon Code Pipeline

  • Amazon Inspector assessment templates

  • Amazon SNS topics

  • Amazon SQS queues, including FIFO queues

  • The default event bus of another AWS account

Note that creating rules with built-in targets is supported only in the AWS Management Console.

For some target types, PutTargets provides target-specific parameters. If the target is an Amazon Kinesis stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon CloudWatch Events User Guide.

If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account by setting that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to antoher account is charged as a custom event. The account receiving the event is not charged. For more information on pricing, see Amazon CloudWatch Pricing.

For more information about enabling cross-account events, see PutPermission.

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

  • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON form (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).

  • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.

  • If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).

  • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.

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

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

Examples:

Request syntax with placeholder values


resp = client.put_targets({
  rule: "RuleName", # required
  targets: [ # required
    {
      id: "TargetId", # required
      arn: "TargetArn", # required
      role_arn: "RoleArn",
      input: "TargetInput",
      input_path: "TargetInputPath",
      input_transformer: {
        input_paths_map: {
          "InputTransformerPathKey" => "TargetInputPath",
        },
        input_template: "TransformerInput", # required
      },
      kinesis_parameters: {
        partition_key_path: "TargetPartitionKeyPath", # required
      },
      run_command_parameters: {
        run_command_targets: [ # required
          {
            key: "RunCommandTargetKey", # required
            values: ["RunCommandTargetValue"], # required
          },
        ],
      },
      ecs_parameters: {
        task_definition_arn: "Arn", # required
        task_count: 1,
      },
      batch_parameters: {
        job_definition: "String", # required
        job_name: "String", # required
        array_properties: {
          size: 1,
        },
        retry_strategy: {
          attempts: 1,
        },
      },
      sqs_parameters: {
        message_group_id: "MessageGroupId",
      },
    },
  ],
})

Response structure


resp.failed_entry_count #=> Integer
resp.failed_entries #=> Array
resp.failed_entries[0].target_id #=> String
resp.failed_entries[0].error_code #=> String
resp.failed_entries[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :rule (required, String)

    The name of the rule.

  • :targets (required, Array<Types::Target>)

    The targets to update or add to the rule.

Returns:

See Also:



817
818
819
820
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 817

def put_targets(params = {}, options = {})
  req = build_request(:put_targets, params)
  req.send_request(options)
end

#remove_permission(params = {}) ⇒ Struct

Revokes the permission of another AWS account to be able to put events to your default event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.

Examples:

Request syntax with placeholder values


resp = client.remove_permission({
  statement_id: "StatementId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :statement_id (required, String)

    The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



844
845
846
847
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 844

def remove_permission(params = {}, options = {})
  req = build_request(:remove_permission, params)
  req.send_request(options)
end

#remove_targets(params = {}) ⇒ Types::RemoveTargetsResponse

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

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

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

Examples:

Request syntax with placeholder values


resp = client.remove_targets({
  rule: "RuleName", # required
  ids: ["TargetId"], # required
})

Response structure


resp.failed_entry_count #=> Integer
resp.failed_entries #=> Array
resp.failed_entries[0].target_id #=> String
resp.failed_entries[0].error_code #=> String
resp.failed_entries[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :rule (required, String)

    The name of the rule.

  • :ids (required, Array<String>)

    The IDs of the targets to remove from the rule.

Returns:

See Also:



891
892
893
894
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 891

def remove_targets(params = {}, options = {})
  req = build_request(:remove_targets, params)
  req.send_request(options)
end

#test_event_pattern(params = {}) ⇒ Types::TestEventPatternResponse

Tests whether the specified event pattern matches the provided event.

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.

Examples:

Request syntax with placeholder values


resp = client.test_event_pattern({
  event_pattern: "EventPattern", # required
  event: "String", # required
})

Response structure


resp.result #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :event_pattern (required, String)

    The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

  • :event (required, String)

    The event, in JSON format, to test against the event pattern.

Returns:

See Also:



934
935
936
937
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/client.rb', line 934

def test_event_pattern(params = {}, options = {})
  req = build_request(:test_event_pattern, params)
  req.send_request(options)
end