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