aws-sdk-cloudwatchevents 1.22.0 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudwatchevents.rb +1 -1
- data/lib/aws-sdk-cloudwatchevents/client.rb +777 -128
- data/lib/aws-sdk-cloudwatchevents/client_api.rb +331 -0
- data/lib/aws-sdk-cloudwatchevents/types.rb +926 -105
- metadata +2 -2
@@ -8,8 +8,26 @@
|
|
8
8
|
module Aws::CloudWatchEvents
|
9
9
|
module Types
|
10
10
|
|
11
|
+
# @note When making an API call, you may pass ActivateEventSourceRequest
|
12
|
+
# data as a hash:
|
13
|
+
#
|
14
|
+
# {
|
15
|
+
# name: "EventSourceName", # required
|
16
|
+
# }
|
17
|
+
#
|
18
|
+
# @!attribute [rw] name
|
19
|
+
# The name of the partner event source to activate.
|
20
|
+
# @return [String]
|
21
|
+
#
|
22
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ActivateEventSourceRequest AWS API Documentation
|
23
|
+
#
|
24
|
+
class ActivateEventSourceRequest < Struct.new(
|
25
|
+
:name)
|
26
|
+
include Aws::Structure
|
27
|
+
end
|
28
|
+
|
11
29
|
# This structure specifies the VPC subnets and security groups for the
|
12
|
-
# task
|
30
|
+
# task and whether a public IP address is to be used. This structure is
|
13
31
|
# relevant only for ECS tasks that use the `awsvpc` network mode.
|
14
32
|
#
|
15
33
|
# @note When making an API call, you may pass AwsVpcConfiguration
|
@@ -29,7 +47,7 @@ module Aws::CloudWatchEvents
|
|
29
47
|
# @!attribute [rw] security_groups
|
30
48
|
# Specifies the security groups associated with the task. These
|
31
49
|
# security groups must all be in the same VPC. You can specify as many
|
32
|
-
# as five security groups. If you
|
50
|
+
# as five security groups. If you don't specify a security group, the
|
33
51
|
# default security group for the VPC is used.
|
34
52
|
# @return [Array<String>]
|
35
53
|
#
|
@@ -106,7 +124,7 @@ module Aws::CloudWatchEvents
|
|
106
124
|
# @return [Types::BatchArrayProperties]
|
107
125
|
#
|
108
126
|
# @!attribute [rw] retry_strategy
|
109
|
-
# The retry strategy to use for failed jobs
|
127
|
+
# The retry strategy to use for failed jobs if the target is an AWS
|
110
128
|
# Batch job. The retry strategy is the number of times to retry the
|
111
129
|
# failed job execution. Valid values are 1–10. When you specify a
|
112
130
|
# retry strategy here, it overrides the retry strategy defined in the
|
@@ -123,7 +141,7 @@ module Aws::CloudWatchEvents
|
|
123
141
|
include Aws::Structure
|
124
142
|
end
|
125
143
|
|
126
|
-
# The retry strategy to use for failed jobs
|
144
|
+
# The retry strategy to use for failed jobs if the target is an AWS
|
127
145
|
# Batch job. If you specify a retry strategy here, it overrides the
|
128
146
|
# retry strategy defined in the job definition.
|
129
147
|
#
|
@@ -146,12 +164,12 @@ module Aws::CloudWatchEvents
|
|
146
164
|
include Aws::Structure
|
147
165
|
end
|
148
166
|
|
149
|
-
# A JSON string
|
150
|
-
#
|
151
|
-
# the only supported condition is membership in a certain AWS
|
167
|
+
# A JSON string that you can use to limit the event bus permissions that
|
168
|
+
# you're granting to only accounts that fulfill the condition.
|
169
|
+
# Currently, the only supported condition is membership in a certain AWS
|
152
170
|
# organization. The string must contain `Type`, `Key`, and `Value`
|
153
171
|
# fields. The `Value` field specifies the ID of the AWS organization.
|
154
|
-
#
|
172
|
+
# The following is an example value for `Condition`\:
|
155
173
|
#
|
156
174
|
# `'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
|
157
175
|
# "o-1234567890"\}'`
|
@@ -166,18 +184,18 @@ module Aws::CloudWatchEvents
|
|
166
184
|
# }
|
167
185
|
#
|
168
186
|
# @!attribute [rw] type
|
169
|
-
#
|
170
|
-
#
|
187
|
+
# The type of condition. Currently, the only supported value is
|
188
|
+
# `StringEquals`.
|
171
189
|
# @return [String]
|
172
190
|
#
|
173
191
|
# @!attribute [rw] key
|
174
|
-
#
|
175
|
-
#
|
192
|
+
# The key for the condition. Currently, the only supported key is
|
193
|
+
# `aws:PrincipalOrgID`.
|
176
194
|
# @return [String]
|
177
195
|
#
|
178
196
|
# @!attribute [rw] value
|
179
|
-
#
|
180
|
-
#
|
197
|
+
# The value for the key. Currently, this must be the ID of the
|
198
|
+
# organization.
|
181
199
|
# @return [String]
|
182
200
|
#
|
183
201
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Condition AWS API Documentation
|
@@ -189,11 +207,157 @@ module Aws::CloudWatchEvents
|
|
189
207
|
include Aws::Structure
|
190
208
|
end
|
191
209
|
|
210
|
+
# @note When making an API call, you may pass CreateEventBusRequest
|
211
|
+
# data as a hash:
|
212
|
+
#
|
213
|
+
# {
|
214
|
+
# name: "EventBusName", # required
|
215
|
+
# event_source_name: "EventSourceName",
|
216
|
+
# }
|
217
|
+
#
|
218
|
+
# @!attribute [rw] name
|
219
|
+
# The name of the new event bus.
|
220
|
+
#
|
221
|
+
# The names of custom event buses can't contain the `/` character.
|
222
|
+
# You can't use the name `default` for a custom event bus because
|
223
|
+
# this name is already used for your account's default event bus.
|
224
|
+
#
|
225
|
+
# If this is a partner event bus, the name must exactly match the name
|
226
|
+
# of the partner event source that this event bus is matched to. This
|
227
|
+
# name will include the `/` character.
|
228
|
+
# @return [String]
|
229
|
+
#
|
230
|
+
# @!attribute [rw] event_source_name
|
231
|
+
# If you're creating a partner event bus, this specifies the partner
|
232
|
+
# event source that the new event bus will be matched with.
|
233
|
+
# @return [String]
|
234
|
+
#
|
235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateEventBusRequest AWS API Documentation
|
236
|
+
#
|
237
|
+
class CreateEventBusRequest < Struct.new(
|
238
|
+
:name,
|
239
|
+
:event_source_name)
|
240
|
+
include Aws::Structure
|
241
|
+
end
|
242
|
+
|
243
|
+
# @!attribute [rw] event_bus_arn
|
244
|
+
# The ARN of the new event bus.
|
245
|
+
# @return [String]
|
246
|
+
#
|
247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateEventBusResponse AWS API Documentation
|
248
|
+
#
|
249
|
+
class CreateEventBusResponse < Struct.new(
|
250
|
+
:event_bus_arn)
|
251
|
+
include Aws::Structure
|
252
|
+
end
|
253
|
+
|
254
|
+
# @note When making an API call, you may pass CreatePartnerEventSourceRequest
|
255
|
+
# data as a hash:
|
256
|
+
#
|
257
|
+
# {
|
258
|
+
# name: "EventSourceName", # required
|
259
|
+
# account: "AccountId", # required
|
260
|
+
# }
|
261
|
+
#
|
262
|
+
# @!attribute [rw] name
|
263
|
+
# The name of the partner event source. This name must be unique and
|
264
|
+
# must be in the format ` partner_name/event_namespace/event_name `.
|
265
|
+
# The AWS account that wants to use this partner event source must
|
266
|
+
# create a partner event bus with a name that matches the name of the
|
267
|
+
# partner event source.
|
268
|
+
# @return [String]
|
269
|
+
#
|
270
|
+
# @!attribute [rw] account
|
271
|
+
# The AWS account ID of the customer who is permitted to create a
|
272
|
+
# matching partner event bus for this partner event source.
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
|
276
|
+
#
|
277
|
+
class CreatePartnerEventSourceRequest < Struct.new(
|
278
|
+
:name,
|
279
|
+
:account)
|
280
|
+
include Aws::Structure
|
281
|
+
end
|
282
|
+
|
283
|
+
# @!attribute [rw] event_source_arn
|
284
|
+
# The ARN of the partner event source.
|
285
|
+
# @return [String]
|
286
|
+
#
|
287
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreatePartnerEventSourceResponse AWS API Documentation
|
288
|
+
#
|
289
|
+
class CreatePartnerEventSourceResponse < Struct.new(
|
290
|
+
:event_source_arn)
|
291
|
+
include Aws::Structure
|
292
|
+
end
|
293
|
+
|
294
|
+
# @note When making an API call, you may pass DeactivateEventSourceRequest
|
295
|
+
# data as a hash:
|
296
|
+
#
|
297
|
+
# {
|
298
|
+
# name: "EventSourceName", # required
|
299
|
+
# }
|
300
|
+
#
|
301
|
+
# @!attribute [rw] name
|
302
|
+
# The name of the partner event source to deactivate.
|
303
|
+
# @return [String]
|
304
|
+
#
|
305
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeactivateEventSourceRequest AWS API Documentation
|
306
|
+
#
|
307
|
+
class DeactivateEventSourceRequest < Struct.new(
|
308
|
+
:name)
|
309
|
+
include Aws::Structure
|
310
|
+
end
|
311
|
+
|
312
|
+
# @note When making an API call, you may pass DeleteEventBusRequest
|
313
|
+
# data as a hash:
|
314
|
+
#
|
315
|
+
# {
|
316
|
+
# name: "EventBusName", # required
|
317
|
+
# }
|
318
|
+
#
|
319
|
+
# @!attribute [rw] name
|
320
|
+
# The name of the event bus to delete.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteEventBusRequest AWS API Documentation
|
324
|
+
#
|
325
|
+
class DeleteEventBusRequest < Struct.new(
|
326
|
+
:name)
|
327
|
+
include Aws::Structure
|
328
|
+
end
|
329
|
+
|
330
|
+
# @note When making an API call, you may pass DeletePartnerEventSourceRequest
|
331
|
+
# data as a hash:
|
332
|
+
#
|
333
|
+
# {
|
334
|
+
# name: "EventSourceName", # required
|
335
|
+
# account: "AccountId", # required
|
336
|
+
# }
|
337
|
+
#
|
338
|
+
# @!attribute [rw] name
|
339
|
+
# The name of the event source to delete.
|
340
|
+
# @return [String]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] account
|
343
|
+
# The AWS account ID of the AWS customer that the event source was
|
344
|
+
# created for.
|
345
|
+
# @return [String]
|
346
|
+
#
|
347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
|
348
|
+
#
|
349
|
+
class DeletePartnerEventSourceRequest < Struct.new(
|
350
|
+
:name,
|
351
|
+
:account)
|
352
|
+
include Aws::Structure
|
353
|
+
end
|
354
|
+
|
192
355
|
# @note When making an API call, you may pass DeleteRuleRequest
|
193
356
|
# data as a hash:
|
194
357
|
#
|
195
358
|
# {
|
196
359
|
# name: "RuleName", # required
|
360
|
+
# event_bus_name: "EventBusName",
|
197
361
|
# force: false,
|
198
362
|
# }
|
199
363
|
#
|
@@ -201,6 +365,11 @@ module Aws::CloudWatchEvents
|
|
201
365
|
# The name of the rule.
|
202
366
|
# @return [String]
|
203
367
|
#
|
368
|
+
# @!attribute [rw] event_bus_name
|
369
|
+
# The event bus associated with the rule. If you omit this, the
|
370
|
+
# default event bus is used.
|
371
|
+
# @return [String]
|
372
|
+
#
|
204
373
|
# @!attribute [rw] force
|
205
374
|
# If this is a managed rule, created by an AWS service on your behalf,
|
206
375
|
# you must specify `Force` as `True` to delete the rule. This
|
@@ -213,15 +382,29 @@ module Aws::CloudWatchEvents
|
|
213
382
|
#
|
214
383
|
class DeleteRuleRequest < Struct.new(
|
215
384
|
:name,
|
385
|
+
:event_bus_name,
|
216
386
|
:force)
|
217
387
|
include Aws::Structure
|
218
388
|
end
|
219
389
|
|
220
|
-
# @
|
390
|
+
# @note When making an API call, you may pass DescribeEventBusRequest
|
391
|
+
# data as a hash:
|
392
|
+
#
|
393
|
+
# {
|
394
|
+
# name: "EventBusName",
|
395
|
+
# }
|
396
|
+
#
|
397
|
+
# @!attribute [rw] name
|
398
|
+
# The name of the event bus to show details for. If you omit this, the
|
399
|
+
# default event bus is displayed.
|
400
|
+
# @return [String]
|
221
401
|
#
|
222
402
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventBusRequest AWS API Documentation
|
223
403
|
#
|
224
|
-
class DescribeEventBusRequest <
|
404
|
+
class DescribeEventBusRequest < Struct.new(
|
405
|
+
:name)
|
406
|
+
include Aws::Structure
|
407
|
+
end
|
225
408
|
|
226
409
|
# @!attribute [rw] name
|
227
410
|
# The name of the event bus. Currently, this is always `default`.
|
@@ -246,21 +429,122 @@ module Aws::CloudWatchEvents
|
|
246
429
|
include Aws::Structure
|
247
430
|
end
|
248
431
|
|
432
|
+
# @note When making an API call, you may pass DescribeEventSourceRequest
|
433
|
+
# data as a hash:
|
434
|
+
#
|
435
|
+
# {
|
436
|
+
# name: "EventSourceName", # required
|
437
|
+
# }
|
438
|
+
#
|
439
|
+
# @!attribute [rw] name
|
440
|
+
# The name of the partner event source to display the details of.
|
441
|
+
# @return [String]
|
442
|
+
#
|
443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventSourceRequest AWS API Documentation
|
444
|
+
#
|
445
|
+
class DescribeEventSourceRequest < Struct.new(
|
446
|
+
:name)
|
447
|
+
include Aws::Structure
|
448
|
+
end
|
449
|
+
|
450
|
+
# @!attribute [rw] arn
|
451
|
+
# The ARN of the partner event source.
|
452
|
+
# @return [String]
|
453
|
+
#
|
454
|
+
# @!attribute [rw] created_by
|
455
|
+
# The name of the SaaS partner that created the event source.
|
456
|
+
# @return [String]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] creation_time
|
459
|
+
# The date and time that the event source was created.
|
460
|
+
# @return [Time]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] expiration_time
|
463
|
+
# The date and time that the event source will expire if you don't
|
464
|
+
# create a matching event bus.
|
465
|
+
# @return [Time]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] name
|
468
|
+
# The name of the partner event source.
|
469
|
+
# @return [String]
|
470
|
+
#
|
471
|
+
# @!attribute [rw] state
|
472
|
+
# The state of the event source. If it's `ACTIVE`, you have already
|
473
|
+
# created a matching event bus for this event source, and that event
|
474
|
+
# bus is active. If it's `PENDING`, either you haven't yet created a
|
475
|
+
# matching event bus, or that event bus is deactivated. If it's
|
476
|
+
# `DELETED`, you have created a matching event bus, but the event
|
477
|
+
# source has since been deleted.
|
478
|
+
# @return [String]
|
479
|
+
#
|
480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventSourceResponse AWS API Documentation
|
481
|
+
#
|
482
|
+
class DescribeEventSourceResponse < Struct.new(
|
483
|
+
:arn,
|
484
|
+
:created_by,
|
485
|
+
:creation_time,
|
486
|
+
:expiration_time,
|
487
|
+
:name,
|
488
|
+
:state)
|
489
|
+
include Aws::Structure
|
490
|
+
end
|
491
|
+
|
492
|
+
# @note When making an API call, you may pass DescribePartnerEventSourceRequest
|
493
|
+
# data as a hash:
|
494
|
+
#
|
495
|
+
# {
|
496
|
+
# name: "EventSourceName", # required
|
497
|
+
# }
|
498
|
+
#
|
499
|
+
# @!attribute [rw] name
|
500
|
+
# The name of the event source to display.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribePartnerEventSourceRequest AWS API Documentation
|
504
|
+
#
|
505
|
+
class DescribePartnerEventSourceRequest < Struct.new(
|
506
|
+
:name)
|
507
|
+
include Aws::Structure
|
508
|
+
end
|
509
|
+
|
510
|
+
# @!attribute [rw] arn
|
511
|
+
# The ARN of the event source.
|
512
|
+
# @return [String]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] name
|
515
|
+
# The name of the event source.
|
516
|
+
# @return [String]
|
517
|
+
#
|
518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribePartnerEventSourceResponse AWS API Documentation
|
519
|
+
#
|
520
|
+
class DescribePartnerEventSourceResponse < Struct.new(
|
521
|
+
:arn,
|
522
|
+
:name)
|
523
|
+
include Aws::Structure
|
524
|
+
end
|
525
|
+
|
249
526
|
# @note When making an API call, you may pass DescribeRuleRequest
|
250
527
|
# data as a hash:
|
251
528
|
#
|
252
529
|
# {
|
253
530
|
# name: "RuleName", # required
|
531
|
+
# event_bus_name: "EventBusName",
|
254
532
|
# }
|
255
533
|
#
|
256
534
|
# @!attribute [rw] name
|
257
535
|
# The name of the rule.
|
258
536
|
# @return [String]
|
259
537
|
#
|
538
|
+
# @!attribute [rw] event_bus_name
|
539
|
+
# The event bus associated with the rule. If you omit this, the
|
540
|
+
# default event bus is used.
|
541
|
+
# @return [String]
|
542
|
+
#
|
260
543
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRuleRequest AWS API Documentation
|
261
544
|
#
|
262
545
|
class DescribeRuleRequest < Struct.new(
|
263
|
-
:name
|
546
|
+
:name,
|
547
|
+
:event_bus_name)
|
264
548
|
include Aws::Structure
|
265
549
|
end
|
266
550
|
|
@@ -273,17 +557,17 @@ module Aws::CloudWatchEvents
|
|
273
557
|
# @return [String]
|
274
558
|
#
|
275
559
|
# @!attribute [rw] event_pattern
|
276
|
-
# The event pattern. For more information, see [
|
277
|
-
#
|
560
|
+
# The event pattern. For more information, see [Event Patterns][1] in
|
561
|
+
# the *Amazon EventBridge User Guide*.
|
278
562
|
#
|
279
563
|
#
|
280
564
|
#
|
281
|
-
# [1]: https://docs.aws.amazon.com/
|
565
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
|
282
566
|
# @return [String]
|
283
567
|
#
|
284
568
|
# @!attribute [rw] schedule_expression
|
285
|
-
# The scheduling expression
|
286
|
-
# "rate(5 minutes)"
|
569
|
+
# The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
|
570
|
+
# `"rate(5 minutes)"`.
|
287
571
|
# @return [String]
|
288
572
|
#
|
289
573
|
# @!attribute [rw] state
|
@@ -305,6 +589,10 @@ module Aws::CloudWatchEvents
|
|
305
589
|
# created the rule.
|
306
590
|
# @return [String]
|
307
591
|
#
|
592
|
+
# @!attribute [rw] event_bus_name
|
593
|
+
# The event bus associated with the rule.
|
594
|
+
# @return [String]
|
595
|
+
#
|
308
596
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRuleResponse AWS API Documentation
|
309
597
|
#
|
310
598
|
class DescribeRuleResponse < Struct.new(
|
@@ -315,7 +603,8 @@ module Aws::CloudWatchEvents
|
|
315
603
|
:state,
|
316
604
|
:description,
|
317
605
|
:role_arn,
|
318
|
-
:managed_by
|
606
|
+
:managed_by,
|
607
|
+
:event_bus_name)
|
319
608
|
include Aws::Structure
|
320
609
|
end
|
321
610
|
|
@@ -324,16 +613,23 @@ module Aws::CloudWatchEvents
|
|
324
613
|
#
|
325
614
|
# {
|
326
615
|
# name: "RuleName", # required
|
616
|
+
# event_bus_name: "EventBusName",
|
327
617
|
# }
|
328
618
|
#
|
329
619
|
# @!attribute [rw] name
|
330
620
|
# The name of the rule.
|
331
621
|
# @return [String]
|
332
622
|
#
|
623
|
+
# @!attribute [rw] event_bus_name
|
624
|
+
# The event bus associated with the rule. If you omit this, the
|
625
|
+
# default event bus is used.
|
626
|
+
# @return [String]
|
627
|
+
#
|
333
628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRuleRequest AWS API Documentation
|
334
629
|
#
|
335
630
|
class DisableRuleRequest < Struct.new(
|
336
|
-
:name
|
631
|
+
:name,
|
632
|
+
:event_bus_name)
|
337
633
|
include Aws::Structure
|
338
634
|
end
|
339
635
|
|
@@ -384,12 +680,12 @@ module Aws::CloudWatchEvents
|
|
384
680
|
# @!attribute [rw] network_configuration
|
385
681
|
# Use this structure if the ECS task uses the `awsvpc` network mode.
|
386
682
|
# This structure specifies the VPC subnets and security groups
|
387
|
-
# associated with the task
|
683
|
+
# associated with the task and whether a public IP address is to be
|
388
684
|
# used. This structure is required if `LaunchType` is `FARGATE`
|
389
685
|
# because the `awsvpc` mode is required for Fargate tasks.
|
390
686
|
#
|
391
|
-
# If you specify `NetworkConfiguration` when the target ECS task
|
392
|
-
#
|
687
|
+
# If you specify `NetworkConfiguration` when the target ECS task
|
688
|
+
# doesn't use the `awsvpc` network mode, the task fails.
|
393
689
|
# @return [Types::NetworkConfiguration]
|
394
690
|
#
|
395
691
|
# @!attribute [rw] platform_version
|
@@ -428,16 +724,100 @@ module Aws::CloudWatchEvents
|
|
428
724
|
#
|
429
725
|
# {
|
430
726
|
# name: "RuleName", # required
|
727
|
+
# event_bus_name: "EventBusName",
|
431
728
|
# }
|
432
729
|
#
|
433
730
|
# @!attribute [rw] name
|
434
731
|
# The name of the rule.
|
435
732
|
# @return [String]
|
436
733
|
#
|
734
|
+
# @!attribute [rw] event_bus_name
|
735
|
+
# The event bus associated with the rule. If you omit this, the
|
736
|
+
# default event bus is used.
|
737
|
+
# @return [String]
|
738
|
+
#
|
437
739
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRuleRequest AWS API Documentation
|
438
740
|
#
|
439
741
|
class EnableRuleRequest < Struct.new(
|
440
|
-
:name
|
742
|
+
:name,
|
743
|
+
:event_bus_name)
|
744
|
+
include Aws::Structure
|
745
|
+
end
|
746
|
+
|
747
|
+
# An event bus receives events from a source and routes them to rules
|
748
|
+
# associated with that event bus. Your account's default event bus
|
749
|
+
# receives rules from AWS services. A custom event bus can receive rules
|
750
|
+
# from AWS services as well as your custom applications and services. A
|
751
|
+
# partner event bus receives events from an event source created by an
|
752
|
+
# SaaS partner. These events come from the partners services or
|
753
|
+
# applications.
|
754
|
+
#
|
755
|
+
# @!attribute [rw] name
|
756
|
+
# The name of the event bus.
|
757
|
+
# @return [String]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] arn
|
760
|
+
# The ARN of the event bus.
|
761
|
+
# @return [String]
|
762
|
+
#
|
763
|
+
# @!attribute [rw] policy
|
764
|
+
# The permissions policy of the event bus, describing which other AWS
|
765
|
+
# accounts can write events to this event bus.
|
766
|
+
# @return [String]
|
767
|
+
#
|
768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EventBus AWS API Documentation
|
769
|
+
#
|
770
|
+
class EventBus < Struct.new(
|
771
|
+
:name,
|
772
|
+
:arn,
|
773
|
+
:policy)
|
774
|
+
include Aws::Structure
|
775
|
+
end
|
776
|
+
|
777
|
+
# A partner event source is created by an SaaS partner. If a customer
|
778
|
+
# creates a partner event bus that matches this event source, that AWS
|
779
|
+
# account can receive events from the partner's applications or
|
780
|
+
# services.
|
781
|
+
#
|
782
|
+
# @!attribute [rw] arn
|
783
|
+
# The ARN of the event source.
|
784
|
+
# @return [String]
|
785
|
+
#
|
786
|
+
# @!attribute [rw] created_by
|
787
|
+
# The name of the partner that created the event source.
|
788
|
+
# @return [String]
|
789
|
+
#
|
790
|
+
# @!attribute [rw] creation_time
|
791
|
+
# The date and time when the event source was created.
|
792
|
+
# @return [Time]
|
793
|
+
#
|
794
|
+
# @!attribute [rw] expiration_time
|
795
|
+
# The date and time when the event source will expire if the AWS
|
796
|
+
# account doesn't create a matching event bus for it.
|
797
|
+
# @return [Time]
|
798
|
+
#
|
799
|
+
# @!attribute [rw] name
|
800
|
+
# The name of the event source.
|
801
|
+
# @return [String]
|
802
|
+
#
|
803
|
+
# @!attribute [rw] state
|
804
|
+
# The state of the event source. If it's `ACTIVE`, you have already
|
805
|
+
# created a matching event bus for this event source, and that event
|
806
|
+
# bus is active. If it's `PENDING`, either you haven't yet created a
|
807
|
+
# matching event bus, or that event bus is deactivated. If it's
|
808
|
+
# `DELETED`, you have created a matching event bus, but the event
|
809
|
+
# source has since been deleted.
|
810
|
+
# @return [String]
|
811
|
+
#
|
812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EventSource AWS API Documentation
|
813
|
+
#
|
814
|
+
class EventSource < Struct.new(
|
815
|
+
:arn,
|
816
|
+
:created_by,
|
817
|
+
:creation_time,
|
818
|
+
:expiration_time,
|
819
|
+
:name,
|
820
|
+
:state)
|
441
821
|
include Aws::Structure
|
442
822
|
end
|
443
823
|
|
@@ -457,27 +837,27 @@ module Aws::CloudWatchEvents
|
|
457
837
|
# @!attribute [rw] input_paths_map
|
458
838
|
# Map of JSON paths to be extracted from the event. You can then
|
459
839
|
# insert these in the template in `InputTemplate` to produce the
|
460
|
-
# output
|
840
|
+
# output to be sent to the target.
|
461
841
|
#
|
462
842
|
# `InputPathsMap` is an array key-value pairs, where each value is a
|
463
843
|
# valid JSON path. You can have as many as 10 key-value pairs. You
|
464
844
|
# must use JSON dot notation, not bracket notation.
|
465
845
|
#
|
466
|
-
# The keys
|
846
|
+
# The keys can't start with `"AWS"`.
|
467
847
|
# @return [Hash<String,String>]
|
468
848
|
#
|
469
849
|
# @!attribute [rw] input_template
|
470
850
|
# Input template where you specify placeholders that will be filled
|
471
851
|
# with the values of the keys from `InputPathsMap` to customize the
|
472
852
|
# data sent to the target. Enclose each `InputPathsMaps` value in
|
473
|
-
# brackets: <*value*>
|
853
|
+
# brackets: <*value*>. The InputTemplate must be valid JSON.
|
474
854
|
#
|
475
855
|
# If `InputTemplate` is a JSON object (surrounded by curly braces),
|
476
856
|
# the following restrictions apply:
|
477
857
|
#
|
478
|
-
# * The placeholder
|
858
|
+
# * The placeholder can't be used as an object key
|
479
859
|
#
|
480
|
-
# * Object values
|
860
|
+
# * Object values can't include quote marks
|
481
861
|
#
|
482
862
|
# The following example shows the syntax for using `InputPathsMap` and
|
483
863
|
# `InputTemplate`.
|
@@ -518,10 +898,10 @@ module Aws::CloudWatchEvents
|
|
518
898
|
end
|
519
899
|
|
520
900
|
# This object enables you to specify a JSON path to extract from the
|
521
|
-
# event and use as the partition key for the Amazon Kinesis data stream
|
522
|
-
# so that you can control the shard
|
523
|
-
#
|
524
|
-
# partition key.
|
901
|
+
# event and use as the partition key for the Amazon Kinesis data stream
|
902
|
+
# so that you can control the shard that the event goes to. If you
|
903
|
+
# don't include this parameter, the default is to use the `eventId` as
|
904
|
+
# the partition key.
|
525
905
|
#
|
526
906
|
# @note When making an API call, you may pass KinesisParameters
|
527
907
|
# data as a hash:
|
@@ -547,11 +927,216 @@ module Aws::CloudWatchEvents
|
|
547
927
|
include Aws::Structure
|
548
928
|
end
|
549
929
|
|
930
|
+
# @note When making an API call, you may pass ListEventBusesRequest
|
931
|
+
# data as a hash:
|
932
|
+
#
|
933
|
+
# {
|
934
|
+
# name_prefix: "EventBusName",
|
935
|
+
# next_token: "NextToken",
|
936
|
+
# limit: 1,
|
937
|
+
# }
|
938
|
+
#
|
939
|
+
# @!attribute [rw] name_prefix
|
940
|
+
# Specifying this limits the results to only those event buses with
|
941
|
+
# names that start with the specified prefix.
|
942
|
+
# @return [String]
|
943
|
+
#
|
944
|
+
# @!attribute [rw] next_token
|
945
|
+
# The token returned by a previous call to retrieve the next set of
|
946
|
+
# results.
|
947
|
+
# @return [String]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] limit
|
950
|
+
# Specifying this limits the number of results returned by this
|
951
|
+
# operation. The operation also returns a `NextToken` that you can use
|
952
|
+
# in a subsequent operation to retrieve the next set of results.
|
953
|
+
# @return [Integer]
|
954
|
+
#
|
955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventBusesRequest AWS API Documentation
|
956
|
+
#
|
957
|
+
class ListEventBusesRequest < Struct.new(
|
958
|
+
:name_prefix,
|
959
|
+
:next_token,
|
960
|
+
:limit)
|
961
|
+
include Aws::Structure
|
962
|
+
end
|
963
|
+
|
964
|
+
# @!attribute [rw] event_buses
|
965
|
+
# This list of event buses.
|
966
|
+
# @return [Array<Types::EventBus>]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] next_token
|
969
|
+
# A token you can use in a subsequent operation to retrieve the next
|
970
|
+
# set of results.
|
971
|
+
# @return [String]
|
972
|
+
#
|
973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventBusesResponse AWS API Documentation
|
974
|
+
#
|
975
|
+
class ListEventBusesResponse < Struct.new(
|
976
|
+
:event_buses,
|
977
|
+
:next_token)
|
978
|
+
include Aws::Structure
|
979
|
+
end
|
980
|
+
|
981
|
+
# @note When making an API call, you may pass ListEventSourcesRequest
|
982
|
+
# data as a hash:
|
983
|
+
#
|
984
|
+
# {
|
985
|
+
# name_prefix: "EventSourceNamePrefix",
|
986
|
+
# next_token: "NextToken",
|
987
|
+
# limit: 1,
|
988
|
+
# }
|
989
|
+
#
|
990
|
+
# @!attribute [rw] name_prefix
|
991
|
+
# Specifying this limits the results to only those partner event
|
992
|
+
# sources with names that start with the specified prefix.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] next_token
|
996
|
+
# The token returned by a previous call to retrieve the next set of
|
997
|
+
# results.
|
998
|
+
# @return [String]
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] limit
|
1001
|
+
# Specifying this limits the number of results returned by this
|
1002
|
+
# operation. The operation also returns a `NextToken` that you can use
|
1003
|
+
# in a subsequent operation to retrieve the next set of results.
|
1004
|
+
# @return [Integer]
|
1005
|
+
#
|
1006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventSourcesRequest AWS API Documentation
|
1007
|
+
#
|
1008
|
+
class ListEventSourcesRequest < Struct.new(
|
1009
|
+
:name_prefix,
|
1010
|
+
:next_token,
|
1011
|
+
:limit)
|
1012
|
+
include Aws::Structure
|
1013
|
+
end
|
1014
|
+
|
1015
|
+
# @!attribute [rw] event_sources
|
1016
|
+
# The list of event sources.
|
1017
|
+
# @return [Array<Types::EventSource>]
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] next_token
|
1020
|
+
# A token you can use in a subsequent operation to retrieve the next
|
1021
|
+
# set of results.
|
1022
|
+
# @return [String]
|
1023
|
+
#
|
1024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventSourcesResponse AWS API Documentation
|
1025
|
+
#
|
1026
|
+
class ListEventSourcesResponse < Struct.new(
|
1027
|
+
:event_sources,
|
1028
|
+
:next_token)
|
1029
|
+
include Aws::Structure
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
# @note When making an API call, you may pass ListPartnerEventSourceAccountsRequest
|
1033
|
+
# data as a hash:
|
1034
|
+
#
|
1035
|
+
# {
|
1036
|
+
# event_source_name: "EventSourceName", # required
|
1037
|
+
# next_token: "NextToken",
|
1038
|
+
# limit: 1,
|
1039
|
+
# }
|
1040
|
+
#
|
1041
|
+
# @!attribute [rw] event_source_name
|
1042
|
+
# The name of the partner event source to display account information
|
1043
|
+
# about.
|
1044
|
+
# @return [String]
|
1045
|
+
#
|
1046
|
+
# @!attribute [rw] next_token
|
1047
|
+
# The token returned by a previous call to this operation. Specifying
|
1048
|
+
# this retrieves the next set of results.
|
1049
|
+
# @return [String]
|
1050
|
+
#
|
1051
|
+
# @!attribute [rw] limit
|
1052
|
+
# Specifying this limits the number of results returned by this
|
1053
|
+
# operation. The operation also returns a `NextToken` that you can use
|
1054
|
+
# in a subsequent operation to retrieve the next set of results.
|
1055
|
+
# @return [Integer]
|
1056
|
+
#
|
1057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSourceAccountsRequest AWS API Documentation
|
1058
|
+
#
|
1059
|
+
class ListPartnerEventSourceAccountsRequest < Struct.new(
|
1060
|
+
:event_source_name,
|
1061
|
+
:next_token,
|
1062
|
+
:limit)
|
1063
|
+
include Aws::Structure
|
1064
|
+
end
|
1065
|
+
|
1066
|
+
# @!attribute [rw] partner_event_source_accounts
|
1067
|
+
# The list of partner event sources returned by the operation.
|
1068
|
+
# @return [Array<Types::PartnerEventSourceAccount>]
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] next_token
|
1071
|
+
# A token you can use in a subsequent operation to retrieve the next
|
1072
|
+
# set of results.
|
1073
|
+
# @return [String]
|
1074
|
+
#
|
1075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSourceAccountsResponse AWS API Documentation
|
1076
|
+
#
|
1077
|
+
class ListPartnerEventSourceAccountsResponse < Struct.new(
|
1078
|
+
:partner_event_source_accounts,
|
1079
|
+
:next_token)
|
1080
|
+
include Aws::Structure
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
# @note When making an API call, you may pass ListPartnerEventSourcesRequest
|
1084
|
+
# data as a hash:
|
1085
|
+
#
|
1086
|
+
# {
|
1087
|
+
# name_prefix: "PartnerEventSourceNamePrefix", # required
|
1088
|
+
# next_token: "NextToken",
|
1089
|
+
# limit: 1,
|
1090
|
+
# }
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] name_prefix
|
1093
|
+
# If you specify this, the results are limited to only those partner
|
1094
|
+
# event sources that start with the string you specify.
|
1095
|
+
# @return [String]
|
1096
|
+
#
|
1097
|
+
# @!attribute [rw] next_token
|
1098
|
+
# The token returned by a previous call to this operation. Specifying
|
1099
|
+
# this retrieves the next set of results.
|
1100
|
+
# @return [String]
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] limit
|
1103
|
+
# pecifying this limits the number of results returned by this
|
1104
|
+
# operation. The operation also returns a `NextToken` that you can use
|
1105
|
+
# in a subsequent operation to retrieve the next set of results.
|
1106
|
+
# @return [Integer]
|
1107
|
+
#
|
1108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSourcesRequest AWS API Documentation
|
1109
|
+
#
|
1110
|
+
class ListPartnerEventSourcesRequest < Struct.new(
|
1111
|
+
:name_prefix,
|
1112
|
+
:next_token,
|
1113
|
+
:limit)
|
1114
|
+
include Aws::Structure
|
1115
|
+
end
|
1116
|
+
|
1117
|
+
# @!attribute [rw] partner_event_sources
|
1118
|
+
# The list of partner event sources returned by the operation.
|
1119
|
+
# @return [Array<Types::PartnerEventSource>]
|
1120
|
+
#
|
1121
|
+
# @!attribute [rw] next_token
|
1122
|
+
# A token you can use in a subsequent operation to retrieve the next
|
1123
|
+
# set of results.
|
1124
|
+
# @return [String]
|
1125
|
+
#
|
1126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSourcesResponse AWS API Documentation
|
1127
|
+
#
|
1128
|
+
class ListPartnerEventSourcesResponse < Struct.new(
|
1129
|
+
:partner_event_sources,
|
1130
|
+
:next_token)
|
1131
|
+
include Aws::Structure
|
1132
|
+
end
|
1133
|
+
|
550
1134
|
# @note When making an API call, you may pass ListRuleNamesByTargetRequest
|
551
1135
|
# data as a hash:
|
552
1136
|
#
|
553
1137
|
# {
|
554
1138
|
# target_arn: "TargetArn", # required
|
1139
|
+
# event_bus_name: "EventBusName",
|
555
1140
|
# next_token: "NextToken",
|
556
1141
|
# limit: 1,
|
557
1142
|
# }
|
@@ -560,6 +1145,11 @@ module Aws::CloudWatchEvents
|
|
560
1145
|
# The Amazon Resource Name (ARN) of the target resource.
|
561
1146
|
# @return [String]
|
562
1147
|
#
|
1148
|
+
# @!attribute [rw] event_bus_name
|
1149
|
+
# Limits the results to show only the rules associated with the
|
1150
|
+
# specified event bus.
|
1151
|
+
# @return [String]
|
1152
|
+
#
|
563
1153
|
# @!attribute [rw] next_token
|
564
1154
|
# The token returned by a previous call to retrieve the next set of
|
565
1155
|
# results.
|
@@ -573,6 +1163,7 @@ module Aws::CloudWatchEvents
|
|
573
1163
|
#
|
574
1164
|
class ListRuleNamesByTargetRequest < Struct.new(
|
575
1165
|
:target_arn,
|
1166
|
+
:event_bus_name,
|
576
1167
|
:next_token,
|
577
1168
|
:limit)
|
578
1169
|
include Aws::Structure
|
@@ -600,6 +1191,7 @@ module Aws::CloudWatchEvents
|
|
600
1191
|
#
|
601
1192
|
# {
|
602
1193
|
# name_prefix: "RuleName",
|
1194
|
+
# event_bus_name: "EventBusName",
|
603
1195
|
# next_token: "NextToken",
|
604
1196
|
# limit: 1,
|
605
1197
|
# }
|
@@ -608,6 +1200,11 @@ module Aws::CloudWatchEvents
|
|
608
1200
|
# The prefix matching the rule name.
|
609
1201
|
# @return [String]
|
610
1202
|
#
|
1203
|
+
# @!attribute [rw] event_bus_name
|
1204
|
+
# Limits the results to show only the rules associated with the
|
1205
|
+
# specified event bus.
|
1206
|
+
# @return [String]
|
1207
|
+
#
|
611
1208
|
# @!attribute [rw] next_token
|
612
1209
|
# The token returned by a previous call to retrieve the next set of
|
613
1210
|
# results.
|
@@ -621,6 +1218,7 @@ module Aws::CloudWatchEvents
|
|
621
1218
|
#
|
622
1219
|
class ListRulesRequest < Struct.new(
|
623
1220
|
:name_prefix,
|
1221
|
+
:event_bus_name,
|
624
1222
|
:next_token,
|
625
1223
|
:limit)
|
626
1224
|
include Aws::Structure
|
@@ -651,8 +1249,7 @@ module Aws::CloudWatchEvents
|
|
651
1249
|
# }
|
652
1250
|
#
|
653
1251
|
# @!attribute [rw] resource_arn
|
654
|
-
# The ARN of the
|
655
|
-
# tags.
|
1252
|
+
# The ARN of the rule for which you want to view tags.
|
656
1253
|
# @return [String]
|
657
1254
|
#
|
658
1255
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTagsForResourceRequest AWS API Documentation
|
@@ -663,8 +1260,8 @@ module Aws::CloudWatchEvents
|
|
663
1260
|
end
|
664
1261
|
|
665
1262
|
# @!attribute [rw] tags
|
666
|
-
# The list of tag keys and values associated with the rule you
|
667
|
-
# specified
|
1263
|
+
# The list of tag keys and values associated with the rule that you
|
1264
|
+
# specified.
|
668
1265
|
# @return [Array<Types::Tag>]
|
669
1266
|
#
|
670
1267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTagsForResourceResponse AWS API Documentation
|
@@ -679,6 +1276,7 @@ module Aws::CloudWatchEvents
|
|
679
1276
|
#
|
680
1277
|
# {
|
681
1278
|
# rule: "RuleName", # required
|
1279
|
+
# event_bus_name: "EventBusName",
|
682
1280
|
# next_token: "NextToken",
|
683
1281
|
# limit: 1,
|
684
1282
|
# }
|
@@ -687,6 +1285,11 @@ module Aws::CloudWatchEvents
|
|
687
1285
|
# The name of the rule.
|
688
1286
|
# @return [String]
|
689
1287
|
#
|
1288
|
+
# @!attribute [rw] event_bus_name
|
1289
|
+
# The event bus associated with the rule. If you omit this, the
|
1290
|
+
# default event bus is used.
|
1291
|
+
# @return [String]
|
1292
|
+
#
|
690
1293
|
# @!attribute [rw] next_token
|
691
1294
|
# The token returned by a previous call to retrieve the next set of
|
692
1295
|
# results.
|
@@ -700,6 +1303,7 @@ module Aws::CloudWatchEvents
|
|
700
1303
|
#
|
701
1304
|
class ListTargetsByRuleRequest < Struct.new(
|
702
1305
|
:rule,
|
1306
|
+
:event_bus_name,
|
703
1307
|
:next_token,
|
704
1308
|
:limit)
|
705
1309
|
include Aws::Structure
|
@@ -737,7 +1341,7 @@ module Aws::CloudWatchEvents
|
|
737
1341
|
#
|
738
1342
|
# @!attribute [rw] awsvpc_configuration
|
739
1343
|
# Use this structure to specify the VPC subnets and security groups
|
740
|
-
# for the task
|
1344
|
+
# for the task and whether a public IP address is to be used. This
|
741
1345
|
# structure is relevant only for ECS tasks that use the `awsvpc`
|
742
1346
|
# network mode.
|
743
1347
|
# @return [Types::AwsVpcConfiguration]
|
@@ -749,6 +1353,61 @@ module Aws::CloudWatchEvents
|
|
749
1353
|
include Aws::Structure
|
750
1354
|
end
|
751
1355
|
|
1356
|
+
# A partner event source is created by an SaaS partner. If a customer
|
1357
|
+
# creates a partner event bus that matches this event source, that AWS
|
1358
|
+
# account can receive events from the partner's applications or
|
1359
|
+
# services.
|
1360
|
+
#
|
1361
|
+
# @!attribute [rw] arn
|
1362
|
+
# The ARN of the partner event source.
|
1363
|
+
# @return [String]
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] name
|
1366
|
+
# The name of the partner event source.
|
1367
|
+
# @return [String]
|
1368
|
+
#
|
1369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PartnerEventSource AWS API Documentation
|
1370
|
+
#
|
1371
|
+
class PartnerEventSource < Struct.new(
|
1372
|
+
:arn,
|
1373
|
+
:name)
|
1374
|
+
include Aws::Structure
|
1375
|
+
end
|
1376
|
+
|
1377
|
+
# The AWS account that a partner event source has been offered to.
|
1378
|
+
#
|
1379
|
+
# @!attribute [rw] account
|
1380
|
+
# The AWS account ID that the partner event source was offered to.
|
1381
|
+
# @return [String]
|
1382
|
+
#
|
1383
|
+
# @!attribute [rw] creation_time
|
1384
|
+
# The date and time when the event source was created.
|
1385
|
+
# @return [Time]
|
1386
|
+
#
|
1387
|
+
# @!attribute [rw] expiration_time
|
1388
|
+
# The date and time when the event source will expire if the AWS
|
1389
|
+
# account doesn't create a matching event bus for it.
|
1390
|
+
# @return [Time]
|
1391
|
+
#
|
1392
|
+
# @!attribute [rw] state
|
1393
|
+
# The state of the event source. If it's `ACTIVE`, you have already
|
1394
|
+
# created a matching event bus for this event source, and that event
|
1395
|
+
# bus is active. If it's `PENDING`, either you haven't yet created a
|
1396
|
+
# matching event bus, or that event bus is deactivated. If it's
|
1397
|
+
# `DELETED`, you have created a matching event bus, but the event
|
1398
|
+
# source has since been deleted.
|
1399
|
+
# @return [String]
|
1400
|
+
#
|
1401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PartnerEventSourceAccount AWS API Documentation
|
1402
|
+
#
|
1403
|
+
class PartnerEventSourceAccount < Struct.new(
|
1404
|
+
:account,
|
1405
|
+
:creation_time,
|
1406
|
+
:expiration_time,
|
1407
|
+
:state)
|
1408
|
+
include Aws::Structure
|
1409
|
+
end
|
1410
|
+
|
752
1411
|
# @note When making an API call, you may pass PutEventsRequest
|
753
1412
|
# data as a hash:
|
754
1413
|
#
|
@@ -760,6 +1419,7 @@ module Aws::CloudWatchEvents
|
|
760
1419
|
# resources: ["EventResource"],
|
761
1420
|
# detail_type: "String",
|
762
1421
|
# detail: "String",
|
1422
|
+
# event_bus_name: "NonPartnerEventBusName",
|
763
1423
|
# },
|
764
1424
|
# ],
|
765
1425
|
# }
|
@@ -788,11 +1448,12 @@ module Aws::CloudWatchEvents
|
|
788
1448
|
# resources: ["EventResource"],
|
789
1449
|
# detail_type: "String",
|
790
1450
|
# detail: "String",
|
1451
|
+
# event_bus_name: "NonPartnerEventBusName",
|
791
1452
|
# }
|
792
1453
|
#
|
793
1454
|
# @!attribute [rw] time
|
794
|
-
# The
|
795
|
-
# provided, the
|
1455
|
+
# The timestamp of the event, per [RFC3339][1]. If no timestamp is
|
1456
|
+
# provided, the timestamp of the PutEvents call is used.
|
796
1457
|
#
|
797
1458
|
#
|
798
1459
|
#
|
@@ -804,19 +1465,24 @@ module Aws::CloudWatchEvents
|
|
804
1465
|
# @return [String]
|
805
1466
|
#
|
806
1467
|
# @!attribute [rw] resources
|
807
|
-
# AWS resources, identified by Amazon Resource Name (ARN),
|
808
|
-
# event primarily concerns. Any number, including zero,
|
1468
|
+
# AWS resources, identified by Amazon Resource Name (ARN), that the
|
1469
|
+
# event primarily concerns. Any number, including zero, can be
|
809
1470
|
# present.
|
810
1471
|
# @return [Array<String>]
|
811
1472
|
#
|
812
1473
|
# @!attribute [rw] detail_type
|
813
|
-
# Free-form string used to decide
|
1474
|
+
# Free-form string used to decide which fields to expect in the event
|
814
1475
|
# detail.
|
815
1476
|
# @return [String]
|
816
1477
|
#
|
817
1478
|
# @!attribute [rw] detail
|
818
1479
|
# A valid JSON string. There is no other schema imposed. The JSON
|
819
|
-
# string
|
1480
|
+
# string can contain fields and nested subobjects.
|
1481
|
+
# @return [String]
|
1482
|
+
#
|
1483
|
+
# @!attribute [rw] event_bus_name
|
1484
|
+
# The event bus that will receive the event. Only the rules that are
|
1485
|
+
# associated with this event bus can match the event.
|
820
1486
|
# @return [String]
|
821
1487
|
#
|
822
1488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutEventsRequestEntry AWS API Documentation
|
@@ -826,7 +1492,8 @@ module Aws::CloudWatchEvents
|
|
826
1492
|
:source,
|
827
1493
|
:resources,
|
828
1494
|
:detail_type,
|
829
|
-
:detail
|
1495
|
+
:detail,
|
1496
|
+
:event_bus_name)
|
830
1497
|
include Aws::Structure
|
831
1498
|
end
|
832
1499
|
|
@@ -872,10 +1539,126 @@ module Aws::CloudWatchEvents
|
|
872
1539
|
include Aws::Structure
|
873
1540
|
end
|
874
1541
|
|
1542
|
+
# @note When making an API call, you may pass PutPartnerEventsRequest
|
1543
|
+
# data as a hash:
|
1544
|
+
#
|
1545
|
+
# {
|
1546
|
+
# entries: [ # required
|
1547
|
+
# {
|
1548
|
+
# time: Time.now,
|
1549
|
+
# source: "String",
|
1550
|
+
# resources: ["EventResource"],
|
1551
|
+
# detail_type: "String",
|
1552
|
+
# detail: "String",
|
1553
|
+
# },
|
1554
|
+
# ],
|
1555
|
+
# }
|
1556
|
+
#
|
1557
|
+
# @!attribute [rw] entries
|
1558
|
+
# The list of events to write to the event bus.
|
1559
|
+
# @return [Array<Types::PutPartnerEventsRequestEntry>]
|
1560
|
+
#
|
1561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPartnerEventsRequest AWS API Documentation
|
1562
|
+
#
|
1563
|
+
class PutPartnerEventsRequest < Struct.new(
|
1564
|
+
:entries)
|
1565
|
+
include Aws::Structure
|
1566
|
+
end
|
1567
|
+
|
1568
|
+
# The details about an event generated by an SaaS partner.
|
1569
|
+
#
|
1570
|
+
# @note When making an API call, you may pass PutPartnerEventsRequestEntry
|
1571
|
+
# data as a hash:
|
1572
|
+
#
|
1573
|
+
# {
|
1574
|
+
# time: Time.now,
|
1575
|
+
# source: "String",
|
1576
|
+
# resources: ["EventResource"],
|
1577
|
+
# detail_type: "String",
|
1578
|
+
# detail: "String",
|
1579
|
+
# }
|
1580
|
+
#
|
1581
|
+
# @!attribute [rw] time
|
1582
|
+
# The date and time of the event.
|
1583
|
+
# @return [Time]
|
1584
|
+
#
|
1585
|
+
# @!attribute [rw] source
|
1586
|
+
# The event source that is generating the evntry.
|
1587
|
+
# @return [String]
|
1588
|
+
#
|
1589
|
+
# @!attribute [rw] resources
|
1590
|
+
# AWS resources, identified by Amazon Resource Name (ARN), that the
|
1591
|
+
# event primarily concerns. Any number, including zero, can be
|
1592
|
+
# present.
|
1593
|
+
# @return [Array<String>]
|
1594
|
+
#
|
1595
|
+
# @!attribute [rw] detail_type
|
1596
|
+
# A free-form string used to decide which fields to expect in the
|
1597
|
+
# event detail.
|
1598
|
+
# @return [String]
|
1599
|
+
#
|
1600
|
+
# @!attribute [rw] detail
|
1601
|
+
# A valid JSON string. There is no other schema imposed. The JSON
|
1602
|
+
# string can contain fields and nested subobjects.
|
1603
|
+
# @return [String]
|
1604
|
+
#
|
1605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPartnerEventsRequestEntry AWS API Documentation
|
1606
|
+
#
|
1607
|
+
class PutPartnerEventsRequestEntry < Struct.new(
|
1608
|
+
:time,
|
1609
|
+
:source,
|
1610
|
+
:resources,
|
1611
|
+
:detail_type,
|
1612
|
+
:detail)
|
1613
|
+
include Aws::Structure
|
1614
|
+
end
|
1615
|
+
|
1616
|
+
# @!attribute [rw] failed_entry_count
|
1617
|
+
# The number of events from this operation that couldn't be written
|
1618
|
+
# to the partner event bus.
|
1619
|
+
# @return [Integer]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] entries
|
1622
|
+
# The list of events from this operation that were successfully
|
1623
|
+
# written to the partner event bus.
|
1624
|
+
# @return [Array<Types::PutPartnerEventsResultEntry>]
|
1625
|
+
#
|
1626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPartnerEventsResponse AWS API Documentation
|
1627
|
+
#
|
1628
|
+
class PutPartnerEventsResponse < Struct.new(
|
1629
|
+
:failed_entry_count,
|
1630
|
+
:entries)
|
1631
|
+
include Aws::Structure
|
1632
|
+
end
|
1633
|
+
|
1634
|
+
# Represents an event that a partner tried to generate but failed.
|
1635
|
+
#
|
1636
|
+
# @!attribute [rw] event_id
|
1637
|
+
# The ID of the event.
|
1638
|
+
# @return [String]
|
1639
|
+
#
|
1640
|
+
# @!attribute [rw] error_code
|
1641
|
+
# The error code that indicates why the event submission failed.
|
1642
|
+
# @return [String]
|
1643
|
+
#
|
1644
|
+
# @!attribute [rw] error_message
|
1645
|
+
# The error message that explains why the event submission failed.
|
1646
|
+
# @return [String]
|
1647
|
+
#
|
1648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPartnerEventsResultEntry AWS API Documentation
|
1649
|
+
#
|
1650
|
+
class PutPartnerEventsResultEntry < Struct.new(
|
1651
|
+
:event_id,
|
1652
|
+
:error_code,
|
1653
|
+
:error_message)
|
1654
|
+
include Aws::Structure
|
1655
|
+
end
|
1656
|
+
|
875
1657
|
# @note When making an API call, you may pass PutPermissionRequest
|
876
1658
|
# data as a hash:
|
877
1659
|
#
|
878
1660
|
# {
|
1661
|
+
# event_bus_name: "NonPartnerEventBusName",
|
879
1662
|
# action: "Action", # required
|
880
1663
|
# principal: "Principal", # required
|
881
1664
|
# statement_id: "StatementId", # required
|
@@ -886,8 +1669,13 @@ module Aws::CloudWatchEvents
|
|
886
1669
|
# },
|
887
1670
|
# }
|
888
1671
|
#
|
1672
|
+
# @!attribute [rw] event_bus_name
|
1673
|
+
# The event bus associated with the rule. If you omit this, the
|
1674
|
+
# default event bus is used.
|
1675
|
+
# @return [String]
|
1676
|
+
#
|
889
1677
|
# @!attribute [rw] action
|
890
|
-
# The action that you
|
1678
|
+
# The action that you're enabling the other account to perform.
|
891
1679
|
# Currently, this must be `events:PutEvents`.
|
892
1680
|
# @return [String]
|
893
1681
|
#
|
@@ -897,15 +1685,15 @@ module Aws::CloudWatchEvents
|
|
897
1685
|
# events to your default event bus.
|
898
1686
|
#
|
899
1687
|
# If you specify "*" without specifying `Condition`, avoid creating
|
900
|
-
# rules that
|
1688
|
+
# rules that might match undesirable events. To create more secure
|
901
1689
|
# rules, make sure that the event pattern for each rule contains an
|
902
|
-
# `account` field with a specific account ID
|
903
|
-
#
|
904
|
-
#
|
1690
|
+
# `account` field with a specific account ID to receive events from.
|
1691
|
+
# Rules with an account field don't match any events sent from other
|
1692
|
+
# accounts.
|
905
1693
|
# @return [String]
|
906
1694
|
#
|
907
1695
|
# @!attribute [rw] statement_id
|
908
|
-
# An identifier string for the external account that you
|
1696
|
+
# An identifier string for the external account that you're granting
|
909
1697
|
# permissions to. If you later want to revoke the permission for this
|
910
1698
|
# external account, specify this `StatementId` when you run
|
911
1699
|
# RemovePermission.
|
@@ -915,14 +1703,14 @@ module Aws::CloudWatchEvents
|
|
915
1703
|
# This parameter enables you to limit the permission to accounts that
|
916
1704
|
# fulfill a certain condition, such as being a member of a certain AWS
|
917
1705
|
# organization. For more information about AWS Organizations, see
|
918
|
-
# [What Is AWS Organizations][1] in the *AWS Organizations User
|
1706
|
+
# [What Is AWS Organizations?][1] in the *AWS Organizations User
|
919
1707
|
# Guide*.
|
920
1708
|
#
|
921
|
-
# If you specify `Condition` with an AWS organization ID
|
1709
|
+
# If you specify `Condition` with an AWS organization ID and specify
|
922
1710
|
# "*" as the value for `Principal`, you grant permission to all the
|
923
1711
|
# accounts in the named organization.
|
924
1712
|
#
|
925
|
-
# The `Condition` is a JSON string
|
1713
|
+
# The `Condition` is a JSON string that must contain `Type`, `Key`,
|
926
1714
|
# and `Value` fields.
|
927
1715
|
#
|
928
1716
|
#
|
@@ -933,6 +1721,7 @@ module Aws::CloudWatchEvents
|
|
933
1721
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPermissionRequest AWS API Documentation
|
934
1722
|
#
|
935
1723
|
class PutPermissionRequest < Struct.new(
|
1724
|
+
:event_bus_name,
|
936
1725
|
:action,
|
937
1726
|
:principal,
|
938
1727
|
:statement_id,
|
@@ -956,24 +1745,25 @@ module Aws::CloudWatchEvents
|
|
956
1745
|
# value: "TagValue", # required
|
957
1746
|
# },
|
958
1747
|
# ],
|
1748
|
+
# event_bus_name: "EventBusName",
|
959
1749
|
# }
|
960
1750
|
#
|
961
1751
|
# @!attribute [rw] name
|
962
|
-
# The name of the rule that you
|
1752
|
+
# The name of the rule that you're creating or updating.
|
963
1753
|
# @return [String]
|
964
1754
|
#
|
965
1755
|
# @!attribute [rw] schedule_expression
|
966
|
-
# The scheduling expression
|
967
|
-
# "rate(5 minutes)"
|
1756
|
+
# The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
|
1757
|
+
# `"rate(5 minutes)"`.
|
968
1758
|
# @return [String]
|
969
1759
|
#
|
970
1760
|
# @!attribute [rw] event_pattern
|
971
|
-
# The event pattern. For more information, see [
|
972
|
-
#
|
1761
|
+
# The event pattern. For more information, see [Event Patterns][1] in
|
1762
|
+
# the *Amazon EventBridge User Guide*.
|
973
1763
|
#
|
974
1764
|
#
|
975
1765
|
#
|
976
|
-
# [1]: https://docs.aws.amazon.com/
|
1766
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
|
977
1767
|
# @return [String]
|
978
1768
|
#
|
979
1769
|
# @!attribute [rw] state
|
@@ -993,6 +1783,11 @@ module Aws::CloudWatchEvents
|
|
993
1783
|
# The list of key-value pairs to associate with the rule.
|
994
1784
|
# @return [Array<Types::Tag>]
|
995
1785
|
#
|
1786
|
+
# @!attribute [rw] event_bus_name
|
1787
|
+
# The event bus to associate with this rule. If you omit this, the
|
1788
|
+
# default event bus is used.
|
1789
|
+
# @return [String]
|
1790
|
+
#
|
996
1791
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutRuleRequest AWS API Documentation
|
997
1792
|
#
|
998
1793
|
class PutRuleRequest < Struct.new(
|
@@ -1002,7 +1797,8 @@ module Aws::CloudWatchEvents
|
|
1002
1797
|
:state,
|
1003
1798
|
:description,
|
1004
1799
|
:role_arn,
|
1005
|
-
:tags
|
1800
|
+
:tags,
|
1801
|
+
:event_bus_name)
|
1006
1802
|
include Aws::Structure
|
1007
1803
|
end
|
1008
1804
|
|
@@ -1022,6 +1818,7 @@ module Aws::CloudWatchEvents
|
|
1022
1818
|
#
|
1023
1819
|
# {
|
1024
1820
|
# rule: "RuleName", # required
|
1821
|
+
# event_bus_name: "EventBusName",
|
1025
1822
|
# targets: [ # required
|
1026
1823
|
# {
|
1027
1824
|
# id: "TargetId", # required
|
@@ -1081,6 +1878,11 @@ module Aws::CloudWatchEvents
|
|
1081
1878
|
# The name of the rule.
|
1082
1879
|
# @return [String]
|
1083
1880
|
#
|
1881
|
+
# @!attribute [rw] event_bus_name
|
1882
|
+
# The name of the event bus associated with the rule. If you omit
|
1883
|
+
# this, the default event bus is used.
|
1884
|
+
# @return [String]
|
1885
|
+
#
|
1084
1886
|
# @!attribute [rw] targets
|
1085
1887
|
# The targets to update or add to the rule.
|
1086
1888
|
# @return [Array<Types::Target>]
|
@@ -1089,6 +1891,7 @@ module Aws::CloudWatchEvents
|
|
1089
1891
|
#
|
1090
1892
|
class PutTargetsRequest < Struct.new(
|
1091
1893
|
:rule,
|
1894
|
+
:event_bus_name,
|
1092
1895
|
:targets)
|
1093
1896
|
include Aws::Structure
|
1094
1897
|
end
|
@@ -1139,6 +1942,7 @@ module Aws::CloudWatchEvents
|
|
1139
1942
|
#
|
1140
1943
|
# {
|
1141
1944
|
# statement_id: "StatementId", # required
|
1945
|
+
# event_bus_name: "NonPartnerEventBusName",
|
1142
1946
|
# }
|
1143
1947
|
#
|
1144
1948
|
# @!attribute [rw] statement_id
|
@@ -1146,10 +1950,16 @@ module Aws::CloudWatchEvents
|
|
1146
1950
|
# allowed to put events to the default event bus.
|
1147
1951
|
# @return [String]
|
1148
1952
|
#
|
1953
|
+
# @!attribute [rw] event_bus_name
|
1954
|
+
# The name of the event bus to revoke permissions for. If you omit
|
1955
|
+
# this, the default event bus is used.
|
1956
|
+
# @return [String]
|
1957
|
+
#
|
1149
1958
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemovePermissionRequest AWS API Documentation
|
1150
1959
|
#
|
1151
1960
|
class RemovePermissionRequest < Struct.new(
|
1152
|
-
:statement_id
|
1961
|
+
:statement_id,
|
1962
|
+
:event_bus_name)
|
1153
1963
|
include Aws::Structure
|
1154
1964
|
end
|
1155
1965
|
|
@@ -1158,6 +1968,7 @@ module Aws::CloudWatchEvents
|
|
1158
1968
|
#
|
1159
1969
|
# {
|
1160
1970
|
# rule: "RuleName", # required
|
1971
|
+
# event_bus_name: "EventBusName",
|
1161
1972
|
# ids: ["TargetId"], # required
|
1162
1973
|
# force: false,
|
1163
1974
|
# }
|
@@ -1166,14 +1977,18 @@ module Aws::CloudWatchEvents
|
|
1166
1977
|
# The name of the rule.
|
1167
1978
|
# @return [String]
|
1168
1979
|
#
|
1980
|
+
# @!attribute [rw] event_bus_name
|
1981
|
+
# The name of the event bus associated with the rule.
|
1982
|
+
# @return [String]
|
1983
|
+
#
|
1169
1984
|
# @!attribute [rw] ids
|
1170
1985
|
# The IDs of the targets to remove from the rule.
|
1171
1986
|
# @return [Array<String>]
|
1172
1987
|
#
|
1173
1988
|
# @!attribute [rw] force
|
1174
|
-
# If this is a managed rule
|
1989
|
+
# If this is a managed rule created by an AWS service on your behalf,
|
1175
1990
|
# you must specify `Force` as `True` to remove targets. This parameter
|
1176
|
-
# is ignored for rules that
|
1991
|
+
# is ignored for rules that aren't managed rules. You can check
|
1177
1992
|
# whether a rule is a managed rule by using `DescribeRule` or
|
1178
1993
|
# `ListRules` and checking the `ManagedBy` field of the response.
|
1179
1994
|
# @return [Boolean]
|
@@ -1182,6 +1997,7 @@ module Aws::CloudWatchEvents
|
|
1182
1997
|
#
|
1183
1998
|
class RemoveTargetsRequest < Struct.new(
|
1184
1999
|
:rule,
|
2000
|
+
:event_bus_name,
|
1185
2001
|
:ids,
|
1186
2002
|
:force)
|
1187
2003
|
include Aws::Structure
|
@@ -1228,7 +2044,7 @@ module Aws::CloudWatchEvents
|
|
1228
2044
|
include Aws::Structure
|
1229
2045
|
end
|
1230
2046
|
|
1231
|
-
# Contains information about a rule in Amazon
|
2047
|
+
# Contains information about a rule in Amazon EventBridge.
|
1232
2048
|
#
|
1233
2049
|
# @!attribute [rw] name
|
1234
2050
|
# The name of the rule.
|
@@ -1239,12 +2055,12 @@ module Aws::CloudWatchEvents
|
|
1239
2055
|
# @return [String]
|
1240
2056
|
#
|
1241
2057
|
# @!attribute [rw] event_pattern
|
1242
|
-
# The event pattern of the rule. For more information, see [
|
1243
|
-
#
|
2058
|
+
# The event pattern of the rule. For more information, see [Event
|
2059
|
+
# Patterns][1] in the *Amazon EventBridge User Guide*.
|
1244
2060
|
#
|
1245
2061
|
#
|
1246
2062
|
#
|
1247
|
-
# [1]: https://docs.aws.amazon.com/
|
2063
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
|
1248
2064
|
# @return [String]
|
1249
2065
|
#
|
1250
2066
|
# @!attribute [rw] state
|
@@ -1256,8 +2072,8 @@ module Aws::CloudWatchEvents
|
|
1256
2072
|
# @return [String]
|
1257
2073
|
#
|
1258
2074
|
# @!attribute [rw] schedule_expression
|
1259
|
-
# The scheduling expression
|
1260
|
-
# "rate(5 minutes)"
|
2075
|
+
# The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
|
2076
|
+
# `"rate(5 minutes)"`.
|
1261
2077
|
# @return [String]
|
1262
2078
|
#
|
1263
2079
|
# @!attribute [rw] role_arn
|
@@ -1266,9 +2082,13 @@ module Aws::CloudWatchEvents
|
|
1266
2082
|
# @return [String]
|
1267
2083
|
#
|
1268
2084
|
# @!attribute [rw] managed_by
|
1269
|
-
# If
|
1270
|
-
#
|
1271
|
-
#
|
2085
|
+
# If an AWS service created the rule on behalf of your account, this
|
2086
|
+
# field displays the principal name of the service that created the
|
2087
|
+
# rule.
|
2088
|
+
# @return [String]
|
2089
|
+
#
|
2090
|
+
# @!attribute [rw] event_bus_name
|
2091
|
+
# The event bus associated with the rule.
|
1272
2092
|
# @return [String]
|
1273
2093
|
#
|
1274
2094
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Rule AWS API Documentation
|
@@ -1281,11 +2101,12 @@ module Aws::CloudWatchEvents
|
|
1281
2101
|
:description,
|
1282
2102
|
:schedule_expression,
|
1283
2103
|
:role_arn,
|
1284
|
-
:managed_by
|
2104
|
+
:managed_by,
|
2105
|
+
:event_bus_name)
|
1285
2106
|
include Aws::Structure
|
1286
2107
|
end
|
1287
2108
|
|
1288
|
-
# This parameter contains the criteria (either InstanceIds or a tag)
|
2109
|
+
# This parameter contains the criteria (either `InstanceIds` or a tag)
|
1289
2110
|
# used to specify which EC2 instances are to be sent the command.
|
1290
2111
|
#
|
1291
2112
|
# @note When making an API call, you may pass RunCommandParameters
|
@@ -1301,8 +2122,8 @@ module Aws::CloudWatchEvents
|
|
1301
2122
|
# }
|
1302
2123
|
#
|
1303
2124
|
# @!attribute [rw] run_command_targets
|
1304
|
-
# Currently, we support including only one RunCommandTarget block,
|
1305
|
-
# which specifies either an array of InstanceIds or a tag.
|
2125
|
+
# Currently, we support including only one `RunCommandTarget` block,
|
2126
|
+
# which specifies either an array of `InstanceIds` or a tag.
|
1306
2127
|
# @return [Array<Types::RunCommandTarget>]
|
1307
2128
|
#
|
1308
2129
|
# @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RunCommandParameters AWS API Documentation
|
@@ -1314,7 +2135,7 @@ module Aws::CloudWatchEvents
|
|
1314
2135
|
|
1315
2136
|
# Information about the EC2 instances that are to be sent the command,
|
1316
2137
|
# specified as key-value pairs. Each `RunCommandTarget` block can
|
1317
|
-
# include only one key, but this key
|
2138
|
+
# include only one key, but this key can specify multiple values.
|
1318
2139
|
#
|
1319
2140
|
# @note When making an API call, you may pass RunCommandTarget
|
1320
2141
|
# data as a hash:
|
@@ -1363,8 +2184,8 @@ module Aws::CloudWatchEvents
|
|
1363
2184
|
include Aws::Structure
|
1364
2185
|
end
|
1365
2186
|
|
1366
|
-
# A key-value pair associated with an AWS resource. In
|
1367
|
-
#
|
2187
|
+
# A key-value pair associated with an AWS resource. In EventBridge,
|
2188
|
+
# rules support tagging.
|
1368
2189
|
#
|
1369
2190
|
# @note When making an API call, you may pass Tag
|
1370
2191
|
# data as a hash:
|
@@ -1375,8 +2196,8 @@ module Aws::CloudWatchEvents
|
|
1375
2196
|
# }
|
1376
2197
|
#
|
1377
2198
|
# @!attribute [rw] key
|
1378
|
-
# A string you can use to assign a value. The combination of tag
|
1379
|
-
# and values can help you organize and categorize your resources.
|
2199
|
+
# A string that you can use to assign a value. The combination of tag
|
2200
|
+
# keys and values can help you organize and categorize your resources.
|
1380
2201
|
# @return [String]
|
1381
2202
|
#
|
1382
2203
|
# @!attribute [rw] value
|
@@ -1405,7 +2226,7 @@ module Aws::CloudWatchEvents
|
|
1405
2226
|
# }
|
1406
2227
|
#
|
1407
2228
|
# @!attribute [rw] resource_arn
|
1408
|
-
# The ARN of the
|
2229
|
+
# The ARN of the rule that you're adding tags to.
|
1409
2230
|
# @return [String]
|
1410
2231
|
#
|
1411
2232
|
# @!attribute [rw] tags
|
@@ -1428,16 +2249,16 @@ module Aws::CloudWatchEvents
|
|
1428
2249
|
# a complete list of services and resources that can be set as a target,
|
1429
2250
|
# see PutTargets.
|
1430
2251
|
#
|
1431
|
-
# If you
|
2252
|
+
# If you're setting the event bus of another account as the target and
|
1432
2253
|
# that account granted permission to your account through an
|
1433
|
-
# organization instead of directly by the account ID,
|
1434
|
-
#
|
1435
|
-
#
|
1436
|
-
# Accounts][1] in the *Amazon
|
2254
|
+
# organization instead of directly by the account ID, you must specify a
|
2255
|
+
# `RoleArn` with proper permissions in the `Target` structure. For more
|
2256
|
+
# information, see [Sending and Receiving Events Between AWS
|
2257
|
+
# Accounts][1] in the *Amazon EventBridge User Guide*.
|
1437
2258
|
#
|
1438
2259
|
#
|
1439
2260
|
#
|
1440
|
-
# [1]: https://docs.aws.amazon.com/
|
2261
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
|
1441
2262
|
#
|
1442
2263
|
# @note When making an API call, you may pass Target
|
1443
2264
|
# data as a hash:
|
@@ -1537,9 +2358,10 @@ module Aws::CloudWatchEvents
|
|
1537
2358
|
# @return [Types::InputTransformer]
|
1538
2359
|
#
|
1539
2360
|
# @!attribute [rw] kinesis_parameters
|
1540
|
-
# The custom parameter you can use to control the shard
|
1541
|
-
# when the target is a Kinesis data stream. If you
|
1542
|
-
# parameter, the default is to use the `eventId` as the
|
2361
|
+
# The custom parameter that you can use to control the shard
|
2362
|
+
# assignment when the target is a Kinesis data stream. If you don't
|
2363
|
+
# include this parameter, the default is to use the `eventId` as the
|
2364
|
+
# partition key.
|
1543
2365
|
# @return [Types::KinesisParameters]
|
1544
2366
|
#
|
1545
2367
|
# @!attribute [rw] run_command_parameters
|
@@ -1548,10 +2370,10 @@ module Aws::CloudWatchEvents
|
|
1548
2370
|
# @return [Types::RunCommandParameters]
|
1549
2371
|
#
|
1550
2372
|
# @!attribute [rw] ecs_parameters
|
1551
|
-
# Contains the Amazon ECS task definition and task count to be used
|
1552
|
-
#
|
1553
|
-
#
|
1554
|
-
#
|
2373
|
+
# Contains the Amazon ECS task definition and task count to be used if
|
2374
|
+
# the event target is an Amazon ECS task. For more information about
|
2375
|
+
# Amazon ECS tasks, see [Task Definitions ][1] in the *Amazon EC2
|
2376
|
+
# Container Service Developer Guide*.
|
1555
2377
|
#
|
1556
2378
|
#
|
1557
2379
|
#
|
@@ -1602,12 +2424,12 @@ module Aws::CloudWatchEvents
|
|
1602
2424
|
# }
|
1603
2425
|
#
|
1604
2426
|
# @!attribute [rw] event_pattern
|
1605
|
-
# The event pattern. For more information, see [
|
1606
|
-
#
|
2427
|
+
# The event pattern. For more information, see [Event Patterns][1] in
|
2428
|
+
# the *Amazon EventBridge User Guide*.
|
1607
2429
|
#
|
1608
2430
|
#
|
1609
2431
|
#
|
1610
|
-
# [1]: https://docs.aws.amazon.com/
|
2432
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
|
1611
2433
|
# @return [String]
|
1612
2434
|
#
|
1613
2435
|
# @!attribute [rw] event
|
@@ -1642,8 +2464,7 @@ module Aws::CloudWatchEvents
|
|
1642
2464
|
# }
|
1643
2465
|
#
|
1644
2466
|
# @!attribute [rw] resource_arn
|
1645
|
-
# The ARN of the
|
1646
|
-
# tags.
|
2467
|
+
# The ARN of the rule that you're removing tags from.
|
1647
2468
|
# @return [String]
|
1648
2469
|
#
|
1649
2470
|
# @!attribute [rw] tag_keys
|