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.

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

Class: Aws::CloudWatchEvents::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon CloudWatch Events. To construct a client, you need to configure a :region and :credentials.

cloudwatchevents = Aws::CloudWatchEvents::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::CloudWatchEvents::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::CloudWatchEvents::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#activate_event_source(options = {}) ⇒ Struct

Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

This operation is performed by AWS customers, not by SaaS partners.

Examples:

Request syntax with placeholder values


resp = client.activate_event_source({
  name: "EventSourceName", # required
})

Options Hash (options):

  • :name (required, String)

    The name of the partner event source to activate.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#create_event_bus(options = {}) ⇒ Types::CreateEventBusResponse

Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your own custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

This operation is used by AWS customers, not by SaaS partners.

Examples:

Request syntax with placeholder values


resp = client.create_event_bus({
  name: "EventBusName", # required
  event_source_name: "EventSourceName",
})

Response structure


resp.event_bus_arn #=> String

Options Hash (options):

  • :name (required, String)

    The name of the new event bus.

    The names of custom event buses can\'t contain the / character. You can\'t use the name default for a custom event bus because this name is already used for your account\'s default event bus.

    If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to. This name will include the / character.

  • :event_source_name (String)

    If you\'re creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

Returns:

See Also:

#create_partner_event_source(options = {}) ⇒ Types::CreatePartnerEventSourceResponse

Called by an SaaS partner to create a partner event source.

This operation is not used by AWS customers.

Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types.

A partner event source creates events based on resources in the SaaS partner's service or application.

An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets.

Partner event source names follow this format:

aws.partner/partner_name/event_namespace/event_name

  • partner_name is determined during partner registration and identifies the partner to AWS customers.

  • For event_namespace, we recommend that partners use a string that identifies the AWS customer within the partner's system. This should not be the customer's AWS account ID.

  • event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. This should help AWS customers decide whether to create an event bus to receive these events.

Examples:

Request syntax with placeholder values


resp = client.create_partner_event_source({
  name: "EventSourceName", # required
  account: "AccountId", # required
})

Response structure


resp.event_source_arn #=> String

Options Hash (options):

  • :name (required, String)

    The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name. The AWS account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.

  • :account (required, String)

    The AWS account ID of the customer who is permitted to create a matching partner event bus for this partner event source.

Returns:

See Also:

#deactivate_event_source(options = {}) ⇒ Struct

An AWS customer uses this operation to temporarily stop receiving events from the specified partner event source. The matching event bus isn't deleted.

When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it's deleted.

To activate a deactivated partner event source, use ActivateEventSource.

Examples:

Request syntax with placeholder values


resp = client.deactivate_event_source({
  name: "EventSourceName", # required
})

Options Hash (options):

  • :name (required, String)

    The name of the partner event source to deactivate.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_event_bus(options = {}) ⇒ Struct

Deletes the specified custom event bus or partner event bus. All rules associated with this event bus are also deleted. You can't delete your account's default event bus.

This operation is performed by AWS customers, not by SaaS partners.

Examples:

Request syntax with placeholder values


resp = client.delete_event_bus({
  name: "EventBusName", # required
})

Options Hash (options):

  • :name (required, String)

    The name of the event bus to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_partner_event_source(options = {}) ⇒ Struct

This operation is used by SaaS partners to delete a partner event source. AWS customers don't use this operation.

When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.

Examples:

Request syntax with placeholder values


resp = client.delete_partner_event_source({
  name: "EventSourceName", # required
  account: "AccountId", # required
})

Options Hash (options):

  • :name (required, String)

    The name of the event source to delete.

  • :account (required, String)

    The AWS account ID of the AWS customer that the event source was created for.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_rule(options = {}) ⇒ Struct

Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using RemoveTargets.

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

Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you're sure that the other service isn't still using that rule.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :name (required, String)

    The name of the rule.

  • :event_bus_name (String)

    The event bus associated with the rule. If you omit this, the default event bus is used.

  • :force (Boolean)

    If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

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

Displays details about an event bus in your account. This can include the external AWS accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.

To enable your account to receive events from other accounts on its default event bus, use PutPermission.

For more information about partner event buses, see CreateEventBus.

Examples:

Request syntax with placeholder values


resp = client.describe_event_bus({
  name: "EventBusName",
})

Response structure


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

Options Hash (options):

  • :name (String)

    The name of the event bus to show details for. If you omit this, the default event bus is displayed.

Returns:

See Also:

#describe_event_source(options = {}) ⇒ Types::DescribeEventSourceResponse

This operation lists details about a partner event source that is shared with your account.

This operation is run by AWS customers, not by SaaS partners.

Examples:

Request syntax with placeholder values


resp = client.describe_event_source({
  name: "EventSourceName", # required
})

Response structure


resp.arn #=> String
resp.created_by #=> String
resp.creation_time #=> Time
resp.expiration_time #=> Time
resp.name #=> String
resp.state #=> String, one of "PENDING", "ACTIVE", "DELETED"

Options Hash (options):

  • :name (required, String)

    The name of the partner event source to display the details of.

Returns:

See Also:

#describe_partner_event_source(options = {}) ⇒ Types::DescribePartnerEventSourceResponse

An SaaS partner can use this operation to list details about a partner event source that they have created.

AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.

Examples:

Request syntax with placeholder values


resp = client.describe_partner_event_source({
  name: "EventSourceName", # required
})

Response structure


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

Options Hash (options):

  • :name (required, String)

    The name of the event source to display.

Returns:

See Also:

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

Describes the specified rule.

DescribeRule doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

Examples:

Request syntax with placeholder values


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

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
resp.managed_by #=> String
resp.event_bus_name #=> String

Options Hash (options):

  • :name (required, String)

    The name of the rule.

  • :event_bus_name (String)

    The event bus associated with the rule. If you omit this, the default event bus is used.

Returns:

See Also:

#disable_rule(options = {}) ⇒ 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. Allow a short period of time for changes to take effect.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :name (required, String)

    The name of the rule.

  • :event_bus_name (String)

    The event bus associated with the rule. If you omit this, the default event bus is used.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#enable_rule(options = {}) ⇒ Struct

Enables the specified rule. If the rule doesn't exist, the operation fails.

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :name (required, String)

    The name of the rule.

  • :event_bus_name (String)

    The event bus associated with the rule. If you omit this, the default event bus is used.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#list_event_buses(options = {}) ⇒ Types::ListEventBusesResponse

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

This operation is run by AWS customers, not by SaaS partners.

Examples:

Request syntax with placeholder values


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

Response structure


resp.event_buses #=> Array
resp.event_buses[0].name #=> String
resp.event_buses[0].arn #=> String
resp.event_buses[0].policy #=> String
resp.next_token #=> String

Options Hash (options):

  • :name_prefix (String)

    Specifying this limits the results to only those event buses with names that start with the specified prefix.

  • :next_token (String)

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

  • :limit (Integer)

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.

Returns:

See Also:

#list_event_sources(options = {}) ⇒ Types::ListEventSourcesResponse

You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.

This operation is run by AWS customers, not by SaaS partners.

Examples:

Request syntax with placeholder values


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

Response structure


resp.event_sources #=> Array
resp.event_sources[0].arn #=> String
resp.event_sources[0].created_by #=> String
resp.event_sources[0].creation_time #=> Time
resp.event_sources[0].expiration_time #=> Time
resp.event_sources[0].name #=> String
resp.event_sources[0].state #=> String, one of "PENDING", "ACTIVE", "DELETED"
resp.next_token #=> String

Options Hash (options):

  • :name_prefix (String)

    Specifying this limits the results to only those partner event sources with names that start with the specified prefix.

  • :next_token (String)

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

  • :limit (Integer)

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.

Returns:

See Also:

#list_partner_event_source_accounts(options = {}) ⇒ Types::ListPartnerEventSourceAccountsResponse

An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with.

This operation is used by SaaS partners, not by AWS customers.

Examples:

Request syntax with placeholder values


resp = client.list_partner_event_source_accounts({
  event_source_name: "EventSourceName", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.partner_event_source_accounts #=> Array
resp.partner_event_source_accounts[0]. #=> String
resp.partner_event_source_accounts[0].creation_time #=> Time
resp.partner_event_source_accounts[0].expiration_time #=> Time
resp.partner_event_source_accounts[0].state #=> String, one of "PENDING", "ACTIVE", "DELETED"
resp.next_token #=> String

Options Hash (options):

  • :event_source_name (required, String)

    The name of the partner event source to display account information about.

  • :next_token (String)

    The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

  • :limit (Integer)

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.

Returns:

See Also:

#list_partner_event_sources(options = {}) ⇒ Types::ListPartnerEventSourcesResponse

An SaaS partner can use this operation to list all the partner event source names that they have created.

This operation is not used by AWS customers.

Examples:

Request syntax with placeholder values


resp = client.list_partner_event_sources({
  name_prefix: "PartnerEventSourceNamePrefix", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.partner_event_sources #=> Array
resp.partner_event_sources[0].arn #=> String
resp.partner_event_sources[0].name #=> String
resp.next_token #=> String

Options Hash (options):

  • :name_prefix (required, String)

    If you specify this, the results are limited to only those partner event sources that start with the string you specify.

  • :next_token (String)

    The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

  • :limit (Integer)

    pecifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.

Returns:

See Also:

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

Lists the rules for the specified target. You can see which rules 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
  event_bus_name: "EventBusName",
  next_token: "NextToken",
  limit: 1,
})

Response structure


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

Options Hash (options):

  • :target_arn (required, String)

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

  • :event_bus_name (String)

    Limits the results to show only the rules associated with the specified event bus.

  • :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:

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

Lists your EventBridge rules. You can either list all the rules or provide a prefix to match to the rule names.

ListRules doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

Examples:

Request syntax with placeholder values


resp = client.list_rules({
  name_prefix: "RuleName",
  event_bus_name: "EventBusName",
  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.rules[0].managed_by #=> String
resp.rules[0].event_bus_name #=> String
resp.next_token #=> String

Options Hash (options):

  • :name_prefix (String)

    The prefix matching the rule name.

  • :event_bus_name (String)

    Limits the results to show only the rules associated with the specified event bus.

  • :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:

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

Displays the tags associated with an EventBridge resource. In EventBridge, rules can be tagged.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :resource_arn (required, String)

    The ARN of the rule for which you want to view tags.

Returns:

See Also:

#list_targets_by_rule(options = {}) ⇒ 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
  event_bus_name: "EventBusName",
  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].ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE"
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets #=> Array
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.targets[0].ecs_parameters.platform_version #=> String
resp.targets[0].ecs_parameters.group #=> String
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

Options Hash (options):

  • :rule (required, String)

    The name of the rule.

  • :event_bus_name (String)

    The event bus associated with the rule. If you omit this, the default event bus is used.

  • :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:

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

Sends custom events to EventBridge so that they can be matched to rules. These events can be from your custom applications and services.

Examples:

Request syntax with placeholder values


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

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

Options Hash (options):

  • :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:

#put_partner_events(options = {}) ⇒ Types::PutPartnerEventsResponse

This is used by SaaS partners to write events to a customer's partner event bus.

AWS customers do not use this operation. Instead, AWS customers can use PutEvents to write custom events from their own applications to an event bus.

Examples:

Request syntax with placeholder values


resp = client.put_partner_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

Options Hash (options):

Returns:

See Also:

#put_permission(options = {}) ⇒ Struct

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Rules in your account are triggered by these events arriving to an event bus in your account.

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

To enable multiple AWS accounts to put events to an event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

The permission policy on an event bus can't exceed 10 KB in size.

Examples:

Request syntax with placeholder values


resp = client.put_permission({
  event_bus_name: "NonPartnerEventBusName",
  action: "Action", # required
  principal: "Principal", # required
  statement_id: "StatementId", # required
  condition: {
    type: "String", # required
    key: "String", # required
    value: "String", # required
  },
})

Options Hash (options):

  • :event_bus_name (String)

    The event bus associated with the rule. If you omit this, the default event bus is used.

  • :action (required, String)

    The action that you\'re 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 \"*\" without specifying Condition, avoid creating rules that might 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 to receive events from. Rules with an account field don\'t match any events sent from other accounts.

  • :statement_id (required, String)

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

  • :condition (Types::Condition)

    This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations? in the AWS Organizations User Guide.

    If you specify Condition with an AWS organization ID and specify \"*\" as the value for Principal, you grant permission to all the accounts in the named organization.

    The Condition is a JSON string that must contain Type, Key, and Value fields.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#put_rule(options = {}) ⇒ 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.

A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.

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

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. 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.

When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.

If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge 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 that you want to match.

In EventBridge, you could create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If you don't write the rule carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.

To prevent this, write the rules so that the triggered actions don't refire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.

An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.

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",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  event_bus_name: "EventBusName",
})

Response structure


resp.rule_arn #=> String

Options Hash (options):

  • :name (required, String)

    The name of the rule that you\'re 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 Event Patterns in the Amazon EventBridge 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.

  • :tags (Array<Types::Tag>)

    The list of key-value pairs to associate with the rule.

  • :event_bus_name (String)

    The event bus to associate with this rule. If you omit this, the default event bus is used.

Returns:

See Also:

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

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

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

You can configure the following as targets in EventBridge:

  • EC2 instances

  • SSM Run Command

  • SSM Automation

  • AWS Lambda functions

  • Data streams in Amazon Kinesis Data Streams

  • Data delivery streams in Amazon Kinesis Data Firehose

  • Amazon ECS tasks

  • AWS Step Functions state machines

  • AWS Batch jobs

  • AWS CodeBuild projects

  • Pipelines in AWS CodePipeline

  • Amazon Inspector assessment templates

  • Amazon SNS topics

  • Amazon SQS queues, including FIFO queues

  • The default event bus of another AWS account

Creating rules with built-in targets is supported only on the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data 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 EventBridge needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge 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. Set 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 value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event isn't charged. For more information, see Amazon EventBridge Pricing.

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

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, the entire event is passed to the target in JSON format (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), 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, 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. 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 nonzero 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
  event_bus_name: "EventBusName",
  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,
        launch_type: "EC2", # accepts EC2, FARGATE
        network_configuration: {
          awsvpc_configuration: {
            subnets: ["String"], # required
            security_groups: ["String"],
            assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
          },
        },
        platform_version: "String",
        group: "String",
      },
      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

Options Hash (options):

  • :rule (required, String)

    The name of the rule.

  • :event_bus_name (String)

    The name of the event bus associated with the rule. If you omit this, the default event bus is used.

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

    The targets to update or add to the rule.

Returns:

See Also:

#remove_permission(options = {}) ⇒ Struct

Revokes the permission of another AWS account to be able to put events to the specified 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
  event_bus_name: "NonPartnerEventBusName",
})

Options Hash (options):

  • :statement_id (required, String)

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

  • :event_bus_name (String)

    The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#remove_targets(options = {}) ⇒ 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. 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
  event_bus_name: "EventBusName",
  ids: ["TargetId"], # required
  force: false,
})

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

Options Hash (options):

  • :rule (required, String)

    The name of the rule.

  • :event_bus_name (String)

    The name of the event bus associated with the rule.

  • :ids (required, Array<String>)

    The IDs of the targets to remove from the rule.

  • :force (Boolean)

    If this is a managed rule created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that aren\'t managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules can be tagged.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a rule that already has tags. If you specify a new tag key for the rule, this tag is appended to the list of tags associated with the rule. If you specify a tag key that is already associated with the rule, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Options Hash (options):

  • :resource_arn (required, String)

    The ARN of the rule that you\'re adding tags to.

  • :tags (required, Array<Types::Tag>)

    The list of key-value pairs to associate with the rule.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#test_event_pattern(options = {}) ⇒ 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, EventBridge 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 that 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 #=> true/false

Options Hash (options):

  • :event_pattern (required, String)

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

  • :event (required, String)

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

Returns:

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes one or more tags from the specified EventBridge resource. In EventBridge, rules can be tagged.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (options):

  • :resource_arn (required, String)

    The ARN of the rule that you\'re removing tags from.

  • :tag_keys (required, Array<String>)

    The list of tag keys to remove from the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.