aws-sdk-eventbridge 1.3.0 → 1.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-eventbridge.rb +7 -4
- data/lib/aws-sdk-eventbridge/client.rb +233 -209
- data/lib/aws-sdk-eventbridge/client_api.rb +24 -1
- data/lib/aws-sdk-eventbridge/errors.rb +121 -0
- data/lib/aws-sdk-eventbridge/resource.rb +1 -0
- data/lib/aws-sdk-eventbridge/types.rb +208 -145
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 60b0a92f0fcea1ca176378599ab972317d75079a191b78002062e45f59b99c29
|
4
|
+
data.tar.gz: 87d16a3bf59ead6bc5c40d7f530435ee31aed1d514c9191d3de031bfb8db4cc2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 11f25f003f4825e049ae123da400608e77990e41b9ae398b33e19829f9cce3ed5e78f87c40cd513a178ff3722fa9ac7956ecfa910241189dbe270dd12ff74a98
|
7
|
+
data.tar.gz: 363f8bf842ff425cf073ab37200762337a4ef86261eb6d33e5486ec1a9fa131561d6124dd612212d7f27f1eb5982e0d69582b9f4fb7b305a6afd7f55c3ef5069
|
data/lib/aws-sdk-eventbridge.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-eventbridge/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# event_bridge = Aws::EventBridge::Client.new
|
28
|
+
# resp = event_bridge.activate_event_source(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon EventBridge
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon EventBridge are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::EventBridge::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon EventBridge API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-eventbridge/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::EventBridge
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.8.1'
|
46
49
|
|
47
50
|
end
|
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
30
|
|
30
31
|
Aws::Plugins::GlobalConfiguration.add_identifier(:eventbridge)
|
31
32
|
|
32
33
|
module Aws::EventBridge
|
34
|
+
# An API client for EventBridge. To construct a client, you need to configure a `:region` and `:credentials`.
|
35
|
+
#
|
36
|
+
# client = Aws::EventBridge::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
41
|
+
#
|
42
|
+
# For details on configuring region and credentials see
|
43
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
44
|
+
#
|
45
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
46
|
class Client < Seahorse::Client::Base
|
34
47
|
|
35
48
|
include Aws::ClientStubs
|
@@ -57,6 +70,7 @@ module Aws::EventBridge
|
|
57
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
60
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
61
75
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
62
76
|
|
@@ -93,7 +107,7 @@ module Aws::EventBridge
|
|
93
107
|
# @option options [required, String] :region
|
94
108
|
# The AWS region to connect to. The configured `:region` is
|
95
109
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
97
111
|
#
|
98
112
|
# * `Aws.config[:region]`
|
99
113
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +122,12 @@ module Aws::EventBridge
|
|
108
122
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
123
|
# the background every 60 secs (default). Defaults to `false`.
|
110
124
|
#
|
125
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
126
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
127
|
+
# until there is sufficent client side capacity to retry the request.
|
128
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
129
|
+
# not retry instead of sleeping.
|
130
|
+
#
|
111
131
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
132
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
133
|
# this client.
|
@@ -132,6 +152,10 @@ module Aws::EventBridge
|
|
132
152
|
# When `true`, an attempt is made to coerce request parameters into
|
133
153
|
# the required types.
|
134
154
|
#
|
155
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
156
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
157
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
158
|
+
#
|
135
159
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
160
|
# Set to true to disable SDK automatically adding host prefix
|
137
161
|
# to default service endpoint when available.
|
@@ -139,7 +163,7 @@ module Aws::EventBridge
|
|
139
163
|
# @option options [String] :endpoint
|
140
164
|
# The client endpoint is normally constructed from the `:region`
|
141
165
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
143
167
|
#
|
144
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +178,7 @@ module Aws::EventBridge
|
|
154
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
179
|
#
|
156
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
182
|
#
|
159
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
184
|
# The log formatter.
|
@@ -166,15 +190,29 @@ module Aws::EventBridge
|
|
166
190
|
# The Logger instance to send log messages to. If this option
|
167
191
|
# is not set, logging will be disabled.
|
168
192
|
#
|
193
|
+
# @option options [Integer] :max_attempts (3)
|
194
|
+
# An integer representing the maximum number attempts that will be made for
|
195
|
+
# a single request, including the initial attempt. For example,
|
196
|
+
# setting this value to 5 will result in a request being retried up to
|
197
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
198
|
+
#
|
169
199
|
# @option options [String] :profile ("default")
|
170
200
|
# Used when loading credentials from the shared credentials file
|
171
201
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
202
|
#
|
203
|
+
# @option options [Proc] :retry_backoff
|
204
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
205
|
+
# This option is only used in the `legacy` retry mode.
|
206
|
+
#
|
173
207
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
208
|
+
# The base delay in seconds used by the default backoff function. This option
|
209
|
+
# is only used in the `legacy` retry mode.
|
175
210
|
#
|
176
211
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
212
|
+
# A delay randomiser function used by the default backoff function.
|
213
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
214
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
215
|
+
# in the `legacy` retry mode.
|
178
216
|
#
|
179
217
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
218
|
#
|
@@ -182,11 +220,30 @@ module Aws::EventBridge
|
|
182
220
|
# The maximum number of times to retry failed requests. Only
|
183
221
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
222
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
223
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
224
|
+
# endpoint discovery, and errors from expired credentials.
|
225
|
+
# This option is only used in the `legacy` retry mode.
|
187
226
|
#
|
188
227
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
228
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
229
|
+
# used by the default backoff function. This option is only used in the
|
230
|
+
# `legacy` retry mode.
|
231
|
+
#
|
232
|
+
# @option options [String] :retry_mode ("legacy")
|
233
|
+
# Specifies which retry algorithm to use. Values are:
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
190
247
|
#
|
191
248
|
# @option options [String] :secret_access_key
|
192
249
|
#
|
@@ -219,16 +276,15 @@ module Aws::EventBridge
|
|
219
276
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
277
|
#
|
221
278
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
279
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
280
|
# `Timeout::Error`.
|
224
281
|
#
|
225
282
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
283
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
284
|
+
# safely be set per-request on the session.
|
229
285
|
#
|
230
286
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
287
|
+
# seconds a connection is allowed to sit idle before it is
|
232
288
|
# considered stale. Stale connections are closed and removed
|
233
289
|
# from the pool before making a request.
|
234
290
|
#
|
@@ -237,7 +293,7 @@ module Aws::EventBridge
|
|
237
293
|
# request body. This option has no effect unless the request has
|
238
294
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
295
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
296
|
+
# request on the session.
|
241
297
|
#
|
242
298
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
299
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -268,10 +324,6 @@ module Aws::EventBridge
|
|
268
324
|
# activated, your matching event bus will start receiving events from
|
269
325
|
# the event source.
|
270
326
|
#
|
271
|
-
# <note markdown="1"> This operation is performed by AWS customers, not by SaaS partners.
|
272
|
-
#
|
273
|
-
# </note>
|
274
|
-
#
|
275
327
|
# @option params [required, String] :name
|
276
328
|
# The name of the partner event source to activate.
|
277
329
|
#
|
@@ -293,29 +345,27 @@ module Aws::EventBridge
|
|
293
345
|
end
|
294
346
|
|
295
347
|
# Creates a new event bus within your account. This can be a custom
|
296
|
-
# event bus which you can use to receive events from your
|
348
|
+
# event bus which you can use to receive events from your custom
|
297
349
|
# applications and services, or it can be a partner event bus which can
|
298
350
|
# be matched to a partner event source.
|
299
351
|
#
|
300
|
-
# <note markdown="1"> This operation is used by AWS customers, not by SaaS partners.
|
301
|
-
#
|
302
|
-
# </note>
|
303
|
-
#
|
304
352
|
# @option params [required, String] :name
|
305
353
|
# The name of the new event bus.
|
306
354
|
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
355
|
+
# Event bus names cannot contain the / character. You can't use the
|
356
|
+
# name `default` for a custom event bus, as this name is already used
|
357
|
+
# for your account's default event bus.
|
310
358
|
#
|
311
359
|
# If this is a partner event bus, the name must exactly match the name
|
312
|
-
# of the partner event source that this event bus is matched to.
|
313
|
-
# name will include the `/` character.
|
360
|
+
# of the partner event source that this event bus is matched to.
|
314
361
|
#
|
315
362
|
# @option params [String] :event_source_name
|
316
|
-
# If you
|
363
|
+
# If you are creating a partner event bus, this specifies the partner
|
317
364
|
# event source that the new event bus will be matched with.
|
318
365
|
#
|
366
|
+
# @option params [Array<Types::Tag>] :tags
|
367
|
+
# Tags to associate with the event bus.
|
368
|
+
#
|
319
369
|
# @return [Types::CreateEventBusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
320
370
|
#
|
321
371
|
# * {Types::CreateEventBusResponse#event_bus_arn #event_bus_arn} => String
|
@@ -325,6 +375,12 @@ module Aws::EventBridge
|
|
325
375
|
# resp = client.create_event_bus({
|
326
376
|
# name: "EventBusName", # required
|
327
377
|
# event_source_name: "EventSourceName",
|
378
|
+
# tags: [
|
379
|
+
# {
|
380
|
+
# key: "TagKey", # required
|
381
|
+
# value: "TagValue", # required
|
382
|
+
# },
|
383
|
+
# ],
|
328
384
|
# })
|
329
385
|
#
|
330
386
|
# @example Response structure
|
@@ -340,19 +396,16 @@ module Aws::EventBridge
|
|
340
396
|
req.send_request(options)
|
341
397
|
end
|
342
398
|
|
343
|
-
# Called by an SaaS partner to create a partner event source.
|
344
|
-
#
|
345
|
-
# <note markdown="1"> This operation is not used by AWS customers.
|
346
|
-
#
|
347
|
-
# </note>
|
399
|
+
# Called by an SaaS partner to create a partner event source. This
|
400
|
+
# operation is not used by AWS customers.
|
348
401
|
#
|
349
402
|
# Each partner event source can be used by one AWS account to create a
|
350
403
|
# matching partner event bus in that AWS account. A SaaS partner must
|
351
404
|
# create one partner event source for each AWS account that wants to
|
352
405
|
# receive those event types.
|
353
406
|
#
|
354
|
-
# A partner event source creates events based on resources
|
355
|
-
# partner's service or application.
|
407
|
+
# A partner event source creates events based on resources within the
|
408
|
+
# SaaS partner's service or application.
|
356
409
|
#
|
357
410
|
# An AWS account that creates a partner event bus that matches the
|
358
411
|
# partner event source can use that event bus to receive events from the
|
@@ -360,19 +413,16 @@ module Aws::EventBridge
|
|
360
413
|
#
|
361
414
|
# Partner event source names follow this format:
|
362
415
|
#
|
363
|
-
# `
|
364
|
-
#
|
365
|
-
# * *partner\_name* is determined during partner registration and
|
366
|
-
# identifies the partner to AWS customers.
|
367
|
-
#
|
368
|
-
# * For *event\_namespace*, we recommend that partners use a string that
|
369
|
-
# identifies the AWS customer within the partner's system. This
|
370
|
-
# should not be the customer's AWS account ID.
|
416
|
+
# ` partner_name/event_namespace/event_name `
|
371
417
|
#
|
372
|
-
# *
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
418
|
+
# *partner\_name* is determined during partner registration and
|
419
|
+
# identifies the partner to AWS customers. *event\_namespace* is
|
420
|
+
# determined by the partner and is a way for the partner to categorize
|
421
|
+
# their events. *event\_name* is determined by the partner, and should
|
422
|
+
# uniquely identify an event-generating resource within the partner
|
423
|
+
# system. The combination of *event\_namespace* and *event\_name* should
|
424
|
+
# help AWS customers decide whether to create an event bus to receive
|
425
|
+
# these events.
|
376
426
|
#
|
377
427
|
# @option params [required, String] :name
|
378
428
|
# The name of the partner event source. This name must be unique and
|
@@ -382,8 +432,8 @@ module Aws::EventBridge
|
|
382
432
|
# event source.
|
383
433
|
#
|
384
434
|
# @option params [required, String] :account
|
385
|
-
# The AWS account ID
|
386
|
-
#
|
435
|
+
# The AWS account ID that is permitted to create a matching partner
|
436
|
+
# event bus for this partner event source.
|
387
437
|
#
|
388
438
|
# @return [Types::CreatePartnerEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
389
439
|
#
|
@@ -409,13 +459,13 @@ module Aws::EventBridge
|
|
409
459
|
req.send_request(options)
|
410
460
|
end
|
411
461
|
|
412
|
-
#
|
413
|
-
#
|
414
|
-
#
|
462
|
+
# You can use this operation to temporarily stop receiving events from
|
463
|
+
# the specified partner event source. The matching event bus is not
|
464
|
+
# deleted.
|
415
465
|
#
|
416
466
|
# When you deactivate a partner event source, the source goes into
|
417
|
-
#
|
418
|
-
#
|
467
|
+
# PENDING state. If it remains in PENDING state for more than two weeks,
|
468
|
+
# it is deleted.
|
419
469
|
#
|
420
470
|
# To activate a deactivated partner event source, use
|
421
471
|
# ActivateEventSource.
|
@@ -441,13 +491,9 @@ module Aws::EventBridge
|
|
441
491
|
end
|
442
492
|
|
443
493
|
# Deletes the specified custom event bus or partner event bus. All rules
|
444
|
-
# associated with this event bus
|
494
|
+
# associated with this event bus need to be deleted. You can't delete
|
445
495
|
# your account's default event bus.
|
446
496
|
#
|
447
|
-
# <note markdown="1"> This operation is performed by AWS customers, not by SaaS partners.
|
448
|
-
#
|
449
|
-
# </note>
|
450
|
-
#
|
451
497
|
# @option params [required, String] :name
|
452
498
|
# The name of the event bus to delete.
|
453
499
|
#
|
@@ -469,10 +515,10 @@ module Aws::EventBridge
|
|
469
515
|
end
|
470
516
|
|
471
517
|
# This operation is used by SaaS partners to delete a partner event
|
472
|
-
# source.
|
518
|
+
# source. This operation is not used by AWS customers.
|
473
519
|
#
|
474
520
|
# When you delete an event source, the status of the corresponding
|
475
|
-
# partner event bus in the AWS customer account becomes
|
521
|
+
# partner event bus in the AWS customer account becomes DELETED.
|
476
522
|
#
|
477
523
|
# @option params [required, String] :name
|
478
524
|
# The name of the event source to delete.
|
@@ -510,8 +556,8 @@ module Aws::EventBridge
|
|
510
556
|
# Managed rules are rules created and managed by another AWS service on
|
511
557
|
# your behalf. These rules are created by those other AWS services to
|
512
558
|
# support functionality in those services. You can delete these rules
|
513
|
-
# using the `Force` option, but you should do so only if you
|
514
|
-
#
|
559
|
+
# using the `Force` option, but you should do so only if you are sure
|
560
|
+
# the other service is not still using that rule.
|
515
561
|
#
|
516
562
|
# @option params [required, String] :name
|
517
563
|
# The name of the rule.
|
@@ -591,10 +637,6 @@ module Aws::EventBridge
|
|
591
637
|
# This operation lists details about a partner event source that is
|
592
638
|
# shared with your account.
|
593
639
|
#
|
594
|
-
# <note markdown="1"> This operation is run by AWS customers, not by SaaS partners.
|
595
|
-
#
|
596
|
-
# </note>
|
597
|
-
#
|
598
640
|
# @option params [required, String] :name
|
599
641
|
# The name of the partner event source to display the details of.
|
600
642
|
#
|
@@ -632,13 +674,9 @@ module Aws::EventBridge
|
|
632
674
|
end
|
633
675
|
|
634
676
|
# An SaaS partner can use this operation to list details about a partner
|
635
|
-
# event source that they have created.
|
636
|
-
#
|
637
|
-
#
|
638
|
-
# use DescribeEventSource to see details about a partner event source
|
639
|
-
# that is shared with them.
|
640
|
-
#
|
641
|
-
# </note>
|
677
|
+
# event source that they have created. AWS customers do not use this
|
678
|
+
# operation. Instead, AWS customers can use DescribeEventSource to see
|
679
|
+
# details about a partner event source that is shared with them.
|
642
680
|
#
|
643
681
|
# @option params [required, String] :name
|
644
682
|
# The name of the event source to display.
|
@@ -670,7 +708,7 @@ module Aws::EventBridge
|
|
670
708
|
|
671
709
|
# Describes the specified rule.
|
672
710
|
#
|
673
|
-
#
|
711
|
+
# DescribeRule does not list the targets of a rule. To see the targets
|
674
712
|
# associated with a rule, use ListTargetsByRule.
|
675
713
|
#
|
676
714
|
# @option params [required, String] :name
|
@@ -720,7 +758,7 @@ module Aws::EventBridge
|
|
720
758
|
req.send_request(options)
|
721
759
|
end
|
722
760
|
|
723
|
-
# Disables the specified rule. A disabled rule won't match any events
|
761
|
+
# Disables the specified rule. A disabled rule won't match any events,
|
724
762
|
# and won't self-trigger if it has a schedule expression.
|
725
763
|
#
|
726
764
|
# When you disable a rule, incoming events might continue to match to
|
@@ -752,7 +790,7 @@ module Aws::EventBridge
|
|
752
790
|
req.send_request(options)
|
753
791
|
end
|
754
792
|
|
755
|
-
# Enables the specified rule. If the rule
|
793
|
+
# Enables the specified rule. If the rule does not exist, the operation
|
756
794
|
# fails.
|
757
795
|
#
|
758
796
|
# When you enable a rule, incoming events might not immediately start
|
@@ -787,10 +825,6 @@ module Aws::EventBridge
|
|
787
825
|
# Lists all the event buses in your account, including the default event
|
788
826
|
# bus, custom event buses, and partner event buses.
|
789
827
|
#
|
790
|
-
# <note markdown="1"> This operation is run by AWS customers, not by SaaS partners.
|
791
|
-
#
|
792
|
-
# </note>
|
793
|
-
#
|
794
828
|
# @option params [String] :name_prefix
|
795
829
|
# Specifying this limits the results to only those event buses with
|
796
830
|
# names that start with the specified prefix.
|
@@ -801,8 +835,8 @@ module Aws::EventBridge
|
|
801
835
|
#
|
802
836
|
# @option params [Integer] :limit
|
803
837
|
# Specifying this limits the number of results returned by this
|
804
|
-
# operation. The operation also returns a
|
805
|
-
#
|
838
|
+
# operation. The operation also returns a NextToken which you can use in
|
839
|
+
# a subsequent operation to retrieve the next set of results.
|
806
840
|
#
|
807
841
|
# @return [Types::ListEventBusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
808
842
|
#
|
@@ -838,10 +872,6 @@ module Aws::EventBridge
|
|
838
872
|
# shared with your AWS account. For more information about partner event
|
839
873
|
# sources, see CreateEventBus.
|
840
874
|
#
|
841
|
-
# <note markdown="1"> This operation is run by AWS customers, not by SaaS partners.
|
842
|
-
#
|
843
|
-
# </note>
|
844
|
-
#
|
845
875
|
# @option params [String] :name_prefix
|
846
876
|
# Specifying this limits the results to only those partner event sources
|
847
877
|
# with names that start with the specified prefix.
|
@@ -852,8 +882,8 @@ module Aws::EventBridge
|
|
852
882
|
#
|
853
883
|
# @option params [Integer] :limit
|
854
884
|
# Specifying this limits the number of results returned by this
|
855
|
-
# operation. The operation also returns a
|
856
|
-
#
|
885
|
+
# operation. The operation also returns a NextToken which you can use in
|
886
|
+
# a subsequent operation to retrieve the next set of results.
|
857
887
|
#
|
858
888
|
# @return [Types::ListEventSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
859
889
|
#
|
@@ -889,11 +919,8 @@ module Aws::EventBridge
|
|
889
919
|
end
|
890
920
|
|
891
921
|
# An SaaS partner can use this operation to display the AWS account ID
|
892
|
-
# that a particular partner event source name is associated with.
|
893
|
-
#
|
894
|
-
# <note markdown="1"> This operation is used by SaaS partners, not by AWS customers.
|
895
|
-
#
|
896
|
-
# </note>
|
922
|
+
# that a particular partner event source name is associated with. This
|
923
|
+
# operation is not used by AWS customers.
|
897
924
|
#
|
898
925
|
# @option params [required, String] :event_source_name
|
899
926
|
# The name of the partner event source to display account information
|
@@ -905,8 +932,8 @@ module Aws::EventBridge
|
|
905
932
|
#
|
906
933
|
# @option params [Integer] :limit
|
907
934
|
# Specifying this limits the number of results returned by this
|
908
|
-
# operation. The operation also returns a
|
909
|
-
#
|
935
|
+
# operation. The operation also returns a NextToken which you can use in
|
936
|
+
# a subsequent operation to retrieve the next set of results.
|
910
937
|
#
|
911
938
|
# @return [Types::ListPartnerEventSourceAccountsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
912
939
|
#
|
@@ -940,11 +967,8 @@ module Aws::EventBridge
|
|
940
967
|
end
|
941
968
|
|
942
969
|
# An SaaS partner can use this operation to list all the partner event
|
943
|
-
# source names that they have created.
|
944
|
-
#
|
945
|
-
# <note markdown="1"> This operation is not used by AWS customers.
|
946
|
-
#
|
947
|
-
# </note>
|
970
|
+
# source names that they have created. This operation is not used by AWS
|
971
|
+
# customers.
|
948
972
|
#
|
949
973
|
# @option params [required, String] :name_prefix
|
950
974
|
# If you specify this, the results are limited to only those partner
|
@@ -956,8 +980,8 @@ module Aws::EventBridge
|
|
956
980
|
#
|
957
981
|
# @option params [Integer] :limit
|
958
982
|
# pecifying this limits the number of results returned by this
|
959
|
-
# operation. The operation also returns a
|
960
|
-
#
|
983
|
+
# operation. The operation also returns a NextToken which you can use in
|
984
|
+
# a subsequent operation to retrieve the next set of results.
|
961
985
|
#
|
962
986
|
# @return [Types::ListPartnerEventSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
963
987
|
#
|
@@ -988,8 +1012,9 @@ module Aws::EventBridge
|
|
988
1012
|
req.send_request(options)
|
989
1013
|
end
|
990
1014
|
|
991
|
-
# Lists the rules for the specified target. You can see which
|
992
|
-
# invoke a specific target in your
|
1015
|
+
# Lists the rules for the specified target. You can see which of the
|
1016
|
+
# rules in Amazon EventBridge can invoke a specific target in your
|
1017
|
+
# account.
|
993
1018
|
#
|
994
1019
|
# @option params [required, String] :target_arn
|
995
1020
|
# The Amazon Resource Name (ARN) of the target resource.
|
@@ -1034,10 +1059,10 @@ module Aws::EventBridge
|
|
1034
1059
|
req.send_request(options)
|
1035
1060
|
end
|
1036
1061
|
|
1037
|
-
# Lists your EventBridge rules. You can either list all the rules
|
1038
|
-
# provide a prefix to match to the rule names.
|
1062
|
+
# Lists your Amazon EventBridge rules. You can either list all the rules
|
1063
|
+
# or you can provide a prefix to match to the rule names.
|
1039
1064
|
#
|
1040
|
-
#
|
1065
|
+
# ListRules does not list the targets of a rule. To see the targets
|
1041
1066
|
# associated with a rule, use ListTargetsByRule.
|
1042
1067
|
#
|
1043
1068
|
# @option params [String] :name_prefix
|
@@ -1092,10 +1117,10 @@ module Aws::EventBridge
|
|
1092
1117
|
end
|
1093
1118
|
|
1094
1119
|
# Displays the tags associated with an EventBridge resource. In
|
1095
|
-
# EventBridge, rules can be tagged.
|
1120
|
+
# EventBridge, rules and event buses can be tagged.
|
1096
1121
|
#
|
1097
1122
|
# @option params [required, String] :resource_arn
|
1098
|
-
# The ARN of the
|
1123
|
+
# The ARN of the EventBridge resource for which you want to view tags.
|
1099
1124
|
#
|
1100
1125
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1101
1126
|
#
|
@@ -1194,8 +1219,8 @@ module Aws::EventBridge
|
|
1194
1219
|
req.send_request(options)
|
1195
1220
|
end
|
1196
1221
|
|
1197
|
-
# Sends custom events to EventBridge so that they can be matched
|
1198
|
-
# rules.
|
1222
|
+
# Sends custom events to Amazon EventBridge so that they can be matched
|
1223
|
+
# to rules.
|
1199
1224
|
#
|
1200
1225
|
# @option params [required, Array<Types::PutEventsRequestEntry>] :entries
|
1201
1226
|
# The entry that defines an event in your system. You can specify
|
@@ -1240,13 +1265,7 @@ module Aws::EventBridge
|
|
1240
1265
|
end
|
1241
1266
|
|
1242
1267
|
# This is used by SaaS partners to write events to a customer's partner
|
1243
|
-
# event bus.
|
1244
|
-
#
|
1245
|
-
# <note markdown="1"> AWS customers do not use this operation. Instead, AWS customers can
|
1246
|
-
# use PutEvents to write custom events from their own applications to an
|
1247
|
-
# event bus.
|
1248
|
-
#
|
1249
|
-
# </note>
|
1268
|
+
# event bus. AWS customers do not use this operation.
|
1250
1269
|
#
|
1251
1270
|
# @option params [required, Array<Types::PutPartnerEventsRequestEntry>] :entries
|
1252
1271
|
# The list of events to write to the event bus.
|
@@ -1262,7 +1281,7 @@ module Aws::EventBridge
|
|
1262
1281
|
# entries: [ # required
|
1263
1282
|
# {
|
1264
1283
|
# time: Time.now,
|
1265
|
-
# source: "
|
1284
|
+
# source: "EventSourceName",
|
1266
1285
|
# resources: ["EventResource"],
|
1267
1286
|
# detail_type: "String",
|
1268
1287
|
# detail: "String",
|
@@ -1288,14 +1307,15 @@ module Aws::EventBridge
|
|
1288
1307
|
end
|
1289
1308
|
|
1290
1309
|
# Running `PutPermission` permits the specified AWS account or AWS
|
1291
|
-
# organization to put events to the specified *event bus*.
|
1292
|
-
# account are triggered by these events arriving to
|
1293
|
-
# account.
|
1310
|
+
# organization to put events to the specified *event bus*. CloudWatch
|
1311
|
+
# Events rules in your account are triggered by these events arriving to
|
1312
|
+
# an event bus in your account.
|
1294
1313
|
#
|
1295
1314
|
# For another account to send events to your account, that external
|
1296
|
-
# account must have
|
1315
|
+
# account must have an EventBridge rule with your account's event bus
|
1316
|
+
# as a target.
|
1297
1317
|
#
|
1298
|
-
# To enable multiple AWS accounts to put events to
|
1318
|
+
# To enable multiple AWS accounts to put events to your event bus, run
|
1299
1319
|
# `PutPermission` once for each of these accounts. Or, if all the
|
1300
1320
|
# accounts are members of the same AWS organization, you can run
|
1301
1321
|
# `PutPermission` once specifying `Principal` as "*" and specifying
|
@@ -1308,7 +1328,8 @@ module Aws::EventBridge
|
|
1308
1328
|
# more information, see [Sending and Receiving Events Between AWS
|
1309
1329
|
# Accounts][1] in the *Amazon EventBridge User Guide*.
|
1310
1330
|
#
|
1311
|
-
# The permission policy on
|
1331
|
+
# The permission policy on the default event bus cannot exceed 10 KB in
|
1332
|
+
# size.
|
1312
1333
|
#
|
1313
1334
|
#
|
1314
1335
|
#
|
@@ -1319,7 +1340,7 @@ module Aws::EventBridge
|
|
1319
1340
|
# event bus is used.
|
1320
1341
|
#
|
1321
1342
|
# @option params [required, String] :action
|
1322
|
-
# The action that you
|
1343
|
+
# The action that you are enabling the other account to perform.
|
1323
1344
|
# Currently, this must be `events:PutEvents`.
|
1324
1345
|
#
|
1325
1346
|
# @option params [required, String] :principal
|
@@ -1328,14 +1349,14 @@ module Aws::EventBridge
|
|
1328
1349
|
# events to your default event bus.
|
1329
1350
|
#
|
1330
1351
|
# If you specify "*" without specifying `Condition`, avoid creating
|
1331
|
-
# rules that
|
1332
|
-
#
|
1333
|
-
#
|
1334
|
-
#
|
1335
|
-
#
|
1352
|
+
# rules that may match undesirable events. To create more secure rules,
|
1353
|
+
# make sure that the event pattern for each rule contains an `account`
|
1354
|
+
# field with a specific account ID from which to receive events. Rules
|
1355
|
+
# with an account field do not match any events sent from other
|
1356
|
+
# accounts.
|
1336
1357
|
#
|
1337
1358
|
# @option params [required, String] :statement_id
|
1338
|
-
# An identifier string for the external account that you
|
1359
|
+
# An identifier string for the external account that you are granting
|
1339
1360
|
# permissions to. If you later want to revoke the permission for this
|
1340
1361
|
# external account, specify this `StatementId` when you run
|
1341
1362
|
# RemovePermission.
|
@@ -1344,13 +1365,13 @@ module Aws::EventBridge
|
|
1344
1365
|
# This parameter enables you to limit the permission to accounts that
|
1345
1366
|
# fulfill a certain condition, such as being a member of a certain AWS
|
1346
1367
|
# organization. For more information about AWS Organizations, see [What
|
1347
|
-
# Is AWS Organizations
|
1368
|
+
# Is AWS Organizations][1] in the *AWS Organizations User Guide*.
|
1348
1369
|
#
|
1349
|
-
# If you specify `Condition` with an AWS organization ID and specify
|
1370
|
+
# If you specify `Condition` with an AWS organization ID, and specify
|
1350
1371
|
# "*" as the value for `Principal`, you grant permission to all the
|
1351
1372
|
# accounts in the named organization.
|
1352
1373
|
#
|
1353
|
-
# The `Condition` is a JSON string
|
1374
|
+
# The `Condition` is a JSON string which must contain `Type`, `Key`, and
|
1354
1375
|
# `Value` fields.
|
1355
1376
|
#
|
1356
1377
|
#
|
@@ -1382,8 +1403,9 @@ module Aws::EventBridge
|
|
1382
1403
|
req.send_request(options)
|
1383
1404
|
end
|
1384
1405
|
|
1385
|
-
# Creates or updates the specified rule. Rules are enabled by default
|
1386
|
-
# based on value of the state. You can disable a rule using
|
1406
|
+
# Creates or updates the specified rule. Rules are enabled by default,
|
1407
|
+
# or based on value of the state. You can disable a rule using
|
1408
|
+
# DisableRule.
|
1387
1409
|
#
|
1388
1410
|
# A single rule watches for events from a single event bus. Events
|
1389
1411
|
# generated by AWS services go to your account's default event bus.
|
@@ -1393,21 +1415,21 @@ module Aws::EventBridge
|
|
1393
1415
|
# event bus or a custom event bus that you have created. For more
|
1394
1416
|
# information, see CreateEventBus.
|
1395
1417
|
#
|
1396
|
-
# If you
|
1418
|
+
# If you are updating an existing rule, the rule is replaced with what
|
1397
1419
|
# you specify in this `PutRule` command. If you omit arguments in
|
1398
|
-
# `PutRule`, the old values for those arguments
|
1399
|
-
# they
|
1420
|
+
# `PutRule`, the old values for those arguments are not kept. Instead,
|
1421
|
+
# they are replaced with null values.
|
1400
1422
|
#
|
1401
1423
|
# When you create or update a rule, incoming events might not
|
1402
1424
|
# immediately start matching to new or updated rules. Allow a short
|
1403
1425
|
# period of time for changes to take effect.
|
1404
1426
|
#
|
1405
|
-
# A rule must contain at least an
|
1406
|
-
#
|
1407
|
-
#
|
1408
|
-
#
|
1409
|
-
#
|
1410
|
-
#
|
1427
|
+
# A rule must contain at least an EventPattern or ScheduleExpression.
|
1428
|
+
# Rules with EventPatterns are triggered when a matching event is
|
1429
|
+
# observed. Rules with ScheduleExpressions self-trigger based on the
|
1430
|
+
# given schedule. A rule can have both an EventPattern and a
|
1431
|
+
# ScheduleExpression, in which case the rule triggers on matching events
|
1432
|
+
# as well as on a schedule.
|
1411
1433
|
#
|
1412
1434
|
# When you initially create a rule, you can optionally assign one or
|
1413
1435
|
# more tags to the rule. Tags can help you organize and categorize your
|
@@ -1420,21 +1442,21 @@ module Aws::EventBridge
|
|
1420
1442
|
# `PutRule` operation are ignored. To update the tags of an existing
|
1421
1443
|
# rule, use TagResource and UntagResource.
|
1422
1444
|
#
|
1423
|
-
# Most services in AWS treat
|
1445
|
+
# Most services in AWS treat : or / as the same character in Amazon
|
1424
1446
|
# Resource Names (ARNs). However, EventBridge uses an exact match in
|
1425
1447
|
# event patterns and rules. Be sure to use the correct ARN characters
|
1426
1448
|
# when creating event patterns so that they match the ARN syntax in the
|
1427
|
-
# event
|
1449
|
+
# event you want to match.
|
1428
1450
|
#
|
1429
|
-
# In EventBridge,
|
1430
|
-
# where a rule is fired repeatedly. For example, a rule might
|
1431
|
-
# that ACLs have changed on an S3 bucket, and trigger software to
|
1432
|
-
# them to the desired state. If
|
1433
|
-
# subsequent change to the ACLs fires the rule again,
|
1434
|
-
# infinite loop.
|
1451
|
+
# In EventBridge, it is possible to create rules that lead to infinite
|
1452
|
+
# loops, where a rule is fired repeatedly. For example, a rule might
|
1453
|
+
# detect that ACLs have changed on an S3 bucket, and trigger software to
|
1454
|
+
# change them to the desired state. If the rule is not written
|
1455
|
+
# carefully, the subsequent change to the ACLs fires the rule again,
|
1456
|
+
# creating an infinite loop.
|
1435
1457
|
#
|
1436
|
-
# To prevent this, write the rules so that the triggered actions
|
1437
|
-
#
|
1458
|
+
# To prevent this, write the rules so that the triggered actions do not
|
1459
|
+
# re-fire the same rule. For example, your rule could fire only if ACLs
|
1438
1460
|
# are found to be in a bad state, instead of after any change.
|
1439
1461
|
#
|
1440
1462
|
# An infinite loop can quickly cause higher than expected charges. We
|
@@ -1447,18 +1469,15 @@ module Aws::EventBridge
|
|
1447
1469
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html
|
1448
1470
|
#
|
1449
1471
|
# @option params [required, String] :name
|
1450
|
-
# The name of the rule that you
|
1451
|
-
#
|
1452
|
-
# A rule can't have the same name as another rule in the same Region or
|
1453
|
-
# on the same event bus.
|
1472
|
+
# The name of the rule that you are creating or updating.
|
1454
1473
|
#
|
1455
1474
|
# @option params [String] :schedule_expression
|
1456
|
-
# The scheduling expression
|
1457
|
-
#
|
1475
|
+
# The scheduling expression. For example, "cron(0 20 * * ? *)" or
|
1476
|
+
# "rate(5 minutes)".
|
1458
1477
|
#
|
1459
1478
|
# @option params [String] :event_pattern
|
1460
|
-
# The event pattern. For more information, see [
|
1461
|
-
# the *Amazon EventBridge User Guide*.
|
1479
|
+
# The event pattern. For more information, see [Events and Event
|
1480
|
+
# Patterns][1] in the *Amazon EventBridge User Guide*.
|
1462
1481
|
#
|
1463
1482
|
#
|
1464
1483
|
#
|
@@ -1517,11 +1536,11 @@ module Aws::EventBridge
|
|
1517
1536
|
end
|
1518
1537
|
|
1519
1538
|
# Adds the specified targets to the specified rule, or updates the
|
1520
|
-
# targets if they
|
1539
|
+
# targets if they are already associated with the rule.
|
1521
1540
|
#
|
1522
1541
|
# Targets are the resources that are invoked when a rule is triggered.
|
1523
1542
|
#
|
1524
|
-
# You can configure the following as targets
|
1543
|
+
# You can configure the following as targets for Events:
|
1525
1544
|
#
|
1526
1545
|
# * EC2 instances
|
1527
1546
|
#
|
@@ -1553,7 +1572,7 @@ module Aws::EventBridge
|
|
1553
1572
|
#
|
1554
1573
|
# * The default event bus of another AWS account
|
1555
1574
|
#
|
1556
|
-
# Creating rules with built-in targets is supported only
|
1575
|
+
# Creating rules with built-in targets is supported only in the AWS
|
1557
1576
|
# Management Console. The built-in targets are `EC2 CreateSnapshot API
|
1558
1577
|
# call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`,
|
1559
1578
|
# and `EC2 TerminateInstances API call`.
|
@@ -1565,15 +1584,15 @@ module Aws::EventBridge
|
|
1565
1584
|
# you can use the `RunCommandParameters` field.
|
1566
1585
|
#
|
1567
1586
|
# To be able to make API calls against the resources that you own,
|
1568
|
-
# Amazon
|
1569
|
-
# and Amazon SNS resources, EventBridge relies on resource-based
|
1587
|
+
# Amazon CloudWatch Events needs the appropriate permissions. For AWS
|
1588
|
+
# Lambda and Amazon SNS resources, EventBridge relies on resource-based
|
1570
1589
|
# policies. For EC2 instances, Kinesis data streams, and AWS Step
|
1571
1590
|
# Functions state machines, EventBridge relies on IAM roles that you
|
1572
1591
|
# specify in the `RoleARN` argument in `PutTargets`. For more
|
1573
1592
|
# information, see [Authentication and Access Control][1] in the *Amazon
|
1574
1593
|
# EventBridge User Guide*.
|
1575
1594
|
#
|
1576
|
-
# If another AWS account is in the same
|
1595
|
+
# If another AWS account is in the same region and has granted you
|
1577
1596
|
# permission (using `PutPermission`), you can send events to that
|
1578
1597
|
# account. Set that account's event bus as a target of the rules in
|
1579
1598
|
# your account. To send the matched events to the other account, specify
|
@@ -1581,39 +1600,44 @@ module Aws::EventBridge
|
|
1581
1600
|
# `PutTargets`. If your account sends events to another account, your
|
1582
1601
|
# account is charged for each sent event. Each event sent to another
|
1583
1602
|
# account is charged as a custom event. The account receiving the event
|
1584
|
-
#
|
1603
|
+
# is not charged. For more information, see [Amazon CloudWatch
|
1585
1604
|
# Pricing][2].
|
1586
1605
|
#
|
1587
|
-
#
|
1606
|
+
# <note markdown="1"> `Input`, `InputPath`, and `InputTransformer` are not available with
|
1607
|
+
# `PutTarget` if the target is an event bus of a different AWS account.
|
1608
|
+
#
|
1609
|
+
# </note>
|
1610
|
+
#
|
1611
|
+
# If you are setting the event bus of another account as the target, and
|
1588
1612
|
# that account granted permission to your account through an
|
1589
|
-
# organization instead of directly by the account ID, you must
|
1590
|
-
# `RoleArn` with proper permissions in the `Target` structure.
|
1591
|
-
# information, see [Sending and Receiving Events Between AWS
|
1613
|
+
# organization instead of directly by the account ID, then you must
|
1614
|
+
# specify a `RoleArn` with proper permissions in the `Target` structure.
|
1615
|
+
# For more information, see [Sending and Receiving Events Between AWS
|
1592
1616
|
# Accounts][3] in the *Amazon EventBridge User Guide*.
|
1593
1617
|
#
|
1594
1618
|
# For more information about enabling cross-account events, see
|
1595
1619
|
# PutPermission.
|
1596
1620
|
#
|
1597
|
-
#
|
1598
|
-
# and optional parameters of a target. When a rule is
|
1599
|
-
# matched event:
|
1621
|
+
# **Input**, **InputPath**, and **InputTransformer** are mutually
|
1622
|
+
# exclusive and optional parameters of a target. When a rule is
|
1623
|
+
# triggered due to a matched event:
|
1600
1624
|
#
|
1601
|
-
# * If none of the following arguments are specified for a target,
|
1602
|
-
# entire event is passed to the target in JSON format (unless the
|
1625
|
+
# * If none of the following arguments are specified for a target, then
|
1626
|
+
# the entire event is passed to the target in JSON format (unless the
|
1603
1627
|
# target is Amazon EC2 Run Command or Amazon ECS task, in which case
|
1604
1628
|
# nothing from the event is passed to the target).
|
1605
1629
|
#
|
1606
|
-
# * If
|
1607
|
-
# event is overridden with this constant.
|
1630
|
+
# * If **Input** is specified in the form of valid JSON, then the
|
1631
|
+
# matched event is overridden with this constant.
|
1608
1632
|
#
|
1609
|
-
# * If
|
1610
|
-
# `$.detail`), only the part of the event specified in the path
|
1611
|
-
# passed to the target (for example, only the detail part of the
|
1612
|
-
# is passed).
|
1633
|
+
# * If **InputPath** is specified in the form of JSONPath (for example,
|
1634
|
+
# `$.detail`), then only the part of the event specified in the path
|
1635
|
+
# is passed to the target (for example, only the detail part of the
|
1636
|
+
# event is passed).
|
1613
1637
|
#
|
1614
|
-
# * If
|
1615
|
-
# are extracted from the event and used as values in a
|
1616
|
-
# you specify as the input to the target.
|
1638
|
+
# * If **InputTransformer** is specified, then one or more specified
|
1639
|
+
# JSONPaths are extracted from the event and used as values in a
|
1640
|
+
# template that you specify as the input to the target.
|
1617
1641
|
#
|
1618
1642
|
# When you specify `InputPath` or `InputTransformer`, you must use JSON
|
1619
1643
|
# dot notation, not bracket notation.
|
@@ -1623,14 +1647,14 @@ module Aws::EventBridge
|
|
1623
1647
|
# a short period of time for changes to take effect.
|
1624
1648
|
#
|
1625
1649
|
# This action can partially fail if too many requests are made at the
|
1626
|
-
# same time. If that happens, `FailedEntryCount` is
|
1627
|
-
# response
|
1650
|
+
# same time. If that happens, `FailedEntryCount` is non-zero in the
|
1651
|
+
# response and each entry in `FailedEntries` provides the ID of the
|
1628
1652
|
# failed target and the error code.
|
1629
1653
|
#
|
1630
1654
|
#
|
1631
1655
|
#
|
1632
1656
|
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html
|
1633
|
-
# [2]: https://aws.amazon.com/
|
1657
|
+
# [2]: https://aws.amazon.com/cloudwatch/pricing/
|
1634
1658
|
# [3]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
|
1635
1659
|
#
|
1636
1660
|
# @option params [required, String] :rule
|
@@ -1779,9 +1803,9 @@ module Aws::EventBridge
|
|
1779
1803
|
# The IDs of the targets to remove from the rule.
|
1780
1804
|
#
|
1781
1805
|
# @option params [Boolean] :force
|
1782
|
-
# If this is a managed rule created by an AWS service on your behalf,
|
1806
|
+
# If this is a managed rule, created by an AWS service on your behalf,
|
1783
1807
|
# you must specify `Force` as `True` to remove targets. This parameter
|
1784
|
-
# is ignored for rules that
|
1808
|
+
# is ignored for rules that are not managed rules. You can check whether
|
1785
1809
|
# a rule is a managed rule by using `DescribeRule` or `ListRules` and
|
1786
1810
|
# checking the `ManagedBy` field of the response.
|
1787
1811
|
#
|
@@ -1820,24 +1844,24 @@ module Aws::EventBridge
|
|
1820
1844
|
# EventBridge resource. Tags can help you organize and categorize your
|
1821
1845
|
# resources. You can also use them to scope user permissions by granting
|
1822
1846
|
# a user permission to access or change only resources with certain tag
|
1823
|
-
# values. In EventBridge, rules can be tagged.
|
1847
|
+
# values. In EventBridge, rules and event buses can be tagged.
|
1824
1848
|
#
|
1825
1849
|
# Tags don't have any semantic meaning to AWS and are interpreted
|
1826
1850
|
# strictly as strings of characters.
|
1827
1851
|
#
|
1828
|
-
# You can use the `TagResource` action with a
|
1829
|
-
# tags. If you specify a new tag key
|
1830
|
-
#
|
1831
|
-
#
|
1852
|
+
# You can use the `TagResource` action with a resource that already has
|
1853
|
+
# tags. If you specify a new tag key, this tag is appended to the list
|
1854
|
+
# of tags associated with the resource. If you specify a tag key that is
|
1855
|
+
# already associated with the resource, the new tag value that you
|
1832
1856
|
# specify replaces the previous value for that tag.
|
1833
1857
|
#
|
1834
1858
|
# You can associate as many as 50 tags with a resource.
|
1835
1859
|
#
|
1836
1860
|
# @option params [required, String] :resource_arn
|
1837
|
-
# The ARN of the
|
1861
|
+
# The ARN of the EventBridge resource that you're adding tags to.
|
1838
1862
|
#
|
1839
1863
|
# @option params [required, Array<Types::Tag>] :tags
|
1840
|
-
# The list of key-value pairs to associate with the
|
1864
|
+
# The list of key-value pairs to associate with the resource.
|
1841
1865
|
#
|
1842
1866
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1843
1867
|
#
|
@@ -1864,15 +1888,15 @@ module Aws::EventBridge
|
|
1864
1888
|
|
1865
1889
|
# Tests whether the specified event pattern matches the provided event.
|
1866
1890
|
#
|
1867
|
-
# Most services in AWS treat
|
1891
|
+
# Most services in AWS treat : or / as the same character in Amazon
|
1868
1892
|
# Resource Names (ARNs). However, EventBridge uses an exact match in
|
1869
1893
|
# event patterns and rules. Be sure to use the correct ARN characters
|
1870
1894
|
# when creating event patterns so that they match the ARN syntax in the
|
1871
|
-
# event
|
1895
|
+
# event you want to match.
|
1872
1896
|
#
|
1873
1897
|
# @option params [required, String] :event_pattern
|
1874
|
-
# The event pattern. For more information, see [
|
1875
|
-
# the *Amazon EventBridge User Guide*.
|
1898
|
+
# The event pattern. For more information, see [Events and Event
|
1899
|
+
# Patterns][1] in the *Amazon EventBridge User Guide*.
|
1876
1900
|
#
|
1877
1901
|
#
|
1878
1902
|
#
|
@@ -1906,10 +1930,10 @@ module Aws::EventBridge
|
|
1906
1930
|
end
|
1907
1931
|
|
1908
1932
|
# Removes one or more tags from the specified EventBridge resource. In
|
1909
|
-
#
|
1933
|
+
# CloudWatch Events, rules and event buses can be tagged.
|
1910
1934
|
#
|
1911
1935
|
# @option params [required, String] :resource_arn
|
1912
|
-
# The ARN of the
|
1936
|
+
# The ARN of the EventBridge resource from which you are removing tags.
|
1913
1937
|
#
|
1914
1938
|
# @option params [required, Array<String>] :tag_keys
|
1915
1939
|
# The list of tag keys to remove from the resource.
|
@@ -1945,7 +1969,7 @@ module Aws::EventBridge
|
|
1945
1969
|
params: params,
|
1946
1970
|
config: config)
|
1947
1971
|
context[:gem_name] = 'aws-sdk-eventbridge'
|
1948
|
-
context[:gem_version] = '1.
|
1972
|
+
context[:gem_version] = '1.8.1'
|
1949
1973
|
Seahorse::Client::Request.new(handlers, context)
|
1950
1974
|
end
|
1951
1975
|
|