aws-sdk-eventbridge 1.0.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.
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::EventBridge
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::EventBridge
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,2487 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::EventBridge
9
+ module Types
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/eventbridge-2015-10-07/ActivateEventSourceRequest AWS API Documentation
23
+ #
24
+ class ActivateEventSourceRequest < Struct.new(
25
+ :name)
26
+ include Aws::Structure
27
+ end
28
+
29
+ # This structure specifies the VPC subnets and security groups for the
30
+ # task and whether a public IP address is to be used. This structure is
31
+ # relevant only for ECS tasks that use the `awsvpc` network mode.
32
+ #
33
+ # @note When making an API call, you may pass AwsVpcConfiguration
34
+ # data as a hash:
35
+ #
36
+ # {
37
+ # subnets: ["String"], # required
38
+ # security_groups: ["String"],
39
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
40
+ # }
41
+ #
42
+ # @!attribute [rw] subnets
43
+ # Specifies the subnets associated with the task. These subnets must
44
+ # all be in the same VPC. You can specify as many as 16 subnets.
45
+ # @return [Array<String>]
46
+ #
47
+ # @!attribute [rw] security_groups
48
+ # Specifies the security groups associated with the task. These
49
+ # security groups must all be in the same VPC. You can specify as many
50
+ # as five security groups. If you don't specify a security group, the
51
+ # default security group for the VPC is used.
52
+ # @return [Array<String>]
53
+ #
54
+ # @!attribute [rw] assign_public_ip
55
+ # Specifies whether the task's elastic network interface receives a
56
+ # public IP address. You can specify `ENABLED` only when `LaunchType`
57
+ # in `EcsParameters` is set to `FARGATE`.
58
+ # @return [String]
59
+ #
60
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/AwsVpcConfiguration AWS API Documentation
61
+ #
62
+ class AwsVpcConfiguration < Struct.new(
63
+ :subnets,
64
+ :security_groups,
65
+ :assign_public_ip)
66
+ include Aws::Structure
67
+ end
68
+
69
+ # The array properties for the submitted job, such as the size of the
70
+ # array. The array size can be between 2 and 10,000. If you specify
71
+ # array properties for a job, it becomes an array job. This parameter is
72
+ # used only if the target is an AWS Batch job.
73
+ #
74
+ # @note When making an API call, you may pass BatchArrayProperties
75
+ # data as a hash:
76
+ #
77
+ # {
78
+ # size: 1,
79
+ # }
80
+ #
81
+ # @!attribute [rw] size
82
+ # The size of the array, if this is an array batch job. Valid values
83
+ # are integers between 2 and 10,000.
84
+ # @return [Integer]
85
+ #
86
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/BatchArrayProperties AWS API Documentation
87
+ #
88
+ class BatchArrayProperties < Struct.new(
89
+ :size)
90
+ include Aws::Structure
91
+ end
92
+
93
+ # The custom parameters to be used when the target is an AWS Batch job.
94
+ #
95
+ # @note When making an API call, you may pass BatchParameters
96
+ # data as a hash:
97
+ #
98
+ # {
99
+ # job_definition: "String", # required
100
+ # job_name: "String", # required
101
+ # array_properties: {
102
+ # size: 1,
103
+ # },
104
+ # retry_strategy: {
105
+ # attempts: 1,
106
+ # },
107
+ # }
108
+ #
109
+ # @!attribute [rw] job_definition
110
+ # The ARN or name of the job definition to use if the event target is
111
+ # an AWS Batch job. This job definition must already exist.
112
+ # @return [String]
113
+ #
114
+ # @!attribute [rw] job_name
115
+ # The name to use for this execution of the job, if the target is an
116
+ # AWS Batch job.
117
+ # @return [String]
118
+ #
119
+ # @!attribute [rw] array_properties
120
+ # The array properties for the submitted job, such as the size of the
121
+ # array. The array size can be between 2 and 10,000. If you specify
122
+ # array properties for a job, it becomes an array job. This parameter
123
+ # is used only if the target is an AWS Batch job.
124
+ # @return [Types::BatchArrayProperties]
125
+ #
126
+ # @!attribute [rw] retry_strategy
127
+ # The retry strategy to use for failed jobs if the target is an AWS
128
+ # Batch job. The retry strategy is the number of times to retry the
129
+ # failed job execution. Valid values are 1–10. When you specify a
130
+ # retry strategy here, it overrides the retry strategy defined in the
131
+ # job definition.
132
+ # @return [Types::BatchRetryStrategy]
133
+ #
134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/BatchParameters AWS API Documentation
135
+ #
136
+ class BatchParameters < Struct.new(
137
+ :job_definition,
138
+ :job_name,
139
+ :array_properties,
140
+ :retry_strategy)
141
+ include Aws::Structure
142
+ end
143
+
144
+ # The retry strategy to use for failed jobs if the target is an AWS
145
+ # Batch job. If you specify a retry strategy here, it overrides the
146
+ # retry strategy defined in the job definition.
147
+ #
148
+ # @note When making an API call, you may pass BatchRetryStrategy
149
+ # data as a hash:
150
+ #
151
+ # {
152
+ # attempts: 1,
153
+ # }
154
+ #
155
+ # @!attribute [rw] attempts
156
+ # The number of times to attempt to retry, if the job fails. Valid
157
+ # values are 1–10.
158
+ # @return [Integer]
159
+ #
160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/BatchRetryStrategy AWS API Documentation
161
+ #
162
+ class BatchRetryStrategy < Struct.new(
163
+ :attempts)
164
+ include Aws::Structure
165
+ end
166
+
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
170
+ # organization. The string must contain `Type`, `Key`, and `Value`
171
+ # fields. The `Value` field specifies the ID of the AWS organization.
172
+ # The following is an example value for `Condition`\:
173
+ #
174
+ # `'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
175
+ # "o-1234567890"\}'`
176
+ #
177
+ # @note When making an API call, you may pass Condition
178
+ # data as a hash:
179
+ #
180
+ # {
181
+ # type: "String", # required
182
+ # key: "String", # required
183
+ # value: "String", # required
184
+ # }
185
+ #
186
+ # @!attribute [rw] type
187
+ # The type of condition. Currently, the only supported value is
188
+ # `StringEquals`.
189
+ # @return [String]
190
+ #
191
+ # @!attribute [rw] key
192
+ # The key for the condition. Currently, the only supported key is
193
+ # `aws:PrincipalOrgID`.
194
+ # @return [String]
195
+ #
196
+ # @!attribute [rw] value
197
+ # The value for the key. Currently, this must be the ID of the
198
+ # organization.
199
+ # @return [String]
200
+ #
201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Condition AWS API Documentation
202
+ #
203
+ class Condition < Struct.new(
204
+ :type,
205
+ :key,
206
+ :value)
207
+ include Aws::Structure
208
+ end
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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
348
+ #
349
+ class DeletePartnerEventSourceRequest < Struct.new(
350
+ :name,
351
+ :account)
352
+ include Aws::Structure
353
+ end
354
+
355
+ # @note When making an API call, you may pass DeleteRuleRequest
356
+ # data as a hash:
357
+ #
358
+ # {
359
+ # name: "RuleName", # required
360
+ # event_bus_name: "EventBusName",
361
+ # force: false,
362
+ # }
363
+ #
364
+ # @!attribute [rw] name
365
+ # The name of the rule.
366
+ # @return [String]
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
+ #
373
+ # @!attribute [rw] force
374
+ # If this is a managed rule, created by an AWS service on your behalf,
375
+ # you must specify `Force` as `True` to delete the rule. This
376
+ # parameter is ignored for rules that are not managed rules. You can
377
+ # check whether a rule is a managed rule by using `DescribeRule` or
378
+ # `ListRules` and checking the `ManagedBy` field of the response.
379
+ # @return [Boolean]
380
+ #
381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteRuleRequest AWS API Documentation
382
+ #
383
+ class DeleteRuleRequest < Struct.new(
384
+ :name,
385
+ :event_bus_name,
386
+ :force)
387
+ include Aws::Structure
388
+ end
389
+
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]
401
+ #
402
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeEventBusRequest AWS API Documentation
403
+ #
404
+ class DescribeEventBusRequest < Struct.new(
405
+ :name)
406
+ include Aws::Structure
407
+ end
408
+
409
+ # @!attribute [rw] name
410
+ # The name of the event bus. Currently, this is always `default`.
411
+ # @return [String]
412
+ #
413
+ # @!attribute [rw] arn
414
+ # The Amazon Resource Name (ARN) of the account permitted to write
415
+ # events to the current account.
416
+ # @return [String]
417
+ #
418
+ # @!attribute [rw] policy
419
+ # The policy that enables the external account to send events to your
420
+ # account.
421
+ # @return [String]
422
+ #
423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeEventBusResponse AWS API Documentation
424
+ #
425
+ class DescribeEventBusResponse < Struct.new(
426
+ :name,
427
+ :arn,
428
+ :policy)
429
+ include Aws::Structure
430
+ end
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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-2015-10-07/DescribePartnerEventSourceResponse AWS API Documentation
519
+ #
520
+ class DescribePartnerEventSourceResponse < Struct.new(
521
+ :arn,
522
+ :name)
523
+ include Aws::Structure
524
+ end
525
+
526
+ # @note When making an API call, you may pass DescribeRuleRequest
527
+ # data as a hash:
528
+ #
529
+ # {
530
+ # name: "RuleName", # required
531
+ # event_bus_name: "EventBusName",
532
+ # }
533
+ #
534
+ # @!attribute [rw] name
535
+ # The name of the rule.
536
+ # @return [String]
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
+ #
543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeRuleRequest AWS API Documentation
544
+ #
545
+ class DescribeRuleRequest < Struct.new(
546
+ :name,
547
+ :event_bus_name)
548
+ include Aws::Structure
549
+ end
550
+
551
+ # @!attribute [rw] name
552
+ # The name of the rule.
553
+ # @return [String]
554
+ #
555
+ # @!attribute [rw] arn
556
+ # The Amazon Resource Name (ARN) of the rule.
557
+ # @return [String]
558
+ #
559
+ # @!attribute [rw] event_pattern
560
+ # The event pattern. For more information, see [Event Patterns][1] in
561
+ # the *Amazon EventBridge User Guide*.
562
+ #
563
+ #
564
+ #
565
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
566
+ # @return [String]
567
+ #
568
+ # @!attribute [rw] schedule_expression
569
+ # The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
570
+ # `"rate(5 minutes)"`.
571
+ # @return [String]
572
+ #
573
+ # @!attribute [rw] state
574
+ # Specifies whether the rule is enabled or disabled.
575
+ # @return [String]
576
+ #
577
+ # @!attribute [rw] description
578
+ # The description of the rule.
579
+ # @return [String]
580
+ #
581
+ # @!attribute [rw] role_arn
582
+ # The Amazon Resource Name (ARN) of the IAM role associated with the
583
+ # rule.
584
+ # @return [String]
585
+ #
586
+ # @!attribute [rw] managed_by
587
+ # If this is a managed rule, created by an AWS service on your behalf,
588
+ # this field displays the principal name of the AWS service that
589
+ # created the rule.
590
+ # @return [String]
591
+ #
592
+ # @!attribute [rw] event_bus_name
593
+ # The event bus associated with the rule.
594
+ # @return [String]
595
+ #
596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeRuleResponse AWS API Documentation
597
+ #
598
+ class DescribeRuleResponse < Struct.new(
599
+ :name,
600
+ :arn,
601
+ :event_pattern,
602
+ :schedule_expression,
603
+ :state,
604
+ :description,
605
+ :role_arn,
606
+ :managed_by,
607
+ :event_bus_name)
608
+ include Aws::Structure
609
+ end
610
+
611
+ # @note When making an API call, you may pass DisableRuleRequest
612
+ # data as a hash:
613
+ #
614
+ # {
615
+ # name: "RuleName", # required
616
+ # event_bus_name: "EventBusName",
617
+ # }
618
+ #
619
+ # @!attribute [rw] name
620
+ # The name of the rule.
621
+ # @return [String]
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
+ #
628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DisableRuleRequest AWS API Documentation
629
+ #
630
+ class DisableRuleRequest < Struct.new(
631
+ :name,
632
+ :event_bus_name)
633
+ include Aws::Structure
634
+ end
635
+
636
+ # The custom parameters to be used when the target is an Amazon ECS
637
+ # task.
638
+ #
639
+ # @note When making an API call, you may pass EcsParameters
640
+ # data as a hash:
641
+ #
642
+ # {
643
+ # task_definition_arn: "Arn", # required
644
+ # task_count: 1,
645
+ # launch_type: "EC2", # accepts EC2, FARGATE
646
+ # network_configuration: {
647
+ # awsvpc_configuration: {
648
+ # subnets: ["String"], # required
649
+ # security_groups: ["String"],
650
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
651
+ # },
652
+ # },
653
+ # platform_version: "String",
654
+ # group: "String",
655
+ # }
656
+ #
657
+ # @!attribute [rw] task_definition_arn
658
+ # The ARN of the task definition to use if the event target is an
659
+ # Amazon ECS task.
660
+ # @return [String]
661
+ #
662
+ # @!attribute [rw] task_count
663
+ # The number of tasks to create based on `TaskDefinition`. The default
664
+ # is 1.
665
+ # @return [Integer]
666
+ #
667
+ # @!attribute [rw] launch_type
668
+ # Specifies the launch type on which your task is running. The launch
669
+ # type that you specify here must match one of the launch type
670
+ # (compatibilities) of the target task. The `FARGATE` value is
671
+ # supported only in the Regions where AWS Fargate with Amazon ECS is
672
+ # supported. For more information, see [AWS Fargate on Amazon ECS][1]
673
+ # in the *Amazon Elastic Container Service Developer Guide*.
674
+ #
675
+ #
676
+ #
677
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html
678
+ # @return [String]
679
+ #
680
+ # @!attribute [rw] network_configuration
681
+ # Use this structure if the ECS task uses the `awsvpc` network mode.
682
+ # This structure specifies the VPC subnets and security groups
683
+ # associated with the task and whether a public IP address is to be
684
+ # used. This structure is required if `LaunchType` is `FARGATE`
685
+ # because the `awsvpc` mode is required for Fargate tasks.
686
+ #
687
+ # If you specify `NetworkConfiguration` when the target ECS task
688
+ # doesn't use the `awsvpc` network mode, the task fails.
689
+ # @return [Types::NetworkConfiguration]
690
+ #
691
+ # @!attribute [rw] platform_version
692
+ # Specifies the platform version for the task. Specify only the
693
+ # numeric portion of the platform version, such as `1.1.0`.
694
+ #
695
+ # This structure is used only if `LaunchType` is `FARGATE`. For more
696
+ # information about valid platform versions, see [AWS Fargate Platform
697
+ # Versions][1] in the *Amazon Elastic Container Service Developer
698
+ # Guide*.
699
+ #
700
+ #
701
+ #
702
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
703
+ # @return [String]
704
+ #
705
+ # @!attribute [rw] group
706
+ # Specifies an ECS task group for the task. The maximum length is 255
707
+ # characters.
708
+ # @return [String]
709
+ #
710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EcsParameters AWS API Documentation
711
+ #
712
+ class EcsParameters < Struct.new(
713
+ :task_definition_arn,
714
+ :task_count,
715
+ :launch_type,
716
+ :network_configuration,
717
+ :platform_version,
718
+ :group)
719
+ include Aws::Structure
720
+ end
721
+
722
+ # @note When making an API call, you may pass EnableRuleRequest
723
+ # data as a hash:
724
+ #
725
+ # {
726
+ # name: "RuleName", # required
727
+ # event_bus_name: "EventBusName",
728
+ # }
729
+ #
730
+ # @!attribute [rw] name
731
+ # The name of the rule.
732
+ # @return [String]
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
+ #
739
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EnableRuleRequest AWS API Documentation
740
+ #
741
+ class EnableRuleRequest < Struct.new(
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/eventbridge-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/eventbridge-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)
821
+ include Aws::Structure
822
+ end
823
+
824
+ # Contains the parameters needed for you to provide custom input to a
825
+ # target based on one or more pieces of data extracted from the event.
826
+ #
827
+ # @note When making an API call, you may pass InputTransformer
828
+ # data as a hash:
829
+ #
830
+ # {
831
+ # input_paths_map: {
832
+ # "InputTransformerPathKey" => "TargetInputPath",
833
+ # },
834
+ # input_template: "TransformerInput", # required
835
+ # }
836
+ #
837
+ # @!attribute [rw] input_paths_map
838
+ # Map of JSON paths to be extracted from the event. You can then
839
+ # insert these in the template in `InputTemplate` to produce the
840
+ # output to be sent to the target.
841
+ #
842
+ # `InputPathsMap` is an array key-value pairs, where each value is a
843
+ # valid JSON path. You can have as many as 10 key-value pairs. You
844
+ # must use JSON dot notation, not bracket notation.
845
+ #
846
+ # The keys can't start with `"AWS"`.
847
+ # @return [Hash<String,String>]
848
+ #
849
+ # @!attribute [rw] input_template
850
+ # Input template where you specify placeholders that will be filled
851
+ # with the values of the keys from `InputPathsMap` to customize the
852
+ # data sent to the target. Enclose each `InputPathsMaps` value in
853
+ # brackets: &lt;*value*&gt;. The InputTemplate must be valid JSON.
854
+ #
855
+ # If `InputTemplate` is a JSON object (surrounded by curly braces),
856
+ # the following restrictions apply:
857
+ #
858
+ # * The placeholder can't be used as an object key
859
+ #
860
+ # * Object values can't include quote marks
861
+ #
862
+ # The following example shows the syntax for using `InputPathsMap` and
863
+ # `InputTemplate`.
864
+ #
865
+ # ` "InputTransformer":`
866
+ #
867
+ # `\{`
868
+ #
869
+ # `"InputPathsMap": \{"instance": "$.detail.instance","status":
870
+ # "$.detail.status"\},`
871
+ #
872
+ # `"InputTemplate": "<instance> is in state <status>"`
873
+ #
874
+ # `\}`
875
+ #
876
+ # To have the `InputTemplate` include quote marks within a JSON
877
+ # string, escape each quote marks with a slash, as in the following
878
+ # example:
879
+ #
880
+ # ` "InputTransformer":`
881
+ #
882
+ # `\{`
883
+ #
884
+ # `"InputPathsMap": \{"instance": "$.detail.instance","status":
885
+ # "$.detail.status"\},`
886
+ #
887
+ # `"InputTemplate": "<instance> is in state "<status>""`
888
+ #
889
+ # `\}`
890
+ # @return [String]
891
+ #
892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InputTransformer AWS API Documentation
893
+ #
894
+ class InputTransformer < Struct.new(
895
+ :input_paths_map,
896
+ :input_template)
897
+ include Aws::Structure
898
+ end
899
+
900
+ # This object enables you to specify a JSON path to extract from the
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.
905
+ #
906
+ # @note When making an API call, you may pass KinesisParameters
907
+ # data as a hash:
908
+ #
909
+ # {
910
+ # partition_key_path: "TargetPartitionKeyPath", # required
911
+ # }
912
+ #
913
+ # @!attribute [rw] partition_key_path
914
+ # The JSON path to be extracted from the event and used as the
915
+ # partition key. For more information, see [Amazon Kinesis Streams Key
916
+ # Concepts][1] in the *Amazon Kinesis Streams Developer Guide*.
917
+ #
918
+ #
919
+ #
920
+ # [1]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key
921
+ # @return [String]
922
+ #
923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/KinesisParameters AWS API Documentation
924
+ #
925
+ class KinesisParameters < Struct.new(
926
+ :partition_key_path)
927
+ include Aws::Structure
928
+ end
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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-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
+
1134
+ # @note When making an API call, you may pass ListRuleNamesByTargetRequest
1135
+ # data as a hash:
1136
+ #
1137
+ # {
1138
+ # target_arn: "TargetArn", # required
1139
+ # event_bus_name: "EventBusName",
1140
+ # next_token: "NextToken",
1141
+ # limit: 1,
1142
+ # }
1143
+ #
1144
+ # @!attribute [rw] target_arn
1145
+ # The Amazon Resource Name (ARN) of the target resource.
1146
+ # @return [String]
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
+ #
1153
+ # @!attribute [rw] next_token
1154
+ # The token returned by a previous call to retrieve the next set of
1155
+ # results.
1156
+ # @return [String]
1157
+ #
1158
+ # @!attribute [rw] limit
1159
+ # The maximum number of results to return.
1160
+ # @return [Integer]
1161
+ #
1162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListRuleNamesByTargetRequest AWS API Documentation
1163
+ #
1164
+ class ListRuleNamesByTargetRequest < Struct.new(
1165
+ :target_arn,
1166
+ :event_bus_name,
1167
+ :next_token,
1168
+ :limit)
1169
+ include Aws::Structure
1170
+ end
1171
+
1172
+ # @!attribute [rw] rule_names
1173
+ # The names of the rules that can invoke the given target.
1174
+ # @return [Array<String>]
1175
+ #
1176
+ # @!attribute [rw] next_token
1177
+ # Indicates whether there are additional results to retrieve. If there
1178
+ # are no more results, the value is null.
1179
+ # @return [String]
1180
+ #
1181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListRuleNamesByTargetResponse AWS API Documentation
1182
+ #
1183
+ class ListRuleNamesByTargetResponse < Struct.new(
1184
+ :rule_names,
1185
+ :next_token)
1186
+ include Aws::Structure
1187
+ end
1188
+
1189
+ # @note When making an API call, you may pass ListRulesRequest
1190
+ # data as a hash:
1191
+ #
1192
+ # {
1193
+ # name_prefix: "RuleName",
1194
+ # event_bus_name: "EventBusName",
1195
+ # next_token: "NextToken",
1196
+ # limit: 1,
1197
+ # }
1198
+ #
1199
+ # @!attribute [rw] name_prefix
1200
+ # The prefix matching the rule name.
1201
+ # @return [String]
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
+ #
1208
+ # @!attribute [rw] next_token
1209
+ # The token returned by a previous call to retrieve the next set of
1210
+ # results.
1211
+ # @return [String]
1212
+ #
1213
+ # @!attribute [rw] limit
1214
+ # The maximum number of results to return.
1215
+ # @return [Integer]
1216
+ #
1217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListRulesRequest AWS API Documentation
1218
+ #
1219
+ class ListRulesRequest < Struct.new(
1220
+ :name_prefix,
1221
+ :event_bus_name,
1222
+ :next_token,
1223
+ :limit)
1224
+ include Aws::Structure
1225
+ end
1226
+
1227
+ # @!attribute [rw] rules
1228
+ # The rules that match the specified criteria.
1229
+ # @return [Array<Types::Rule>]
1230
+ #
1231
+ # @!attribute [rw] next_token
1232
+ # Indicates whether there are additional results to retrieve. If there
1233
+ # are no more results, the value is null.
1234
+ # @return [String]
1235
+ #
1236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListRulesResponse AWS API Documentation
1237
+ #
1238
+ class ListRulesResponse < Struct.new(
1239
+ :rules,
1240
+ :next_token)
1241
+ include Aws::Structure
1242
+ end
1243
+
1244
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1245
+ # data as a hash:
1246
+ #
1247
+ # {
1248
+ # resource_arn: "Arn", # required
1249
+ # }
1250
+ #
1251
+ # @!attribute [rw] resource_arn
1252
+ # The ARN of the rule for which you want to view tags.
1253
+ # @return [String]
1254
+ #
1255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListTagsForResourceRequest AWS API Documentation
1256
+ #
1257
+ class ListTagsForResourceRequest < Struct.new(
1258
+ :resource_arn)
1259
+ include Aws::Structure
1260
+ end
1261
+
1262
+ # @!attribute [rw] tags
1263
+ # The list of tag keys and values associated with the rule that you
1264
+ # specified.
1265
+ # @return [Array<Types::Tag>]
1266
+ #
1267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListTagsForResourceResponse AWS API Documentation
1268
+ #
1269
+ class ListTagsForResourceResponse < Struct.new(
1270
+ :tags)
1271
+ include Aws::Structure
1272
+ end
1273
+
1274
+ # @note When making an API call, you may pass ListTargetsByRuleRequest
1275
+ # data as a hash:
1276
+ #
1277
+ # {
1278
+ # rule: "RuleName", # required
1279
+ # event_bus_name: "EventBusName",
1280
+ # next_token: "NextToken",
1281
+ # limit: 1,
1282
+ # }
1283
+ #
1284
+ # @!attribute [rw] rule
1285
+ # The name of the rule.
1286
+ # @return [String]
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
+ #
1293
+ # @!attribute [rw] next_token
1294
+ # The token returned by a previous call to retrieve the next set of
1295
+ # results.
1296
+ # @return [String]
1297
+ #
1298
+ # @!attribute [rw] limit
1299
+ # The maximum number of results to return.
1300
+ # @return [Integer]
1301
+ #
1302
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListTargetsByRuleRequest AWS API Documentation
1303
+ #
1304
+ class ListTargetsByRuleRequest < Struct.new(
1305
+ :rule,
1306
+ :event_bus_name,
1307
+ :next_token,
1308
+ :limit)
1309
+ include Aws::Structure
1310
+ end
1311
+
1312
+ # @!attribute [rw] targets
1313
+ # The targets assigned to the rule.
1314
+ # @return [Array<Types::Target>]
1315
+ #
1316
+ # @!attribute [rw] next_token
1317
+ # Indicates whether there are additional results to retrieve. If there
1318
+ # are no more results, the value is null.
1319
+ # @return [String]
1320
+ #
1321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListTargetsByRuleResponse AWS API Documentation
1322
+ #
1323
+ class ListTargetsByRuleResponse < Struct.new(
1324
+ :targets,
1325
+ :next_token)
1326
+ include Aws::Structure
1327
+ end
1328
+
1329
+ # This structure specifies the network configuration for an ECS task.
1330
+ #
1331
+ # @note When making an API call, you may pass NetworkConfiguration
1332
+ # data as a hash:
1333
+ #
1334
+ # {
1335
+ # awsvpc_configuration: {
1336
+ # subnets: ["String"], # required
1337
+ # security_groups: ["String"],
1338
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
1339
+ # },
1340
+ # }
1341
+ #
1342
+ # @!attribute [rw] awsvpc_configuration
1343
+ # Use this structure to specify the VPC subnets and security groups
1344
+ # for the task and whether a public IP address is to be used. This
1345
+ # structure is relevant only for ECS tasks that use the `awsvpc`
1346
+ # network mode.
1347
+ # @return [Types::AwsVpcConfiguration]
1348
+ #
1349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/NetworkConfiguration AWS API Documentation
1350
+ #
1351
+ class NetworkConfiguration < Struct.new(
1352
+ :awsvpc_configuration)
1353
+ include Aws::Structure
1354
+ end
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/eventbridge-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/eventbridge-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
+
1411
+ # @note When making an API call, you may pass PutEventsRequest
1412
+ # data as a hash:
1413
+ #
1414
+ # {
1415
+ # entries: [ # required
1416
+ # {
1417
+ # time: Time.now,
1418
+ # source: "String",
1419
+ # resources: ["EventResource"],
1420
+ # detail_type: "String",
1421
+ # detail: "String",
1422
+ # event_bus_name: "NonPartnerEventBusName",
1423
+ # },
1424
+ # ],
1425
+ # }
1426
+ #
1427
+ # @!attribute [rw] entries
1428
+ # The entry that defines an event in your system. You can specify
1429
+ # several parameters for the entry such as the source and type of the
1430
+ # event, resources associated with the event, and so on.
1431
+ # @return [Array<Types::PutEventsRequestEntry>]
1432
+ #
1433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutEventsRequest AWS API Documentation
1434
+ #
1435
+ class PutEventsRequest < Struct.new(
1436
+ :entries)
1437
+ include Aws::Structure
1438
+ end
1439
+
1440
+ # Represents an event to be submitted.
1441
+ #
1442
+ # @note When making an API call, you may pass PutEventsRequestEntry
1443
+ # data as a hash:
1444
+ #
1445
+ # {
1446
+ # time: Time.now,
1447
+ # source: "String",
1448
+ # resources: ["EventResource"],
1449
+ # detail_type: "String",
1450
+ # detail: "String",
1451
+ # event_bus_name: "NonPartnerEventBusName",
1452
+ # }
1453
+ #
1454
+ # @!attribute [rw] time
1455
+ # The timestamp of the event, per [RFC3339][1]. If no timestamp is
1456
+ # provided, the timestamp of the PutEvents call is used.
1457
+ #
1458
+ #
1459
+ #
1460
+ # [1]: https://www.rfc-editor.org/rfc/rfc3339.txt
1461
+ # @return [Time]
1462
+ #
1463
+ # @!attribute [rw] source
1464
+ # The source of the event. This field is required.
1465
+ # @return [String]
1466
+ #
1467
+ # @!attribute [rw] resources
1468
+ # AWS resources, identified by Amazon Resource Name (ARN), that the
1469
+ # event primarily concerns. Any number, including zero, can be
1470
+ # present.
1471
+ # @return [Array<String>]
1472
+ #
1473
+ # @!attribute [rw] detail_type
1474
+ # Free-form string used to decide which fields to expect in the event
1475
+ # detail.
1476
+ # @return [String]
1477
+ #
1478
+ # @!attribute [rw] detail
1479
+ # A valid JSON string. There is no other schema imposed. The JSON
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.
1486
+ # @return [String]
1487
+ #
1488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutEventsRequestEntry AWS API Documentation
1489
+ #
1490
+ class PutEventsRequestEntry < Struct.new(
1491
+ :time,
1492
+ :source,
1493
+ :resources,
1494
+ :detail_type,
1495
+ :detail,
1496
+ :event_bus_name)
1497
+ include Aws::Structure
1498
+ end
1499
+
1500
+ # @!attribute [rw] failed_entry_count
1501
+ # The number of failed entries.
1502
+ # @return [Integer]
1503
+ #
1504
+ # @!attribute [rw] entries
1505
+ # The successfully and unsuccessfully ingested events results. If the
1506
+ # ingestion was successful, the entry has the event ID in it.
1507
+ # Otherwise, you can use the error code and error message to identify
1508
+ # the problem with the entry.
1509
+ # @return [Array<Types::PutEventsResultEntry>]
1510
+ #
1511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutEventsResponse AWS API Documentation
1512
+ #
1513
+ class PutEventsResponse < Struct.new(
1514
+ :failed_entry_count,
1515
+ :entries)
1516
+ include Aws::Structure
1517
+ end
1518
+
1519
+ # Represents an event that failed to be submitted.
1520
+ #
1521
+ # @!attribute [rw] event_id
1522
+ # The ID of the event.
1523
+ # @return [String]
1524
+ #
1525
+ # @!attribute [rw] error_code
1526
+ # The error code that indicates why the event submission failed.
1527
+ # @return [String]
1528
+ #
1529
+ # @!attribute [rw] error_message
1530
+ # The error message that explains why the event submission failed.
1531
+ # @return [String]
1532
+ #
1533
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutEventsResultEntry AWS API Documentation
1534
+ #
1535
+ class PutEventsResultEntry < Struct.new(
1536
+ :event_id,
1537
+ :error_code,
1538
+ :error_message)
1539
+ include Aws::Structure
1540
+ end
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/eventbridge-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/eventbridge-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/eventbridge-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/eventbridge-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
+
1657
+ # @note When making an API call, you may pass PutPermissionRequest
1658
+ # data as a hash:
1659
+ #
1660
+ # {
1661
+ # event_bus_name: "NonPartnerEventBusName",
1662
+ # action: "Action", # required
1663
+ # principal: "Principal", # required
1664
+ # statement_id: "StatementId", # required
1665
+ # condition: {
1666
+ # type: "String", # required
1667
+ # key: "String", # required
1668
+ # value: "String", # required
1669
+ # },
1670
+ # }
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
+ #
1677
+ # @!attribute [rw] action
1678
+ # The action that you're enabling the other account to perform.
1679
+ # Currently, this must be `events:PutEvents`.
1680
+ # @return [String]
1681
+ #
1682
+ # @!attribute [rw] principal
1683
+ # The 12-digit AWS account ID that you are permitting to put events to
1684
+ # your default event bus. Specify "*" to permit any account to put
1685
+ # events to your default event bus.
1686
+ #
1687
+ # If you specify "*" without specifying `Condition`, avoid creating
1688
+ # rules that might match undesirable events. To create more secure
1689
+ # rules, make sure that the event pattern for each rule contains an
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.
1693
+ # @return [String]
1694
+ #
1695
+ # @!attribute [rw] statement_id
1696
+ # An identifier string for the external account that you're granting
1697
+ # permissions to. If you later want to revoke the permission for this
1698
+ # external account, specify this `StatementId` when you run
1699
+ # RemovePermission.
1700
+ # @return [String]
1701
+ #
1702
+ # @!attribute [rw] condition
1703
+ # This parameter enables you to limit the permission to accounts that
1704
+ # fulfill a certain condition, such as being a member of a certain AWS
1705
+ # organization. For more information about AWS Organizations, see
1706
+ # [What Is AWS Organizations?][1] in the *AWS Organizations User
1707
+ # Guide*.
1708
+ #
1709
+ # If you specify `Condition` with an AWS organization ID and specify
1710
+ # "*" as the value for `Principal`, you grant permission to all the
1711
+ # accounts in the named organization.
1712
+ #
1713
+ # The `Condition` is a JSON string that must contain `Type`, `Key`,
1714
+ # and `Value` fields.
1715
+ #
1716
+ #
1717
+ #
1718
+ # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html
1719
+ # @return [Types::Condition]
1720
+ #
1721
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutPermissionRequest AWS API Documentation
1722
+ #
1723
+ class PutPermissionRequest < Struct.new(
1724
+ :event_bus_name,
1725
+ :action,
1726
+ :principal,
1727
+ :statement_id,
1728
+ :condition)
1729
+ include Aws::Structure
1730
+ end
1731
+
1732
+ # @note When making an API call, you may pass PutRuleRequest
1733
+ # data as a hash:
1734
+ #
1735
+ # {
1736
+ # name: "RuleName", # required
1737
+ # schedule_expression: "ScheduleExpression",
1738
+ # event_pattern: "EventPattern",
1739
+ # state: "ENABLED", # accepts ENABLED, DISABLED
1740
+ # description: "RuleDescription",
1741
+ # role_arn: "RoleArn",
1742
+ # tags: [
1743
+ # {
1744
+ # key: "TagKey", # required
1745
+ # value: "TagValue", # required
1746
+ # },
1747
+ # ],
1748
+ # event_bus_name: "EventBusName",
1749
+ # }
1750
+ #
1751
+ # @!attribute [rw] name
1752
+ # The name of the rule that you're creating or updating.
1753
+ # @return [String]
1754
+ #
1755
+ # @!attribute [rw] schedule_expression
1756
+ # The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
1757
+ # `"rate(5 minutes)"`.
1758
+ # @return [String]
1759
+ #
1760
+ # @!attribute [rw] event_pattern
1761
+ # The event pattern. For more information, see [Event Patterns][1] in
1762
+ # the *Amazon EventBridge User Guide*.
1763
+ #
1764
+ #
1765
+ #
1766
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
1767
+ # @return [String]
1768
+ #
1769
+ # @!attribute [rw] state
1770
+ # Indicates whether the rule is enabled or disabled.
1771
+ # @return [String]
1772
+ #
1773
+ # @!attribute [rw] description
1774
+ # A description of the rule.
1775
+ # @return [String]
1776
+ #
1777
+ # @!attribute [rw] role_arn
1778
+ # The Amazon Resource Name (ARN) of the IAM role associated with the
1779
+ # rule.
1780
+ # @return [String]
1781
+ #
1782
+ # @!attribute [rw] tags
1783
+ # The list of key-value pairs to associate with the rule.
1784
+ # @return [Array<Types::Tag>]
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
+ #
1791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutRuleRequest AWS API Documentation
1792
+ #
1793
+ class PutRuleRequest < Struct.new(
1794
+ :name,
1795
+ :schedule_expression,
1796
+ :event_pattern,
1797
+ :state,
1798
+ :description,
1799
+ :role_arn,
1800
+ :tags,
1801
+ :event_bus_name)
1802
+ include Aws::Structure
1803
+ end
1804
+
1805
+ # @!attribute [rw] rule_arn
1806
+ # The Amazon Resource Name (ARN) of the rule.
1807
+ # @return [String]
1808
+ #
1809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutRuleResponse AWS API Documentation
1810
+ #
1811
+ class PutRuleResponse < Struct.new(
1812
+ :rule_arn)
1813
+ include Aws::Structure
1814
+ end
1815
+
1816
+ # @note When making an API call, you may pass PutTargetsRequest
1817
+ # data as a hash:
1818
+ #
1819
+ # {
1820
+ # rule: "RuleName", # required
1821
+ # event_bus_name: "EventBusName",
1822
+ # targets: [ # required
1823
+ # {
1824
+ # id: "TargetId", # required
1825
+ # arn: "TargetArn", # required
1826
+ # role_arn: "RoleArn",
1827
+ # input: "TargetInput",
1828
+ # input_path: "TargetInputPath",
1829
+ # input_transformer: {
1830
+ # input_paths_map: {
1831
+ # "InputTransformerPathKey" => "TargetInputPath",
1832
+ # },
1833
+ # input_template: "TransformerInput", # required
1834
+ # },
1835
+ # kinesis_parameters: {
1836
+ # partition_key_path: "TargetPartitionKeyPath", # required
1837
+ # },
1838
+ # run_command_parameters: {
1839
+ # run_command_targets: [ # required
1840
+ # {
1841
+ # key: "RunCommandTargetKey", # required
1842
+ # values: ["RunCommandTargetValue"], # required
1843
+ # },
1844
+ # ],
1845
+ # },
1846
+ # ecs_parameters: {
1847
+ # task_definition_arn: "Arn", # required
1848
+ # task_count: 1,
1849
+ # launch_type: "EC2", # accepts EC2, FARGATE
1850
+ # network_configuration: {
1851
+ # awsvpc_configuration: {
1852
+ # subnets: ["String"], # required
1853
+ # security_groups: ["String"],
1854
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
1855
+ # },
1856
+ # },
1857
+ # platform_version: "String",
1858
+ # group: "String",
1859
+ # },
1860
+ # batch_parameters: {
1861
+ # job_definition: "String", # required
1862
+ # job_name: "String", # required
1863
+ # array_properties: {
1864
+ # size: 1,
1865
+ # },
1866
+ # retry_strategy: {
1867
+ # attempts: 1,
1868
+ # },
1869
+ # },
1870
+ # sqs_parameters: {
1871
+ # message_group_id: "MessageGroupId",
1872
+ # },
1873
+ # },
1874
+ # ],
1875
+ # }
1876
+ #
1877
+ # @!attribute [rw] rule
1878
+ # The name of the rule.
1879
+ # @return [String]
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
+ #
1886
+ # @!attribute [rw] targets
1887
+ # The targets to update or add to the rule.
1888
+ # @return [Array<Types::Target>]
1889
+ #
1890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutTargetsRequest AWS API Documentation
1891
+ #
1892
+ class PutTargetsRequest < Struct.new(
1893
+ :rule,
1894
+ :event_bus_name,
1895
+ :targets)
1896
+ include Aws::Structure
1897
+ end
1898
+
1899
+ # @!attribute [rw] failed_entry_count
1900
+ # The number of failed entries.
1901
+ # @return [Integer]
1902
+ #
1903
+ # @!attribute [rw] failed_entries
1904
+ # The failed target entries.
1905
+ # @return [Array<Types::PutTargetsResultEntry>]
1906
+ #
1907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutTargetsResponse AWS API Documentation
1908
+ #
1909
+ class PutTargetsResponse < Struct.new(
1910
+ :failed_entry_count,
1911
+ :failed_entries)
1912
+ include Aws::Structure
1913
+ end
1914
+
1915
+ # Represents a target that failed to be added to a rule.
1916
+ #
1917
+ # @!attribute [rw] target_id
1918
+ # The ID of the target.
1919
+ # @return [String]
1920
+ #
1921
+ # @!attribute [rw] error_code
1922
+ # The error code that indicates why the target addition failed. If the
1923
+ # value is `ConcurrentModificationException`, too many requests were
1924
+ # made at the same time.
1925
+ # @return [String]
1926
+ #
1927
+ # @!attribute [rw] error_message
1928
+ # The error message that explains why the target addition failed.
1929
+ # @return [String]
1930
+ #
1931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutTargetsResultEntry AWS API Documentation
1932
+ #
1933
+ class PutTargetsResultEntry < Struct.new(
1934
+ :target_id,
1935
+ :error_code,
1936
+ :error_message)
1937
+ include Aws::Structure
1938
+ end
1939
+
1940
+ # @note When making an API call, you may pass RemovePermissionRequest
1941
+ # data as a hash:
1942
+ #
1943
+ # {
1944
+ # statement_id: "StatementId", # required
1945
+ # event_bus_name: "NonPartnerEventBusName",
1946
+ # }
1947
+ #
1948
+ # @!attribute [rw] statement_id
1949
+ # The statement ID corresponding to the account that is no longer
1950
+ # allowed to put events to the default event bus.
1951
+ # @return [String]
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
+ #
1958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RemovePermissionRequest AWS API Documentation
1959
+ #
1960
+ class RemovePermissionRequest < Struct.new(
1961
+ :statement_id,
1962
+ :event_bus_name)
1963
+ include Aws::Structure
1964
+ end
1965
+
1966
+ # @note When making an API call, you may pass RemoveTargetsRequest
1967
+ # data as a hash:
1968
+ #
1969
+ # {
1970
+ # rule: "RuleName", # required
1971
+ # event_bus_name: "EventBusName",
1972
+ # ids: ["TargetId"], # required
1973
+ # force: false,
1974
+ # }
1975
+ #
1976
+ # @!attribute [rw] rule
1977
+ # The name of the rule.
1978
+ # @return [String]
1979
+ #
1980
+ # @!attribute [rw] event_bus_name
1981
+ # The name of the event bus associated with the rule.
1982
+ # @return [String]
1983
+ #
1984
+ # @!attribute [rw] ids
1985
+ # The IDs of the targets to remove from the rule.
1986
+ # @return [Array<String>]
1987
+ #
1988
+ # @!attribute [rw] force
1989
+ # If this is a managed rule created by an AWS service on your behalf,
1990
+ # you must specify `Force` as `True` to remove targets. This parameter
1991
+ # is ignored for rules that aren't managed rules. You can check
1992
+ # whether a rule is a managed rule by using `DescribeRule` or
1993
+ # `ListRules` and checking the `ManagedBy` field of the response.
1994
+ # @return [Boolean]
1995
+ #
1996
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RemoveTargetsRequest AWS API Documentation
1997
+ #
1998
+ class RemoveTargetsRequest < Struct.new(
1999
+ :rule,
2000
+ :event_bus_name,
2001
+ :ids,
2002
+ :force)
2003
+ include Aws::Structure
2004
+ end
2005
+
2006
+ # @!attribute [rw] failed_entry_count
2007
+ # The number of failed entries.
2008
+ # @return [Integer]
2009
+ #
2010
+ # @!attribute [rw] failed_entries
2011
+ # The failed target entries.
2012
+ # @return [Array<Types::RemoveTargetsResultEntry>]
2013
+ #
2014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RemoveTargetsResponse AWS API Documentation
2015
+ #
2016
+ class RemoveTargetsResponse < Struct.new(
2017
+ :failed_entry_count,
2018
+ :failed_entries)
2019
+ include Aws::Structure
2020
+ end
2021
+
2022
+ # Represents a target that failed to be removed from a rule.
2023
+ #
2024
+ # @!attribute [rw] target_id
2025
+ # The ID of the target.
2026
+ # @return [String]
2027
+ #
2028
+ # @!attribute [rw] error_code
2029
+ # The error code that indicates why the target removal failed. If the
2030
+ # value is `ConcurrentModificationException`, too many requests were
2031
+ # made at the same time.
2032
+ # @return [String]
2033
+ #
2034
+ # @!attribute [rw] error_message
2035
+ # The error message that explains why the target removal failed.
2036
+ # @return [String]
2037
+ #
2038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RemoveTargetsResultEntry AWS API Documentation
2039
+ #
2040
+ class RemoveTargetsResultEntry < Struct.new(
2041
+ :target_id,
2042
+ :error_code,
2043
+ :error_message)
2044
+ include Aws::Structure
2045
+ end
2046
+
2047
+ # Contains information about a rule in Amazon EventBridge.
2048
+ #
2049
+ # @!attribute [rw] name
2050
+ # The name of the rule.
2051
+ # @return [String]
2052
+ #
2053
+ # @!attribute [rw] arn
2054
+ # The Amazon Resource Name (ARN) of the rule.
2055
+ # @return [String]
2056
+ #
2057
+ # @!attribute [rw] event_pattern
2058
+ # The event pattern of the rule. For more information, see [Event
2059
+ # Patterns][1] in the *Amazon EventBridge User Guide*.
2060
+ #
2061
+ #
2062
+ #
2063
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
2064
+ # @return [String]
2065
+ #
2066
+ # @!attribute [rw] state
2067
+ # The state of the rule.
2068
+ # @return [String]
2069
+ #
2070
+ # @!attribute [rw] description
2071
+ # The description of the rule.
2072
+ # @return [String]
2073
+ #
2074
+ # @!attribute [rw] schedule_expression
2075
+ # The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
2076
+ # `"rate(5 minutes)"`.
2077
+ # @return [String]
2078
+ #
2079
+ # @!attribute [rw] role_arn
2080
+ # The Amazon Resource Name (ARN) of the role that is used for target
2081
+ # invocation.
2082
+ # @return [String]
2083
+ #
2084
+ # @!attribute [rw] managed_by
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.
2092
+ # @return [String]
2093
+ #
2094
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Rule AWS API Documentation
2095
+ #
2096
+ class Rule < Struct.new(
2097
+ :name,
2098
+ :arn,
2099
+ :event_pattern,
2100
+ :state,
2101
+ :description,
2102
+ :schedule_expression,
2103
+ :role_arn,
2104
+ :managed_by,
2105
+ :event_bus_name)
2106
+ include Aws::Structure
2107
+ end
2108
+
2109
+ # This parameter contains the criteria (either `InstanceIds` or a tag)
2110
+ # used to specify which EC2 instances are to be sent the command.
2111
+ #
2112
+ # @note When making an API call, you may pass RunCommandParameters
2113
+ # data as a hash:
2114
+ #
2115
+ # {
2116
+ # run_command_targets: [ # required
2117
+ # {
2118
+ # key: "RunCommandTargetKey", # required
2119
+ # values: ["RunCommandTargetValue"], # required
2120
+ # },
2121
+ # ],
2122
+ # }
2123
+ #
2124
+ # @!attribute [rw] run_command_targets
2125
+ # Currently, we support including only one `RunCommandTarget` block,
2126
+ # which specifies either an array of `InstanceIds` or a tag.
2127
+ # @return [Array<Types::RunCommandTarget>]
2128
+ #
2129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RunCommandParameters AWS API Documentation
2130
+ #
2131
+ class RunCommandParameters < Struct.new(
2132
+ :run_command_targets)
2133
+ include Aws::Structure
2134
+ end
2135
+
2136
+ # Information about the EC2 instances that are to be sent the command,
2137
+ # specified as key-value pairs. Each `RunCommandTarget` block can
2138
+ # include only one key, but this key can specify multiple values.
2139
+ #
2140
+ # @note When making an API call, you may pass RunCommandTarget
2141
+ # data as a hash:
2142
+ #
2143
+ # {
2144
+ # key: "RunCommandTargetKey", # required
2145
+ # values: ["RunCommandTargetValue"], # required
2146
+ # }
2147
+ #
2148
+ # @!attribute [rw] key
2149
+ # Can be either `tag:` *tag-key* or `InstanceIds`.
2150
+ # @return [String]
2151
+ #
2152
+ # @!attribute [rw] values
2153
+ # If `Key` is `tag:` *tag-key*, `Values` is a list of tag values. If
2154
+ # `Key` is `InstanceIds`, `Values` is a list of Amazon EC2 instance
2155
+ # IDs.
2156
+ # @return [Array<String>]
2157
+ #
2158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RunCommandTarget AWS API Documentation
2159
+ #
2160
+ class RunCommandTarget < Struct.new(
2161
+ :key,
2162
+ :values)
2163
+ include Aws::Structure
2164
+ end
2165
+
2166
+ # This structure includes the custom parameter to be used when the
2167
+ # target is an SQS FIFO queue.
2168
+ #
2169
+ # @note When making an API call, you may pass SqsParameters
2170
+ # data as a hash:
2171
+ #
2172
+ # {
2173
+ # message_group_id: "MessageGroupId",
2174
+ # }
2175
+ #
2176
+ # @!attribute [rw] message_group_id
2177
+ # The FIFO message group ID to use as the target.
2178
+ # @return [String]
2179
+ #
2180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/SqsParameters AWS API Documentation
2181
+ #
2182
+ class SqsParameters < Struct.new(
2183
+ :message_group_id)
2184
+ include Aws::Structure
2185
+ end
2186
+
2187
+ # A key-value pair associated with an AWS resource. In EventBridge,
2188
+ # rules support tagging.
2189
+ #
2190
+ # @note When making an API call, you may pass Tag
2191
+ # data as a hash:
2192
+ #
2193
+ # {
2194
+ # key: "TagKey", # required
2195
+ # value: "TagValue", # required
2196
+ # }
2197
+ #
2198
+ # @!attribute [rw] key
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.
2201
+ # @return [String]
2202
+ #
2203
+ # @!attribute [rw] value
2204
+ # The value for the specified tag key.
2205
+ # @return [String]
2206
+ #
2207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Tag AWS API Documentation
2208
+ #
2209
+ class Tag < Struct.new(
2210
+ :key,
2211
+ :value)
2212
+ include Aws::Structure
2213
+ end
2214
+
2215
+ # @note When making an API call, you may pass TagResourceRequest
2216
+ # data as a hash:
2217
+ #
2218
+ # {
2219
+ # resource_arn: "Arn", # required
2220
+ # tags: [ # required
2221
+ # {
2222
+ # key: "TagKey", # required
2223
+ # value: "TagValue", # required
2224
+ # },
2225
+ # ],
2226
+ # }
2227
+ #
2228
+ # @!attribute [rw] resource_arn
2229
+ # The ARN of the rule that you're adding tags to.
2230
+ # @return [String]
2231
+ #
2232
+ # @!attribute [rw] tags
2233
+ # The list of key-value pairs to associate with the rule.
2234
+ # @return [Array<Types::Tag>]
2235
+ #
2236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/TagResourceRequest AWS API Documentation
2237
+ #
2238
+ class TagResourceRequest < Struct.new(
2239
+ :resource_arn,
2240
+ :tags)
2241
+ include Aws::Structure
2242
+ end
2243
+
2244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/TagResourceResponse AWS API Documentation
2245
+ #
2246
+ class TagResourceResponse < Aws::EmptyStructure; end
2247
+
2248
+ # Targets are the resources to be invoked when a rule is triggered. For
2249
+ # a complete list of services and resources that can be set as a target,
2250
+ # see PutTargets.
2251
+ #
2252
+ # If you're setting the event bus of another account as the target and
2253
+ # that account granted permission to your account through an
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*.
2258
+ #
2259
+ #
2260
+ #
2261
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
2262
+ #
2263
+ # @note When making an API call, you may pass Target
2264
+ # data as a hash:
2265
+ #
2266
+ # {
2267
+ # id: "TargetId", # required
2268
+ # arn: "TargetArn", # required
2269
+ # role_arn: "RoleArn",
2270
+ # input: "TargetInput",
2271
+ # input_path: "TargetInputPath",
2272
+ # input_transformer: {
2273
+ # input_paths_map: {
2274
+ # "InputTransformerPathKey" => "TargetInputPath",
2275
+ # },
2276
+ # input_template: "TransformerInput", # required
2277
+ # },
2278
+ # kinesis_parameters: {
2279
+ # partition_key_path: "TargetPartitionKeyPath", # required
2280
+ # },
2281
+ # run_command_parameters: {
2282
+ # run_command_targets: [ # required
2283
+ # {
2284
+ # key: "RunCommandTargetKey", # required
2285
+ # values: ["RunCommandTargetValue"], # required
2286
+ # },
2287
+ # ],
2288
+ # },
2289
+ # ecs_parameters: {
2290
+ # task_definition_arn: "Arn", # required
2291
+ # task_count: 1,
2292
+ # launch_type: "EC2", # accepts EC2, FARGATE
2293
+ # network_configuration: {
2294
+ # awsvpc_configuration: {
2295
+ # subnets: ["String"], # required
2296
+ # security_groups: ["String"],
2297
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
2298
+ # },
2299
+ # },
2300
+ # platform_version: "String",
2301
+ # group: "String",
2302
+ # },
2303
+ # batch_parameters: {
2304
+ # job_definition: "String", # required
2305
+ # job_name: "String", # required
2306
+ # array_properties: {
2307
+ # size: 1,
2308
+ # },
2309
+ # retry_strategy: {
2310
+ # attempts: 1,
2311
+ # },
2312
+ # },
2313
+ # sqs_parameters: {
2314
+ # message_group_id: "MessageGroupId",
2315
+ # },
2316
+ # }
2317
+ #
2318
+ # @!attribute [rw] id
2319
+ # The ID of the target.
2320
+ # @return [String]
2321
+ #
2322
+ # @!attribute [rw] arn
2323
+ # The Amazon Resource Name (ARN) of the target.
2324
+ # @return [String]
2325
+ #
2326
+ # @!attribute [rw] role_arn
2327
+ # The Amazon Resource Name (ARN) of the IAM role to be used for this
2328
+ # target when the rule is triggered. If one rule triggers multiple
2329
+ # targets, you can use a different IAM role for each target.
2330
+ # @return [String]
2331
+ #
2332
+ # @!attribute [rw] input
2333
+ # Valid JSON text passed to the target. In this case, nothing from the
2334
+ # event itself is passed to the target. For more information, see [The
2335
+ # JavaScript Object Notation (JSON) Data Interchange Format][1].
2336
+ #
2337
+ #
2338
+ #
2339
+ # [1]: http://www.rfc-editor.org/rfc/rfc7159.txt
2340
+ # @return [String]
2341
+ #
2342
+ # @!attribute [rw] input_path
2343
+ # The value of the JSONPath that is used for extracting part of the
2344
+ # matched event when passing it to the target. You must use JSON dot
2345
+ # notation, not bracket notation. For more information about JSON
2346
+ # paths, see [JSONPath][1].
2347
+ #
2348
+ #
2349
+ #
2350
+ # [1]: http://goessner.net/articles/JsonPath/
2351
+ # @return [String]
2352
+ #
2353
+ # @!attribute [rw] input_transformer
2354
+ # Settings to enable you to provide custom input to a target based on
2355
+ # certain event data. You can extract one or more key-value pairs from
2356
+ # the event and then use that data to send customized input to the
2357
+ # target.
2358
+ # @return [Types::InputTransformer]
2359
+ #
2360
+ # @!attribute [rw] kinesis_parameters
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.
2365
+ # @return [Types::KinesisParameters]
2366
+ #
2367
+ # @!attribute [rw] run_command_parameters
2368
+ # Parameters used when you are using the rule to invoke Amazon EC2 Run
2369
+ # Command.
2370
+ # @return [Types::RunCommandParameters]
2371
+ #
2372
+ # @!attribute [rw] ecs_parameters
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*.
2377
+ #
2378
+ #
2379
+ #
2380
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html
2381
+ # @return [Types::EcsParameters]
2382
+ #
2383
+ # @!attribute [rw] batch_parameters
2384
+ # If the event target is an AWS Batch job, this contains the job
2385
+ # definition, job name, and other parameters. For more information,
2386
+ # see [Jobs][1] in the *AWS Batch User Guide*.
2387
+ #
2388
+ #
2389
+ #
2390
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/jobs.html
2391
+ # @return [Types::BatchParameters]
2392
+ #
2393
+ # @!attribute [rw] sqs_parameters
2394
+ # Contains the message group ID to use when the target is a FIFO
2395
+ # queue.
2396
+ #
2397
+ # If you specify an SQS FIFO queue as a target, the queue must have
2398
+ # content-based deduplication enabled.
2399
+ # @return [Types::SqsParameters]
2400
+ #
2401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Target AWS API Documentation
2402
+ #
2403
+ class Target < Struct.new(
2404
+ :id,
2405
+ :arn,
2406
+ :role_arn,
2407
+ :input,
2408
+ :input_path,
2409
+ :input_transformer,
2410
+ :kinesis_parameters,
2411
+ :run_command_parameters,
2412
+ :ecs_parameters,
2413
+ :batch_parameters,
2414
+ :sqs_parameters)
2415
+ include Aws::Structure
2416
+ end
2417
+
2418
+ # @note When making an API call, you may pass TestEventPatternRequest
2419
+ # data as a hash:
2420
+ #
2421
+ # {
2422
+ # event_pattern: "EventPattern", # required
2423
+ # event: "String", # required
2424
+ # }
2425
+ #
2426
+ # @!attribute [rw] event_pattern
2427
+ # The event pattern. For more information, see [Event Patterns][1] in
2428
+ # the *Amazon EventBridge User Guide*.
2429
+ #
2430
+ #
2431
+ #
2432
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
2433
+ # @return [String]
2434
+ #
2435
+ # @!attribute [rw] event
2436
+ # The event, in JSON format, to test against the event pattern.
2437
+ # @return [String]
2438
+ #
2439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/TestEventPatternRequest AWS API Documentation
2440
+ #
2441
+ class TestEventPatternRequest < Struct.new(
2442
+ :event_pattern,
2443
+ :event)
2444
+ include Aws::Structure
2445
+ end
2446
+
2447
+ # @!attribute [rw] result
2448
+ # Indicates whether the event matches the event pattern.
2449
+ # @return [Boolean]
2450
+ #
2451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/TestEventPatternResponse AWS API Documentation
2452
+ #
2453
+ class TestEventPatternResponse < Struct.new(
2454
+ :result)
2455
+ include Aws::Structure
2456
+ end
2457
+
2458
+ # @note When making an API call, you may pass UntagResourceRequest
2459
+ # data as a hash:
2460
+ #
2461
+ # {
2462
+ # resource_arn: "Arn", # required
2463
+ # tag_keys: ["TagKey"], # required
2464
+ # }
2465
+ #
2466
+ # @!attribute [rw] resource_arn
2467
+ # The ARN of the rule that you're removing tags from.
2468
+ # @return [String]
2469
+ #
2470
+ # @!attribute [rw] tag_keys
2471
+ # The list of tag keys to remove from the resource.
2472
+ # @return [Array<String>]
2473
+ #
2474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UntagResourceRequest AWS API Documentation
2475
+ #
2476
+ class UntagResourceRequest < Struct.new(
2477
+ :resource_arn,
2478
+ :tag_keys)
2479
+ include Aws::Structure
2480
+ end
2481
+
2482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UntagResourceResponse AWS API Documentation
2483
+ #
2484
+ class UntagResourceResponse < Aws::EmptyStructure; end
2485
+
2486
+ end
2487
+ end