Class: Aws::EventBridge::Client

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

Overview

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

client = Aws::EventBridge::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #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(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    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.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :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 ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



319
320
321
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 319

def initialize(*args)
  super
end

Instance Method Details

#activate_event_source(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the partner event source to activate.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



344
345
346
347
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 344

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

#create_event_bus(params = {}) ⇒ 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 custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

Examples:

Request syntax with placeholder values


resp = client.create_event_bus({
  name: "EventBusName", # required
  event_source_name: "EventSourceName",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.event_bus_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the new event bus.

    Event bus names cannot contain the / character. You can't use the name default for a custom event bus, as 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.

  • :event_source_name (String)

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

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

    Tags to associate with the event bus.

Returns:

See Also:



396
397
398
399
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 396

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

#create_partner_event_source(params = {}) ⇒ 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 within 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:

partner_name/event_namespace/event_name

partner_name is determined during partner registration and identifies the partner to AWS customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name 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

Parameters:

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

    ({})

Options Hash (params):

  • :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 that is permitted to create a matching partner event bus for this partner event source.

Returns:

See Also:



459
460
461
462
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 459

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

#deactivate_event_source(params = {}) ⇒ Struct

You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not 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 is deleted.

To activate a deactivated partner event source, use ActivateEventSource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the partner event source to deactivate.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



490
491
492
493
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 490

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

#delete_event_bus(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the event bus to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



514
515
516
517
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 514

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

#delete_partner_event_source(params = {}) ⇒ Struct

This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.

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
})

Parameters:

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

    ({})

Options Hash (params):

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



545
546
547
548
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 545

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

#delete_rule(params = {}) ⇒ 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 are sure the other service is not still using that rule.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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



592
593
594
595
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 592

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

#describe_event_bus(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



634
635
636
637
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 634

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

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

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

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"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

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

Returns:

See Also:



673
674
675
676
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 673

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

#describe_partner_event_source(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the event source to display.

Returns:

See Also:



706
707
708
709
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 706

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

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

Describes the specified rule.

DescribeRule does not 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

Parameters:

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

    ({})

Options Hash (params):

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



758
759
760
761
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 758

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. 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",
})

Parameters:

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

    ({})

Options Hash (params):

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



790
791
792
793
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 790

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. 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",
})

Parameters:

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

    ({})

Options Hash (params):

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



822
823
824
825
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 822

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

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

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :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 which you can use in a subsequent operation to retrieve the next set of results.

Returns:

See Also:



868
869
870
871
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 868

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

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :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 which you can use in a subsequent operation to retrieve the next set of results.

Returns:

See Also:



918
919
920
921
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 918

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

#list_partner_event_source_accounts(params = {}) ⇒ 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 not used 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

Parameters:

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

    ({})

Options Hash (params):

  • :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 which you can use in a subsequent operation to retrieve the next set of results.

Returns:

See Also:



966
967
968
969
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 966

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

#list_partner_event_sources(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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 which you can use in a subsequent operation to retrieve the next set of results.

Returns:

See Also:



1012
1013
1014
1015
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1012

def list_partner_event_sources(params = {}, options = {})
  req = build_request(:list_partner_event_sources, 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 EventBridge 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

Parameters:

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

    ({})

Options Hash (params):

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



1059
1060
1061
1062
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1059

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 EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.

ListRules does not 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

Parameters:

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

    ({})

Options Hash (params):

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



1116
1117
1118
1119
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1116

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

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

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

Returns:

See Also:



1147
1148
1149
1150
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1147

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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
  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.targets[0].http_parameters.path_parameter_values #=> Array
resp.targets[0].http_parameters.path_parameter_values[0] #=> String
resp.targets[0].http_parameters.header_parameters #=> Hash
resp.targets[0].http_parameters.header_parameters["HeaderKey"] #=> String
resp.targets[0].http_parameters.query_string_parameters #=> Hash
resp.targets[0].http_parameters.query_string_parameters["QueryStringKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1225
1226
1227
1228
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1225

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 EventBridge 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",
      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

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:



1270
1271
1272
1273
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1270

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

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

Examples:

Request syntax with placeholder values


resp = client.put_partner_events({
  entries: [ # required
    {
      time: Time.now,
      source: "EventSourceName",
      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):

Returns:

See Also:



1312
1313
1314
1315
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1312

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

#put_permission(params = {}) ⇒ Struct

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) 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 an EventBridge rule with your account's event bus as a target.

To enable multiple AWS accounts to put events to your 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 the default event bus cannot 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
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :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 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 "*" without specifying Condition, 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.

  • :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 which must contain Type, Key, and Value fields.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1409
1410
1411
1412
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1409

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.

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 are 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 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. 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 you want to match.

In EventBridge, it is possible to 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 the rule is not written 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 do not re-fire 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

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



1541
1542
1543
1544
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1541

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

  • 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

  • Amazon API Gateway REST APIs

Creating rules with built-in targets is supported only in 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 (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, 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 is not charged. For more information, see Amazon EventBridge (CloudWatch Events) Pricing.

Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then 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, then 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), 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. 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
  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",
      },
      http_parameters: {
        path_parameter_values: ["PathParameter"],
        header_parameters: {
          "HeaderKey" => "HeaderValue",
        },
        query_string_parameters: {
          "QueryStringKey" => "QueryStringValue",
        },
      },
    },
  ],
})

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.

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



1766
1767
1768
1769
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1766

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 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",
})

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.

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



1798
1799
1800
1801
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1798

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. 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

Parameters:

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

    ({})

Options Hash (params):

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

See Also:



1857
1858
1859
1860
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1857

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

#tag_resource(params = {}) ⇒ 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 and event buses 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 resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, 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
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The ARN of the EventBridge resource that you're adding tags to.

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

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1903
1904
1905
1906
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1903

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, 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, 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 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 EventBridge User Guide.

  • :event (required, String)

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

Returns:

See Also:



1946
1947
1948
1949
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1946

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

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The ARN of the EventBridge resource from which you are removing tags.

  • :tag_keys (required, Array<String>)

    The list of tag keys to remove from the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1974
1975
1976
1977
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/client.rb', line 1974

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