aws-sdk-eventbridgev2 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,3185 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::EventBridgeV2
11
+ module Types
12
+
13
+ # The caller does not have the permissions required to perform the
14
+ # operation. This error is also returned when the operation cannot use
15
+ # the AWS KMS key for the event bus.
16
+ #
17
+ # @!attribute [rw] message
18
+ # @return [String]
19
+ #
20
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/AccessDeniedException AWS API Documentation
21
+ #
22
+ class AccessDeniedException < Struct.new(
23
+ :message)
24
+ SENSITIVE = []
25
+ include Aws::Structure
26
+ end
27
+
28
+ # Configuration for forwarding a single AWS service's events from the
29
+ # account's default event bus.
30
+ #
31
+ # @!attribute [rw] aws_service
32
+ # A single AWS service source identifier, e.g. "aws.s3". Wildcards and
33
+ # lists are rejected.
34
+ # @return [String]
35
+ #
36
+ # @!attribute [rw] pattern
37
+ # A filter pattern, as a JSON string, that defines which of the
38
+ # service's events are forwarded to the event bus. Do not include
39
+ # source, account, or region as top-level fields. If no pattern is
40
+ # specified, all events from the service are forwarded.
41
+ # @return [String]
42
+ #
43
+ # @!attribute [rw] on_failure_configuration
44
+ # The destination for events that could not be forwarded.
45
+ # @return [Types::OnFailureConfiguration]
46
+ #
47
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/AwsServiceEventsSourceConfiguration AWS API Documentation
48
+ #
49
+ class AwsServiceEventsSourceConfiguration < Struct.new(
50
+ :aws_service,
51
+ :pattern,
52
+ :on_failure_configuration)
53
+ SENSITIVE = [:pattern]
54
+ include Aws::Structure
55
+ end
56
+
57
+ # Batching configuration for a subscriber.
58
+ #
59
+ # @!attribute [rw] max_batch_size
60
+ # The maximum number of events to include in a single batch delivered
61
+ # to the target. The service delivers up to this many events per
62
+ # batch; fewer may be delivered when the batch window elapses or the
63
+ # target's per-batch limit is smaller. This is a maximum, not a
64
+ # guaranteed count. Valid range is 1-500 (default: 10, or the target
65
+ # API's per-batch maximum). The resolved value applied by the service
66
+ # is returned on read.
67
+ # @return [Integer]
68
+ #
69
+ # @!attribute [rw] max_batch_window_in_seconds
70
+ # The maximum time in seconds to wait for a batch to fill before
71
+ # delivering it to the target. This is a maximum; a batch may be
72
+ # delivered sooner if it reaches MaxBatchSize or another delivery
73
+ # condition is met. Valid range is 0-300 (default: 0, meaning no
74
+ # wait). The resolved value applied by the service is always returned
75
+ # on read.
76
+ # @return [Integer]
77
+ #
78
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/BatchConfiguration AWS API Documentation
79
+ #
80
+ class BatchConfiguration < Struct.new(
81
+ :max_batch_size,
82
+ :max_batch_window_in_seconds)
83
+ SENSITIVE = []
84
+ include Aws::Structure
85
+ end
86
+
87
+ # Another change to the resource is already in progress. Retry the
88
+ # request.
89
+ #
90
+ # @!attribute [rw] message
91
+ # @return [String]
92
+ #
93
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ConcurrentModificationException AWS API Documentation
94
+ #
95
+ class ConcurrentModificationException < Struct.new(
96
+ :message)
97
+ SENSITIVE = []
98
+ include Aws::Structure
99
+ end
100
+
101
+ # A client-supplied precondition (e.g. ExpectedRevisionId on a
102
+ # resource-policy write) did not match the current state of the
103
+ # resource. Retrying the same request will fail again; re-read the
104
+ # resource and re-evaluate before retrying.
105
+ #
106
+ # A conditional request is not retry-safe on its own. If an earlier
107
+ # attempt committed but its response never reached the caller, retrying
108
+ # fails with this error, which is indistinguishable from another writer
109
+ # having won. Compare the resource's current contents with what the
110
+ # request intended: a successful attempt stores a revision ID the caller
111
+ # never saw, so the revision alone cannot tell the two apart, but
112
+ # matching contents mean the change took effect.
113
+ #
114
+ # @!attribute [rw] message
115
+ # @return [String]
116
+ #
117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ConflictException AWS API Documentation
118
+ #
119
+ class ConflictException < Struct.new(
120
+ :message)
121
+ SENSITIVE = []
122
+ include Aws::Structure
123
+ end
124
+
125
+ # Authentication configuration for public Confluent Schema Registry via
126
+ # EventBridge Connection.
127
+ #
128
+ # @!attribute [rw] connection_arn
129
+ # EventBridge Connection ARN that provides API Key or OAuth
130
+ # credentials for the registry.
131
+ # @return [String]
132
+ #
133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ConfluentPublicRegistryConfiguration AWS API Documentation
134
+ #
135
+ class ConfluentPublicRegistryConfiguration < Struct.new(
136
+ :connection_arn)
137
+ SENSITIVE = []
138
+ include Aws::Structure
139
+ end
140
+
141
+ # @!attribute [rw] name
142
+ # Name of an event bus. The first character must be alphanumeric; the
143
+ # remaining characters may also include '.', '-', and '\_'. The
144
+ # grammar matches the name segment of EventBusArn
145
+ # (event-busv2/<name>/<id>), so every valid name can be represented in
146
+ # the bus's ARN. The same type is used everywhere a bus name
147
+ # appears.</p> </id></name>
148
+ # @return [String]
149
+ #
150
+ # @!attribute [rw] description
151
+ # Free-text description. Used by every resource type that has one:
152
+ # event buses, subscribers, and event sources.
153
+ # @return [String]
154
+ #
155
+ # @!attribute [rw] encryption_configuration
156
+ # Encryption configuration for an event bus.
157
+ # @return [Types::EncryptionConfiguration]
158
+ #
159
+ # @!attribute [rw] storage_configuration
160
+ # Event storage configuration for an event bus.
161
+ # @return [Types::StorageConfiguration]
162
+ #
163
+ # @!attribute [rw] tags
164
+ # Tags attached to a resource, as key-value pairs.
165
+ # @return [Hash<String,String>]
166
+ #
167
+ # @!attribute [rw] client_token
168
+ # Unique, case-sensitive identifier that ensures the idempotency of
169
+ # the request. The SDK generates one automatically when the field is
170
+ # omitted.
171
+ #
172
+ # **A suitable default value is auto-generated.** You should normally
173
+ # not need to pass this option.
174
+ # @return [String]
175
+ #
176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/CreateEventBusRequest AWS API Documentation
177
+ #
178
+ class CreateEventBusRequest < Struct.new(
179
+ :name,
180
+ :description,
181
+ :encryption_configuration,
182
+ :storage_configuration,
183
+ :tags,
184
+ :client_token)
185
+ SENSITIVE = []
186
+ include Aws::Structure
187
+ end
188
+
189
+ # @!attribute [rw] event_bus_arn
190
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
191
+ # bus.
192
+ # @return [String]
193
+ #
194
+ # @!attribute [rw] name
195
+ # Name of an event bus. The first character must be alphanumeric; the
196
+ # remaining characters may also include '.', '-', and '\_'. The
197
+ # grammar matches the name segment of EventBusArn
198
+ # (event-busv2/<name>/<id>), so every valid name can be represented in
199
+ # the bus's ARN. The same type is used everywhere a bus name
200
+ # appears.</p> </id></name>
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] description
204
+ # Free-text description. Used by every resource type that has one:
205
+ # event buses, subscribers, and event sources.
206
+ # @return [String]
207
+ #
208
+ # @!attribute [rw] encryption_configuration
209
+ # Encryption configuration for an event bus.
210
+ # @return [Types::EncryptionConfiguration]
211
+ #
212
+ # @!attribute [rw] storage_configuration
213
+ # Event storage configuration of an event bus, as returned on reads.
214
+ # @return [Types::StorageConfigurationOutput]
215
+ #
216
+ # @!attribute [rw] state
217
+ # Lifecycle state of an event bus.
218
+ #
219
+ # * CREATING: Bus creation is in progress.
220
+ # * CREATE\_FAILED: Bus creation failed; see StateReason. The bus
221
+ # cannot be recovered or recreated in place: delete it with
222
+ # DeleteEventBus, then create a new bus.
223
+ # * ACTIVE: Bus is fully operational and can accept events.
224
+ # * UPDATING: Bus update is in progress.
225
+ # * UPDATE\_FAILED: Bus update failed; the bus remains operational
226
+ # with its previous configuration.
227
+ # * DELETING: Bus deletion is actively in progress.
228
+ # * DELETE\_FAILED: Bus deletion failed; see StateReason. Retry
229
+ # DeleteEventBus after removing subscribers and event sources.
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] state_reason
233
+ # Human-readable explanation of why an event bus is in its current
234
+ # State. Omitted when the bus is in a normal operational state
235
+ # (ACTIVE). It stands in for the error response an asynchronous
236
+ # failure cannot return, so it applies only to resources with an
237
+ # asynchronous lifecycle: event buses. EventSources and subscribers
238
+ # are provisioned synchronously and report failures directly on the
239
+ # request.
240
+ # @return [String]
241
+ #
242
+ # @!attribute [rw] creation_time
243
+ # The time the event bus was created.
244
+ # @return [Time]
245
+ #
246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/CreateEventBusResponse AWS API Documentation
247
+ #
248
+ class CreateEventBusResponse < Struct.new(
249
+ :event_bus_arn,
250
+ :name,
251
+ :description,
252
+ :encryption_configuration,
253
+ :storage_configuration,
254
+ :state,
255
+ :state_reason,
256
+ :creation_time)
257
+ SENSITIVE = []
258
+ include Aws::Structure
259
+ end
260
+
261
+ # @!attribute [rw] name
262
+ # EventSource name. First character alphanumeric; the rest may add
263
+ # '.', '-', '\_'. Names may not begin with the reserved "aws."
264
+ # prefix. The grammar matches the ARN local-name segment in
265
+ # EventSourceArn (event-sourcev2/<type>/<name>/<id>), mirroring
266
+ # EventBusName, so a name the ARN cannot represent cannot be
267
+ # created.</p> </id></name></type>
268
+ # @return [String]
269
+ #
270
+ # @!attribute [rw] event_bus_arn
271
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
272
+ # bus.
273
+ # @return [String]
274
+ #
275
+ # @!attribute [rw] configuration
276
+ # Discriminated EventSource configuration. Exactly one variant must be
277
+ # set.
278
+ # @return [Types::EventSourceConfiguration]
279
+ #
280
+ # @!attribute [rw] description
281
+ # Free-text description. Used by every resource type that has one:
282
+ # event buses, subscribers, and event sources.
283
+ # @return [String]
284
+ #
285
+ # @!attribute [rw] tags
286
+ # Tags attached to a resource, as key-value pairs.
287
+ # @return [Hash<String,String>]
288
+ #
289
+ # @!attribute [rw] client_token
290
+ # Unique, case-sensitive identifier that ensures the idempotency of
291
+ # the request. The SDK generates one automatically when the field is
292
+ # omitted.
293
+ #
294
+ # **A suitable default value is auto-generated.** You should normally
295
+ # not need to pass this option.
296
+ # @return [String]
297
+ #
298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/CreateEventSourceRequest AWS API Documentation
299
+ #
300
+ class CreateEventSourceRequest < Struct.new(
301
+ :name,
302
+ :event_bus_arn,
303
+ :configuration,
304
+ :description,
305
+ :tags,
306
+ :client_token)
307
+ SENSITIVE = []
308
+ include Aws::Structure
309
+ end
310
+
311
+ # @!attribute [rw] event_source_arn
312
+ # EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
313
+ # is set by the service (aws.service for AWS service events,
314
+ # aws.partner for partner events) and is not part of the resource's
315
+ # name. The id segment is a 25-character identifier generated by the
316
+ # service.</p> </id></name></type>
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] name
320
+ # EventSource name. First character alphanumeric; the rest may add
321
+ # '.', '-', '\_'. Names may not begin with the reserved "aws."
322
+ # prefix. The grammar matches the ARN local-name segment in
323
+ # EventSourceArn (event-sourcev2/<type>/<name>/<id>), mirroring
324
+ # EventBusName, so a name the ARN cannot represent cannot be
325
+ # created.</p> </id></name></type>
326
+ # @return [String]
327
+ #
328
+ # @!attribute [rw] event_bus_arn
329
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
330
+ # bus.
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] state
334
+ # Lifecycle state of an EventSource. Revocation is reported by the
335
+ # Revoked flag.
336
+ # @return [String]
337
+ #
338
+ # @!attribute [rw] creation_time
339
+ # The time the EventSource was created.
340
+ # @return [Time]
341
+ #
342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/CreateEventSourceResponse AWS API Documentation
343
+ #
344
+ class CreateEventSourceResponse < Struct.new(
345
+ :event_source_arn,
346
+ :name,
347
+ :event_bus_arn,
348
+ :state,
349
+ :creation_time)
350
+ SENSITIVE = []
351
+ include Aws::Structure
352
+ end
353
+
354
+ # @!attribute [rw] name
355
+ # Name of a subscriber. The first character must be alphanumeric; the
356
+ # remaining characters may also include '.', '-', and '\_'.
357
+ # @return [String]
358
+ #
359
+ # @!attribute [rw] event_bus_arn
360
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
361
+ # bus.
362
+ # @return [String]
363
+ #
364
+ # @!attribute [rw] invoke_configuration
365
+ # Configuration for how the subscriber invokes its target.
366
+ # @return [Types::InvokeConfiguration]
367
+ #
368
+ # @!attribute [rw] description
369
+ # Free-text description. Used by every resource type that has one:
370
+ # event buses, subscribers, and event sources.
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] filter_configuration
374
+ # Configuration for filtering events delivered to a subscriber. On
375
+ # CreateSubscriber, Filters is required and must contain at least one
376
+ # Filter with a non-empty Pattern. On UpdateSubscriber, an empty
377
+ # `FilterConfiguration:{}` clears the existing filter. Any non-empty
378
+ # shape (including `{Language:X}` without Filters) must contain a
379
+ # valid Filters list — same contract as CreateSubscriber. A non-empty
380
+ # Filters list overwrites; an omitted FilterConfiguration preserves
381
+ # existing state. All Filters are implicitly ANDed — an event must
382
+ # match every Filter to be delivered.
383
+ # @return [Types::FilterConfiguration]
384
+ #
385
+ # @!attribute [rw] type
386
+ # Delivery ordering mode of a subscriber: FIFO delivers events in
387
+ # order within an event group; UNORDERED delivers without an ordering
388
+ # guarantee.
389
+ # @return [String]
390
+ #
391
+ # @!attribute [rw] starting_position
392
+ # Starting position for a subscriber.
393
+ # @return [String]
394
+ #
395
+ # @!attribute [rw] point_in_time_configuration
396
+ # Point-in-time configuration for a subscriber. Only applicable when
397
+ # StartingPosition is POINT\_IN\_TIME.
398
+ # @return [Types::PointInTimeConfiguration]
399
+ #
400
+ # @!attribute [rw] batch_configuration
401
+ # Batching configuration for a subscriber.
402
+ # @return [Types::BatchConfiguration]
403
+ #
404
+ # @!attribute [rw] transformer
405
+ # Not applicable to universal (aws-sdk) targets, whose input
406
+ # transformation is UniversalTargetParameters.Input; a Transformer on
407
+ # such a target is rejected.
408
+ # @return [Types::Transformer]
409
+ #
410
+ # @!attribute [rw] retry_policy
411
+ # Retry policy for a subscriber.
412
+ # @return [Types::RetryPolicy]
413
+ #
414
+ # @!attribute [rw] on_failure_configuration
415
+ # On-failure configuration: where a failed delivery is sent. Shared by
416
+ # the subscriber and the EventSource.
417
+ # @return [Types::OnFailureConfiguration]
418
+ #
419
+ # @!attribute [rw] log_configuration
420
+ # Log configuration for a subscriber.
421
+ # @return [Types::LogConfiguration]
422
+ #
423
+ # @!attribute [rw] state
424
+ # Customer-controlled run state of a subscriber, set on create or
425
+ # update. Distinct from the bus lifecycle vocabulary, where ACTIVE
426
+ # means "provisioned and healthy". Delivery requires State RUNNING on
427
+ # a subscriber that is not revoked.
428
+ # @return [String]
429
+ #
430
+ # @!attribute [rw] tags
431
+ # Tags attached to a resource, as key-value pairs.
432
+ # @return [Hash<String,String>]
433
+ #
434
+ # @!attribute [rw] client_token
435
+ # Unique, case-sensitive identifier that ensures the idempotency of
436
+ # the request. The SDK generates one automatically when the field is
437
+ # omitted.
438
+ #
439
+ # **A suitable default value is auto-generated.** You should normally
440
+ # not need to pass this option.
441
+ # @return [String]
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/CreateSubscriberRequest AWS API Documentation
444
+ #
445
+ class CreateSubscriberRequest < Struct.new(
446
+ :name,
447
+ :event_bus_arn,
448
+ :invoke_configuration,
449
+ :description,
450
+ :filter_configuration,
451
+ :type,
452
+ :starting_position,
453
+ :point_in_time_configuration,
454
+ :batch_configuration,
455
+ :transformer,
456
+ :retry_policy,
457
+ :on_failure_configuration,
458
+ :log_configuration,
459
+ :state,
460
+ :tags,
461
+ :client_token)
462
+ SENSITIVE = []
463
+ include Aws::Structure
464
+ end
465
+
466
+ # @!attribute [rw] subscriber_arn
467
+ # The Amazon Resource Name (ARN) that uniquely identifies a
468
+ # subscriber.
469
+ # @return [String]
470
+ #
471
+ # @!attribute [rw] name
472
+ # Name of a subscriber. The first character must be alphanumeric; the
473
+ # remaining characters may also include '.', '-', and '\_'.
474
+ # @return [String]
475
+ #
476
+ # @!attribute [rw] event_bus_arn
477
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
478
+ # bus.
479
+ # @return [String]
480
+ #
481
+ # @!attribute [rw] type
482
+ # Delivery ordering mode of a subscriber: FIFO delivers events in
483
+ # order within an event group; UNORDERED delivers without an ordering
484
+ # guarantee.
485
+ # @return [String]
486
+ #
487
+ # @!attribute [rw] starting_position
488
+ # Starting position for a subscriber.
489
+ # @return [String]
490
+ #
491
+ # @!attribute [rw] point_in_time_configuration
492
+ # Point-in-time configuration for a subscriber. Only applicable when
493
+ # StartingPosition is POINT\_IN\_TIME.
494
+ # @return [Types::PointInTimeConfiguration]
495
+ #
496
+ # @!attribute [rw] state
497
+ # Customer-controlled run state of a subscriber, set on create or
498
+ # update. Distinct from the bus lifecycle vocabulary, where ACTIVE
499
+ # means "provisioned and healthy". Delivery requires State RUNNING on
500
+ # a subscriber that is not revoked.
501
+ # @return [String]
502
+ #
503
+ # @!attribute [rw] creation_time
504
+ # The time the subscriber was created.
505
+ # @return [Time]
506
+ #
507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/CreateSubscriberResponse AWS API Documentation
508
+ #
509
+ class CreateSubscriberResponse < Struct.new(
510
+ :subscriber_arn,
511
+ :name,
512
+ :event_bus_arn,
513
+ :type,
514
+ :starting_position,
515
+ :point_in_time_configuration,
516
+ :state,
517
+ :creation_time)
518
+ SENSITIVE = []
519
+ include Aws::Structure
520
+ end
521
+
522
+ # Deduplication settings for a publish request.
523
+ #
524
+ # @!attribute [rw] deduplication_type
525
+ # How duplicate events are detected: by a hash of the event content
526
+ # (CONTENT\_BASED). To deduplicate by a caller-supplied token instead,
527
+ # omit DeduplicationConfiguration and set DeduplicationId on each
528
+ # entry.
529
+ # @return [String]
530
+ #
531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeduplicationConfiguration AWS API Documentation
532
+ #
533
+ class DeduplicationConfiguration < Struct.new(
534
+ :deduplication_type)
535
+ SENSITIVE = []
536
+ include Aws::Structure
537
+ end
538
+
539
+ # @!attribute [rw] event_bus_arn
540
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
541
+ # bus.
542
+ # @return [String]
543
+ #
544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteEventBusRequest AWS API Documentation
545
+ #
546
+ class DeleteEventBusRequest < Struct.new(
547
+ :event_bus_arn)
548
+ SENSITIVE = []
549
+ include Aws::Structure
550
+ end
551
+
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteEventBusResponse AWS API Documentation
553
+ #
554
+ class DeleteEventBusResponse < Aws::EmptyStructure; end
555
+
556
+ # @!attribute [rw] event_source_arn
557
+ # EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
558
+ # is set by the service (aws.service for AWS service events,
559
+ # aws.partner for partner events) and is not part of the resource's
560
+ # name. The id segment is a 25-character identifier generated by the
561
+ # service.</p> </id></name></type>
562
+ # @return [String]
563
+ #
564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteEventSourceRequest AWS API Documentation
565
+ #
566
+ class DeleteEventSourceRequest < Struct.new(
567
+ :event_source_arn)
568
+ SENSITIVE = []
569
+ include Aws::Structure
570
+ end
571
+
572
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteEventSourceResponse AWS API Documentation
573
+ #
574
+ class DeleteEventSourceResponse < Aws::EmptyStructure; end
575
+
576
+ # @!attribute [rw] resource_arn
577
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
578
+ # bus.
579
+ # @return [String]
580
+ #
581
+ # @!attribute [rw] policy_name
582
+ # Which named policy to delete. Defaults to "default" when omitted (a
583
+ # delete AWS Resource Access Manager makes on the owner's behalf
584
+ # resolves to "AWS\_RAM" instead). The two writers are exclusive in
585
+ # both directions — only Resource Access Manager can delete
586
+ # "AWS\_RAM", and only the bus owner can delete "default" — so naming
587
+ # the other party's policy fails with AccessDeniedException. A
588
+ # well-formed name that is neither of the two fails with
589
+ # InvalidInputException.
590
+ # @return [String]
591
+ #
592
+ # @!attribute [rw] expected_revision_id
593
+ # The delete succeeds only if the named policy's current revision ID
594
+ # matches this value; if it differs or the policy does not exist, the
595
+ # operation fails with ConflictException. The "NO\_POLICY" sentinel is
596
+ # not valid here. When omitted, deleting an absent policy is an
597
+ # idempotent success. Supplying this value makes the delete
598
+ # non-idempotent: once it succeeds the expected revision no longer
599
+ # exists, so retrying an unanswered request fails with
600
+ # ConflictException even though the policy was deleted. To establish
601
+ # the outcome, read the policy back: ResourceNotFoundException means
602
+ # the delete took effect.
603
+ # @return [String]
604
+ #
605
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteResourcePolicyRequest AWS API Documentation
606
+ #
607
+ class DeleteResourcePolicyRequest < Struct.new(
608
+ :resource_arn,
609
+ :policy_name,
610
+ :expected_revision_id)
611
+ SENSITIVE = []
612
+ include Aws::Structure
613
+ end
614
+
615
+ # @!attribute [rw] revision_id
616
+ # Revision ID of the policy that was deleted. Absent when no policy
617
+ # was deleted.
618
+ # @return [String]
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteResourcePolicyResponse AWS API Documentation
621
+ #
622
+ class DeleteResourcePolicyResponse < Struct.new(
623
+ :revision_id)
624
+ SENSITIVE = []
625
+ include Aws::Structure
626
+ end
627
+
628
+ # @!attribute [rw] subscriber_arn
629
+ # The Amazon Resource Name (ARN) that uniquely identifies a
630
+ # subscriber.
631
+ # @return [String]
632
+ #
633
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteSubscriberRequest AWS API Documentation
634
+ #
635
+ class DeleteSubscriberRequest < Struct.new(
636
+ :subscriber_arn)
637
+ SENSITIVE = []
638
+ include Aws::Structure
639
+ end
640
+
641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DeleteSubscriberResponse AWS API Documentation
642
+ #
643
+ class DeleteSubscriberResponse < Aws::EmptyStructure; end
644
+
645
+ # @!attribute [rw] event_bus_arn
646
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
647
+ # bus.
648
+ # @return [String]
649
+ #
650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DescribeEventBusRequest AWS API Documentation
651
+ #
652
+ class DescribeEventBusRequest < Struct.new(
653
+ :event_bus_arn)
654
+ SENSITIVE = []
655
+ include Aws::Structure
656
+ end
657
+
658
+ # @!attribute [rw] event_bus_arn
659
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
660
+ # bus.
661
+ # @return [String]
662
+ #
663
+ # @!attribute [rw] name
664
+ # Name of an event bus. The first character must be alphanumeric; the
665
+ # remaining characters may also include '.', '-', and '\_'. The
666
+ # grammar matches the name segment of EventBusArn
667
+ # (event-busv2/<name>/<id>), so every valid name can be represented in
668
+ # the bus's ARN. The same type is used everywhere a bus name
669
+ # appears.</p> </id></name>
670
+ # @return [String]
671
+ #
672
+ # @!attribute [rw] description
673
+ # Free-text description. Used by every resource type that has one:
674
+ # event buses, subscribers, and event sources.
675
+ # @return [String]
676
+ #
677
+ # @!attribute [rw] encryption_configuration
678
+ # Encryption configuration for an event bus.
679
+ # @return [Types::EncryptionConfiguration]
680
+ #
681
+ # @!attribute [rw] storage_configuration
682
+ # Event storage configuration of an event bus, as returned on reads.
683
+ # @return [Types::StorageConfigurationOutput]
684
+ #
685
+ # @!attribute [rw] creation_time
686
+ # The time the event bus was created.
687
+ # @return [Time]
688
+ #
689
+ # @!attribute [rw] last_modified_time
690
+ # The time the event bus was last modified.
691
+ # @return [Time]
692
+ #
693
+ # @!attribute [rw] state
694
+ # Lifecycle state of an event bus.
695
+ #
696
+ # * CREATING: Bus creation is in progress.
697
+ # * CREATE\_FAILED: Bus creation failed; see StateReason. The bus
698
+ # cannot be recovered or recreated in place: delete it with
699
+ # DeleteEventBus, then create a new bus.
700
+ # * ACTIVE: Bus is fully operational and can accept events.
701
+ # * UPDATING: Bus update is in progress.
702
+ # * UPDATE\_FAILED: Bus update failed; the bus remains operational
703
+ # with its previous configuration.
704
+ # * DELETING: Bus deletion is actively in progress.
705
+ # * DELETE\_FAILED: Bus deletion failed; see StateReason. Retry
706
+ # DeleteEventBus after removing subscribers and event sources.
707
+ # @return [String]
708
+ #
709
+ # @!attribute [rw] state_reason
710
+ # Human-readable explanation of why an event bus is in its current
711
+ # State. Omitted when the bus is in a normal operational state
712
+ # (ACTIVE). It stands in for the error response an asynchronous
713
+ # failure cannot return, so it applies only to resources with an
714
+ # asynchronous lifecycle: event buses. EventSources and subscribers
715
+ # are provisioned synchronously and report failures directly on the
716
+ # request.
717
+ # @return [String]
718
+ #
719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DescribeEventBusResponse AWS API Documentation
720
+ #
721
+ class DescribeEventBusResponse < Struct.new(
722
+ :event_bus_arn,
723
+ :name,
724
+ :description,
725
+ :encryption_configuration,
726
+ :storage_configuration,
727
+ :creation_time,
728
+ :last_modified_time,
729
+ :state,
730
+ :state_reason)
731
+ SENSITIVE = []
732
+ include Aws::Structure
733
+ end
734
+
735
+ # @!attribute [rw] event_source_arn
736
+ # EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
737
+ # is set by the service (aws.service for AWS service events,
738
+ # aws.partner for partner events) and is not part of the resource's
739
+ # name. The id segment is a 25-character identifier generated by the
740
+ # service.</p> </id></name></type>
741
+ # @return [String]
742
+ #
743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DescribeEventSourceRequest AWS API Documentation
744
+ #
745
+ class DescribeEventSourceRequest < Struct.new(
746
+ :event_source_arn)
747
+ SENSITIVE = []
748
+ include Aws::Structure
749
+ end
750
+
751
+ # @!attribute [rw] event_source_arn
752
+ # EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
753
+ # is set by the service (aws.service for AWS service events,
754
+ # aws.partner for partner events) and is not part of the resource's
755
+ # name. The id segment is a 25-character identifier generated by the
756
+ # service.</p> </id></name></type>
757
+ # @return [String]
758
+ #
759
+ # @!attribute [rw] name
760
+ # EventSource name. First character alphanumeric; the rest may add
761
+ # '.', '-', '\_'. Names may not begin with the reserved "aws."
762
+ # prefix. The grammar matches the ARN local-name segment in
763
+ # EventSourceArn (event-sourcev2/<type>/<name>/<id>), mirroring
764
+ # EventBusName, so a name the ARN cannot represent cannot be
765
+ # created.</p> </id></name></type>
766
+ # @return [String]
767
+ #
768
+ # @!attribute [rw] event_bus_arn
769
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
770
+ # bus.
771
+ # @return [String]
772
+ #
773
+ # @!attribute [rw] configuration
774
+ # Discriminated EventSource configuration. Exactly one variant must be
775
+ # set.
776
+ # @return [Types::EventSourceConfiguration]
777
+ #
778
+ # @!attribute [rw] description
779
+ # Free-text description. Used by every resource type that has one:
780
+ # event buses, subscribers, and event sources.
781
+ # @return [String]
782
+ #
783
+ # @!attribute [rw] state
784
+ # Lifecycle state of an EventSource. Revocation is reported by the
785
+ # Revoked flag.
786
+ # @return [String]
787
+ #
788
+ # @!attribute [rw] revoked
789
+ # True when the bus owner has withdrawn this EventSource. Present only
790
+ # when true, so an absent member means the EventSource is not revoked.
791
+ # Revocation is terminal: it never returns to false. Mutating
792
+ # operations on a revoked EventSource fail with InvalidStateException,
793
+ # except DeleteEventSource, which stays available so a revoked
794
+ # EventSource can still be cleaned up.
795
+ # @return [Boolean]
796
+ #
797
+ # @!attribute [rw] creation_time
798
+ # The time the EventSource was created.
799
+ # @return [Time]
800
+ #
801
+ # @!attribute [rw] last_modified_time
802
+ # The time the EventSource was last modified.
803
+ # @return [Time]
804
+ #
805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DescribeEventSourceResponse AWS API Documentation
806
+ #
807
+ class DescribeEventSourceResponse < Struct.new(
808
+ :event_source_arn,
809
+ :name,
810
+ :event_bus_arn,
811
+ :configuration,
812
+ :description,
813
+ :state,
814
+ :revoked,
815
+ :creation_time,
816
+ :last_modified_time)
817
+ SENSITIVE = []
818
+ include Aws::Structure
819
+ end
820
+
821
+ # @!attribute [rw] subscriber_arn
822
+ # The Amazon Resource Name (ARN) that uniquely identifies a
823
+ # subscriber.
824
+ # @return [String]
825
+ #
826
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DescribeSubscriberRequest AWS API Documentation
827
+ #
828
+ class DescribeSubscriberRequest < Struct.new(
829
+ :subscriber_arn)
830
+ SENSITIVE = []
831
+ include Aws::Structure
832
+ end
833
+
834
+ # @!attribute [rw] subscriber_arn
835
+ # The Amazon Resource Name (ARN) that uniquely identifies a
836
+ # subscriber.
837
+ # @return [String]
838
+ #
839
+ # @!attribute [rw] name
840
+ # Name of a subscriber. The first character must be alphanumeric; the
841
+ # remaining characters may also include '.', '-', and '\_'.
842
+ # @return [String]
843
+ #
844
+ # @!attribute [rw] event_bus_arn
845
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
846
+ # bus.
847
+ # @return [String]
848
+ #
849
+ # @!attribute [rw] invoke_configuration
850
+ # Configuration for how the subscriber invokes its target.
851
+ # @return [Types::InvokeConfiguration]
852
+ #
853
+ # @!attribute [rw] description
854
+ # Free-text description. Used by every resource type that has one:
855
+ # event buses, subscribers, and event sources.
856
+ # @return [String]
857
+ #
858
+ # @!attribute [rw] filter_configuration
859
+ # Configuration for filtering events delivered to a subscriber. On
860
+ # CreateSubscriber, Filters is required and must contain at least one
861
+ # Filter with a non-empty Pattern. On UpdateSubscriber, an empty
862
+ # `FilterConfiguration:{}` clears the existing filter. Any non-empty
863
+ # shape (including `{Language:X}` without Filters) must contain a
864
+ # valid Filters list — same contract as CreateSubscriber. A non-empty
865
+ # Filters list overwrites; an omitted FilterConfiguration preserves
866
+ # existing state. All Filters are implicitly ANDed — an event must
867
+ # match every Filter to be delivered.
868
+ # @return [Types::FilterConfiguration]
869
+ #
870
+ # @!attribute [rw] type
871
+ # Delivery ordering mode of a subscriber: FIFO delivers events in
872
+ # order within an event group; UNORDERED delivers without an ordering
873
+ # guarantee.
874
+ # @return [String]
875
+ #
876
+ # @!attribute [rw] starting_position
877
+ # Starting position for a subscriber.
878
+ # @return [String]
879
+ #
880
+ # @!attribute [rw] point_in_time_configuration
881
+ # Point-in-time configuration for a subscriber. Only applicable when
882
+ # StartingPosition is POINT\_IN\_TIME.
883
+ # @return [Types::PointInTimeConfiguration]
884
+ #
885
+ # @!attribute [rw] batch_configuration
886
+ # Batching configuration for a subscriber.
887
+ # @return [Types::BatchConfiguration]
888
+ #
889
+ # @!attribute [rw] transformer
890
+ # Absent for universal (aws-sdk) targets, whose input transformation
891
+ # is UniversalTargetParameters.Input.
892
+ # @return [Types::Transformer]
893
+ #
894
+ # @!attribute [rw] retry_policy
895
+ # Retry policy for a subscriber.
896
+ # @return [Types::RetryPolicy]
897
+ #
898
+ # @!attribute [rw] on_failure_configuration
899
+ # On-failure configuration: where a failed delivery is sent. Shared by
900
+ # the subscriber and the EventSource.
901
+ # @return [Types::OnFailureConfiguration]
902
+ #
903
+ # @!attribute [rw] log_configuration
904
+ # Log configuration for a subscriber.
905
+ # @return [Types::LogConfiguration]
906
+ #
907
+ # @!attribute [rw] state
908
+ # Customer-controlled run state of a subscriber, set on create or
909
+ # update. Distinct from the bus lifecycle vocabulary, where ACTIVE
910
+ # means "provisioned and healthy". Delivery requires State RUNNING on
911
+ # a subscriber that is not revoked.
912
+ # @return [String]
913
+ #
914
+ # @!attribute [rw] revoked
915
+ # True when the bus owner has revoked this subscriber. Present only
916
+ # when true, so an absent member means the subscriber is not revoked.
917
+ # Revocation is terminal: it never returns to false. Mutating
918
+ # operations on a revoked subscriber fail with InvalidStateException,
919
+ # except DeleteSubscriber, which stays available so a revoked
920
+ # subscriber can still be cleaned up.
921
+ # @return [Boolean]
922
+ #
923
+ # @!attribute [rw] creation_time
924
+ # The time the subscriber was created.
925
+ # @return [Time]
926
+ #
927
+ # @!attribute [rw] last_modified_time
928
+ # The time the subscriber was last modified.
929
+ # @return [Time]
930
+ #
931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/DescribeSubscriberResponse AWS API Documentation
932
+ #
933
+ class DescribeSubscriberResponse < Struct.new(
934
+ :subscriber_arn,
935
+ :name,
936
+ :event_bus_arn,
937
+ :invoke_configuration,
938
+ :description,
939
+ :filter_configuration,
940
+ :type,
941
+ :starting_position,
942
+ :point_in_time_configuration,
943
+ :batch_configuration,
944
+ :transformer,
945
+ :retry_policy,
946
+ :on_failure_configuration,
947
+ :log_configuration,
948
+ :state,
949
+ :revoked,
950
+ :creation_time,
951
+ :last_modified_time)
952
+ SENSITIVE = []
953
+ include Aws::Structure
954
+ end
955
+
956
+ # Encryption configuration for an event bus.
957
+ #
958
+ # @!attribute [rw] kms_key_identifier
959
+ # Identifier of the AWS KMS customer managed key used to encrypt
960
+ # events: a key ID, key ARN, alias name, or alias ARN. When absent,
961
+ # events are encrypted with an AWS owned key.
962
+ # @return [String]
963
+ #
964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/EncryptionConfiguration AWS API Documentation
965
+ #
966
+ class EncryptionConfiguration < Struct.new(
967
+ :kms_key_identifier)
968
+ SENSITIVE = []
969
+ include Aws::Structure
970
+ end
971
+
972
+ # Summary of an event bus, as returned by ListEventBuses.
973
+ #
974
+ # @!attribute [rw] name
975
+ # Name of an event bus. The first character must be alphanumeric; the
976
+ # remaining characters may also include '.', '-', and '\_'. The
977
+ # grammar matches the name segment of EventBusArn
978
+ # (event-busv2/<name>/<id>), so every valid name can be represented in
979
+ # the bus's ARN. The same type is used everywhere a bus name
980
+ # appears.</p> </id></name>
981
+ # @return [String]
982
+ #
983
+ # @!attribute [rw] event_bus_arn
984
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
985
+ # bus.
986
+ # @return [String]
987
+ #
988
+ # @!attribute [rw] description
989
+ # Free-text description. Used by every resource type that has one:
990
+ # event buses, subscribers, and event sources.
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] creation_time
994
+ # The time the event bus was created.
995
+ # @return [Time]
996
+ #
997
+ # @!attribute [rw] last_modified_time
998
+ # The time the event bus was last modified.
999
+ # @return [Time]
1000
+ #
1001
+ # @!attribute [rw] state
1002
+ # Lifecycle state of an event bus.
1003
+ #
1004
+ # * CREATING: Bus creation is in progress.
1005
+ # * CREATE\_FAILED: Bus creation failed; see StateReason. The bus
1006
+ # cannot be recovered or recreated in place: delete it with
1007
+ # DeleteEventBus, then create a new bus.
1008
+ # * ACTIVE: Bus is fully operational and can accept events.
1009
+ # * UPDATING: Bus update is in progress.
1010
+ # * UPDATE\_FAILED: Bus update failed; the bus remains operational
1011
+ # with its previous configuration.
1012
+ # * DELETING: Bus deletion is actively in progress.
1013
+ # * DELETE\_FAILED: Bus deletion failed; see StateReason. Retry
1014
+ # DeleteEventBus after removing subscribers and event sources.
1015
+ # @return [String]
1016
+ #
1017
+ # @!attribute [rw] state_reason
1018
+ # Human-readable explanation of why an event bus is in its current
1019
+ # State. Omitted when the bus is in a normal operational state
1020
+ # (ACTIVE). It stands in for the error response an asynchronous
1021
+ # failure cannot return, so it applies only to resources with an
1022
+ # asynchronous lifecycle: event buses. EventSources and subscribers
1023
+ # are provisioned synchronously and report failures directly on the
1024
+ # request.
1025
+ # @return [String]
1026
+ #
1027
+ # @!attribute [rw] event_bus_account_id
1028
+ # AWS Account Id.
1029
+ # @return [String]
1030
+ #
1031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/EventBusSummary AWS API Documentation
1032
+ #
1033
+ class EventBusSummary < Struct.new(
1034
+ :name,
1035
+ :event_bus_arn,
1036
+ :description,
1037
+ :creation_time,
1038
+ :last_modified_time,
1039
+ :state,
1040
+ :state_reason,
1041
+ :event_bus_account_id)
1042
+ SENSITIVE = []
1043
+ include Aws::Structure
1044
+ end
1045
+
1046
+ # Parameters for forwarding events to another EventBridge event bus.
1047
+ #
1048
+ # @!attribute [rw] metadata
1049
+ # Customer-defined metadata forwarded with each event.
1050
+ # @return [Hash<String,String>]
1051
+ #
1052
+ # @!attribute [rw] system_metadata
1053
+ # Customer-controllable system metadata attached to each forwarded
1054
+ # event.
1055
+ # @return [Types::EventBusV2SystemMetadata]
1056
+ #
1057
+ # @!attribute [rw] deduplication_configuration
1058
+ # Deduplication settings applied to the forwarded events on the
1059
+ # downstream bus.
1060
+ # @return [Types::DeduplicationConfiguration]
1061
+ #
1062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/EventBusV2Parameters AWS API Documentation
1063
+ #
1064
+ class EventBusV2Parameters < Struct.new(
1065
+ :metadata,
1066
+ :system_metadata,
1067
+ :deduplication_configuration)
1068
+ SENSITIVE = []
1069
+ include Aws::Structure
1070
+ end
1071
+
1072
+ # Customer-controllable system metadata attached to events forwarded to
1073
+ # the downstream event bus.
1074
+ #
1075
+ # @!attribute [rw] event_group_id
1076
+ # Event group ID for FIFO ordering on the downstream bus. Accepts a
1077
+ # literal or a JSONata expression.
1078
+ # @return [String]
1079
+ #
1080
+ # @!attribute [rw] deduplication_id
1081
+ # Deduplication ID for FIFO deduplication on the downstream bus.
1082
+ # Accepts a literal or a JSONata expression.
1083
+ # @return [String]
1084
+ #
1085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/EventBusV2SystemMetadata AWS API Documentation
1086
+ #
1087
+ class EventBusV2SystemMetadata < Struct.new(
1088
+ :event_group_id,
1089
+ :deduplication_id)
1090
+ SENSITIVE = []
1091
+ include Aws::Structure
1092
+ end
1093
+
1094
+ # Discriminated EventSource configuration. Exactly one variant must be
1095
+ # set.
1096
+ #
1097
+ # @note EventSourceConfiguration is a union - when making an API calls you must set exactly one of the members.
1098
+ #
1099
+ # @note EventSourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EventSourceConfiguration corresponding to the set member.
1100
+ #
1101
+ # @!attribute [rw] aws_service_events_configuration
1102
+ # Configuration for forwarding a single AWS service's events from the
1103
+ # account's default event bus.
1104
+ # @return [Types::AwsServiceEventsSourceConfiguration]
1105
+ #
1106
+ # @!attribute [rw] partner_events_configuration
1107
+ # Configuration for forwarding a partner event source's events
1108
+ # through a managed partner event bus.
1109
+ # @return [Types::PartnerEventsSourceConfiguration]
1110
+ #
1111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/EventSourceConfiguration AWS API Documentation
1112
+ #
1113
+ class EventSourceConfiguration < Struct.new(
1114
+ :aws_service_events_configuration,
1115
+ :partner_events_configuration,
1116
+ :unknown)
1117
+ SENSITIVE = []
1118
+ include Aws::Structure
1119
+ include Aws::Structure::Union
1120
+
1121
+ class AwsServiceEventsConfiguration < EventSourceConfiguration; end
1122
+ class PartnerEventsConfiguration < EventSourceConfiguration; end
1123
+ class Unknown < EventSourceConfiguration; end
1124
+ end
1125
+
1126
+ # Summary of an EventSource, as returned by ListEventSources.
1127
+ #
1128
+ # @!attribute [rw] event_source_arn
1129
+ # EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
1130
+ # is set by the service (aws.service for AWS service events,
1131
+ # aws.partner for partner events) and is not part of the resource's
1132
+ # name. The id segment is a 25-character identifier generated by the
1133
+ # service.</p> </id></name></type>
1134
+ # @return [String]
1135
+ #
1136
+ # @!attribute [rw] name
1137
+ # EventSource name. First character alphanumeric; the rest may add
1138
+ # '.', '-', '\_'. Names may not begin with the reserved "aws."
1139
+ # prefix. The grammar matches the ARN local-name segment in
1140
+ # EventSourceArn (event-sourcev2/<type>/<name>/<id>), mirroring
1141
+ # EventBusName, so a name the ARN cannot represent cannot be
1142
+ # created.</p> </id></name></type>
1143
+ # @return [String]
1144
+ #
1145
+ # @!attribute [rw] event_bus_arn
1146
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
1147
+ # bus.
1148
+ # @return [String]
1149
+ #
1150
+ # @!attribute [rw] type
1151
+ # Origin type of an EventSource: an AWS service's events
1152
+ # (AWS\_SERVICE\_EVENTS) or a partner event source's events
1153
+ # (PARTNER\_EVENTS).
1154
+ # @return [String]
1155
+ #
1156
+ # @!attribute [rw] state
1157
+ # Lifecycle state of an EventSource. Revocation is reported by the
1158
+ # Revoked flag.
1159
+ # @return [String]
1160
+ #
1161
+ # @!attribute [rw] revoked
1162
+ # True when the bus owner has withdrawn this EventSource. Present only
1163
+ # when true, so a bus owner listing EventSources sees at a glance
1164
+ # which ones they revoked. See DescribeEventSourceResponse$Revoked.
1165
+ # @return [Boolean]
1166
+ #
1167
+ # @!attribute [rw] creation_time
1168
+ # The time the EventSource was created.
1169
+ # @return [Time]
1170
+ #
1171
+ # @!attribute [rw] last_modified_time
1172
+ # The time the EventSource was last modified.
1173
+ # @return [Time]
1174
+ #
1175
+ # @!attribute [rw] event_source_account_id
1176
+ # AWS Account Id.
1177
+ # @return [String]
1178
+ #
1179
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/EventSourceSummary AWS API Documentation
1180
+ #
1181
+ class EventSourceSummary < Struct.new(
1182
+ :event_source_arn,
1183
+ :name,
1184
+ :event_bus_arn,
1185
+ :type,
1186
+ :state,
1187
+ :revoked,
1188
+ :creation_time,
1189
+ :last_modified_time,
1190
+ :event_source_account_id)
1191
+ SENSITIVE = []
1192
+ include Aws::Structure
1193
+ end
1194
+
1195
+ # A single filter entry within a FilterConfiguration.
1196
+ #
1197
+ # @!attribute [rw] pattern
1198
+ # An event pattern, as a JSON string, that selects which events match.
1199
+ # @return [String]
1200
+ #
1201
+ # @!attribute [rw] scope
1202
+ # Scope of a filter pattern within a FilterConfiguration.
1203
+ # @return [String]
1204
+ #
1205
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/Filter AWS API Documentation
1206
+ #
1207
+ class Filter < Struct.new(
1208
+ :pattern,
1209
+ :scope)
1210
+ SENSITIVE = [:pattern]
1211
+ include Aws::Structure
1212
+ end
1213
+
1214
+ # Configuration for filtering events delivered to a subscriber. On
1215
+ # CreateSubscriber, Filters is required and must contain at least one
1216
+ # Filter with a non-empty Pattern. On UpdateSubscriber, an empty
1217
+ # `FilterConfiguration:{}` clears the existing filter. Any non-empty
1218
+ # shape (including `{Language:X}` without Filters) must contain a valid
1219
+ # Filters list — same contract as CreateSubscriber. A non-empty Filters
1220
+ # list overwrites; an omitted FilterConfiguration preserves existing
1221
+ # state. All Filters are implicitly ANDed — an event must match every
1222
+ # Filter to be delivered.
1223
+ #
1224
+ # @!attribute [rw] language
1225
+ # Defaults to EVENT\_BRIDGE\_PATTERN when not specified.
1226
+ # @return [String]
1227
+ #
1228
+ # @!attribute [rw] filters
1229
+ # List of filters. An event must match every filter to be delivered.
1230
+ # @return [Array<Types::Filter>]
1231
+ #
1232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/FilterConfiguration AWS API Documentation
1233
+ #
1234
+ class FilterConfiguration < Struct.new(
1235
+ :language,
1236
+ :filters)
1237
+ SENSITIVE = []
1238
+ include Aws::Structure
1239
+ end
1240
+
1241
+ # @!attribute [rw] resource_arn
1242
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
1243
+ # bus.
1244
+ # @return [String]
1245
+ #
1246
+ # @!attribute [rw] policy_name
1247
+ # Which named policy to read. Defaults to "default" when omitted (a
1248
+ # read AWS Resource Access Manager makes on the owner's behalf
1249
+ # resolves to "AWS\_RAM" instead). Unlike writing, neither name is
1250
+ # reserved on a read: the bus owner can read both. There is no
1251
+ # fallback between the two, so a bus shared only through Resource
1252
+ # Access Manager fails with ResourceNotFoundException until "AWS\_RAM"
1253
+ # is named explicitly. A well-formed name that is neither of the two
1254
+ # fails with InvalidInputException.
1255
+ # @return [String]
1256
+ #
1257
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/GetResourcePolicyRequest AWS API Documentation
1258
+ #
1259
+ class GetResourcePolicyRequest < Struct.new(
1260
+ :resource_arn,
1261
+ :policy_name)
1262
+ SENSITIVE = []
1263
+ include Aws::Structure
1264
+ end
1265
+
1266
+ # Returned only when the named policy exists. A missing event bus or a
1267
+ # missing named policy fails with ResourceNotFoundException rather than
1268
+ # returning an empty or null policy document. Every member is therefore
1269
+ # always present on a successful response.
1270
+ #
1271
+ # @!attribute [rw] resource_arn
1272
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
1273
+ # bus.
1274
+ # @return [String]
1275
+ #
1276
+ # @!attribute [rw] policy_document
1277
+ # A resource policy document, as a JSON string. The "default" policy
1278
+ # can be up to 20 KB (20,480 bytes of UTF-8) by default. This quota is
1279
+ # adjustable in Service Quotas. A "default" policy that exceeds the
1280
+ # quota is rejected with PolicyLengthExceededException. No policy
1281
+ # document can exceed 389,120 bytes of UTF-8, regardless of the quota.
1282
+ # @return [String]
1283
+ #
1284
+ # @!attribute [rw] policy_name
1285
+ # Name of a policy attached to a resource. Valid values: "default"
1286
+ # (the customer-managed policy) and "AWS\_RAM" (managed exclusively by
1287
+ # AWS Resource Access Manager). Any other value is rejected.
1288
+ # @return [String]
1289
+ #
1290
+ # @!attribute [rw] revision_id
1291
+ # Revision ID of a resource policy. A new revision ID is generated on
1292
+ # every successful write.
1293
+ # @return [String]
1294
+ #
1295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/GetResourcePolicyResponse AWS API Documentation
1296
+ #
1297
+ class GetResourcePolicyResponse < Struct.new(
1298
+ :resource_arn,
1299
+ :policy_document,
1300
+ :policy_name,
1301
+ :revision_id)
1302
+ SENSITIVE = []
1303
+ include Aws::Structure
1304
+ end
1305
+
1306
+ # HTTP invocation parameters for subscribers (API Gateway / API
1307
+ # Destination). Values are forwarded to the HTTP endpoint.
1308
+ #
1309
+ # @!attribute [rw] path_parameter_values
1310
+ # Values substituted, in order, for the path-parameter placeholders in
1311
+ # an HTTP target's endpoint path.
1312
+ # @return [Array<String>]
1313
+ #
1314
+ # @!attribute [rw] header_parameters
1315
+ # Map of HTTP header names to values, sent with the request to an HTTP
1316
+ # target.
1317
+ # @return [Hash<String,String>]
1318
+ #
1319
+ # @!attribute [rw] query_string_parameters
1320
+ # Map of query-string parameter names to values, appended to the
1321
+ # request to an HTTP target.
1322
+ # @return [Hash<String,String>]
1323
+ #
1324
+ # @!attribute [rw] invocation_timeout_seconds
1325
+ # Timeout in seconds for each invocation of the target (1-30).
1326
+ # String-typed (not integer) so the value may be a JSONata expression.
1327
+ # @return [String]
1328
+ #
1329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/HttpParameters AWS API Documentation
1330
+ #
1331
+ class HttpParameters < Struct.new(
1332
+ :path_parameter_values,
1333
+ :header_parameters,
1334
+ :query_string_parameters,
1335
+ :invocation_timeout_seconds)
1336
+ SENSITIVE = []
1337
+ include Aws::Structure
1338
+ end
1339
+
1340
+ # The request reuses the client token of an earlier request with
1341
+ # different parameters. Use a new client token, or resend the earlier
1342
+ # request unchanged.
1343
+ #
1344
+ # @!attribute [rw] message
1345
+ # @return [String]
1346
+ #
1347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/IdempotentParameterMismatchException AWS API Documentation
1348
+ #
1349
+ class IdempotentParameterMismatchException < Struct.new(
1350
+ :message)
1351
+ SENSITIVE = []
1352
+ include Aws::Structure
1353
+ end
1354
+
1355
+ # The request failed because of an internal service error. Retry the
1356
+ # request.
1357
+ #
1358
+ # @!attribute [rw] message
1359
+ # @return [String]
1360
+ #
1361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/InternalException AWS API Documentation
1362
+ #
1363
+ class InternalException < Struct.new(
1364
+ :message)
1365
+ SENSITIVE = []
1366
+ include Aws::Structure
1367
+ end
1368
+
1369
+ # A request parameter is missing or not valid.
1370
+ #
1371
+ # @!attribute [rw] message
1372
+ # @return [String]
1373
+ #
1374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/InvalidInputException AWS API Documentation
1375
+ #
1376
+ class InvalidInputException < Struct.new(
1377
+ :message)
1378
+ SENSITIVE = []
1379
+ include Aws::Structure
1380
+ end
1381
+
1382
+ # The resource is not in a state that allows the operation. For example,
1383
+ # an event bus that is still being created cannot accept events.
1384
+ #
1385
+ # @!attribute [rw] message
1386
+ # @return [String]
1387
+ #
1388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/InvalidStateException AWS API Documentation
1389
+ #
1390
+ class InvalidStateException < Struct.new(
1391
+ :message)
1392
+ SENSITIVE = []
1393
+ include Aws::Structure
1394
+ end
1395
+
1396
+ # Configuration for how the subscriber invokes its target.
1397
+ #
1398
+ # @!attribute [rw] role_arn
1399
+ # IAM role the service assumes to invoke the target. Must belong to
1400
+ # the calling account.
1401
+ # @return [String]
1402
+ #
1403
+ # @!attribute [rw] lambda_parameters
1404
+ # Lambda invocation parameters for subscribers. Values are forwarded
1405
+ # to the Lambda Invoke API. Every string member accepts a literal or a
1406
+ # JSONata expression (e.g. "\{% $events.Data.qualifier %}").
1407
+ # @return [Types::LambdaParameters]
1408
+ #
1409
+ # @!attribute [rw] sqs_parameters
1410
+ # SQS invocation parameters for subscribers. Values are forwarded to
1411
+ # the SQS SendMessageBatch API. All scalar values accept a literal or
1412
+ # a JSONata expression (e.g. "\{% $events.Data.groupId %}").
1413
+ # @return [Types::SqsParameters]
1414
+ #
1415
+ # @!attribute [rw] sns_parameters
1416
+ # SNS invocation parameters for subscribers. Values are forwarded to
1417
+ # the SNS PublishBatch API. All scalar values accept a literal or a
1418
+ # JSONata expression (e.g. "\{% $events.Data.groupId %}").
1419
+ # @return [Types::SnsParameters]
1420
+ #
1421
+ # @!attribute [rw] kinesis_parameters
1422
+ # Kinesis Data Streams invocation parameters for subscribers. Values
1423
+ # are forwarded to the Kinesis PutRecords API. All scalar values
1424
+ # accept a literal or a JSONata expression (e.g. "\{%
1425
+ # $events.Data.partitionKey %}").
1426
+ # @return [Types::KinesisParameters]
1427
+ #
1428
+ # @!attribute [rw] step_functions_parameters
1429
+ # Step Functions invocation parameters for subscribers. Values are
1430
+ # forwarded to the Step Functions StartExecution or StartSyncExecution
1431
+ # API. Every string member accepts a literal or a JSONata expression
1432
+ # (e.g. "\{% $events.Data.executionName %}").
1433
+ # @return [Types::StepFunctionsParameters]
1434
+ #
1435
+ # @!attribute [rw] http_parameters
1436
+ # HTTP invocation parameters for subscribers (API Gateway / API
1437
+ # Destination). Values are forwarded to the HTTP endpoint.
1438
+ # @return [Types::HttpParameters]
1439
+ #
1440
+ # @!attribute [rw] universal_target_parameters
1441
+ # Parameters for USI (Universal Service Integration) targets. Used
1442
+ # when TargetArn is in the format
1443
+ # arn:aws:events:::aws-sdk:\{service}:\{apiAction}
1444
+ # @return [Types::UniversalTargetParameters]
1445
+ #
1446
+ # @!attribute [rw] event_bus_v2_parameters
1447
+ # Parameters for forwarding events to another EventBridge event bus.
1448
+ # @return [Types::EventBusV2Parameters]
1449
+ #
1450
+ # @!attribute [rw] target_arn
1451
+ # ARN of the target a subscriber invokes. The resource grammar is
1452
+ # service-neutral because target services use different separators and
1453
+ # the USI form omits region and account.
1454
+ # @return [String]
1455
+ #
1456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/InvokeConfiguration AWS API Documentation
1457
+ #
1458
+ class InvokeConfiguration < Struct.new(
1459
+ :role_arn,
1460
+ :lambda_parameters,
1461
+ :sqs_parameters,
1462
+ :sns_parameters,
1463
+ :kinesis_parameters,
1464
+ :step_functions_parameters,
1465
+ :http_parameters,
1466
+ :universal_target_parameters,
1467
+ :event_bus_v2_parameters,
1468
+ :target_arn)
1469
+ SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
1470
+ include Aws::Structure
1471
+ end
1472
+
1473
+ # JSONata transform settings for a subscriber.
1474
+ #
1475
+ # @!attribute [rw] expression
1476
+ # JSONata expression to transform the event. Must be wrapped in \{% %}
1477
+ # delimiters.
1478
+ # @return [String]
1479
+ #
1480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/JsonataConfiguration AWS API Documentation
1481
+ #
1482
+ class JsonataConfiguration < Struct.new(
1483
+ :expression)
1484
+ SENSITIVE = []
1485
+ include Aws::Structure
1486
+ end
1487
+
1488
+ # Kinesis Data Streams invocation parameters for subscribers. Values are
1489
+ # forwarded to the Kinesis PutRecords API. All scalar values accept a
1490
+ # literal or a JSONata expression (e.g. "\{% $events.Data.partitionKey
1491
+ # %}").
1492
+ #
1493
+ # @!attribute [rw] partition_key
1494
+ # Required by PutRecords even when an explicit hash key is supplied.
1495
+ # Accepts JSONata expression.
1496
+ # @return [String]
1497
+ #
1498
+ # @!attribute [rw] explicit_hash_key
1499
+ # Explicit hash key forwarded to PutRecords unchanged. Accepts JSONata
1500
+ # expression.
1501
+ # @return [String]
1502
+ #
1503
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/KinesisParameters AWS API Documentation
1504
+ #
1505
+ class KinesisParameters < Struct.new(
1506
+ :partition_key,
1507
+ :explicit_hash_key)
1508
+ SENSITIVE = []
1509
+ include Aws::Structure
1510
+ end
1511
+
1512
+ # Lambda invocation parameters for subscribers. Values are forwarded to
1513
+ # the Lambda Invoke API. Every string member accepts a literal or a
1514
+ # JSONata expression (e.g. "\{% $events.Data.qualifier %}").
1515
+ #
1516
+ # @!attribute [rw] invocation_type
1517
+ # Lambda invocation type. EVENT invokes the function asynchronously;
1518
+ # REQUEST\_RESPONSE waits for its result.
1519
+ # @return [String]
1520
+ #
1521
+ # @!attribute [rw] qualifier
1522
+ # Lambda qualifier: $LATEST, $LATEST.PUBLISHED, a numeric version, or
1523
+ # an alias. Accepts a JSONata expression.
1524
+ # @return [String]
1525
+ #
1526
+ # @!attribute [rw] durable_execution_name
1527
+ # Durable execution name. Accepts a JSONata expression.
1528
+ # @return [String]
1529
+ #
1530
+ # @!attribute [rw] tenant_id
1531
+ # Tenant identifier. Accepts a JSONata expression.
1532
+ # @return [String]
1533
+ #
1534
+ # @!attribute [rw] invocation_timeout_seconds
1535
+ # Timeout in seconds for each invocation of the target. String-typed
1536
+ # so the value may be a JSONata expression.
1537
+ # @return [String]
1538
+ #
1539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/LambdaParameters AWS API Documentation
1540
+ #
1541
+ class LambdaParameters < Struct.new(
1542
+ :invocation_type,
1543
+ :qualifier,
1544
+ :durable_execution_name,
1545
+ :tenant_id,
1546
+ :invocation_timeout_seconds)
1547
+ SENSITIVE = []
1548
+ include Aws::Structure
1549
+ end
1550
+
1551
+ # The request would exceed a service quota for the account.
1552
+ #
1553
+ # @!attribute [rw] message
1554
+ # @return [String]
1555
+ #
1556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/LimitExceededException AWS API Documentation
1557
+ #
1558
+ class LimitExceededException < Struct.new(
1559
+ :message)
1560
+ SENSITIVE = []
1561
+ include Aws::Structure
1562
+ end
1563
+
1564
+ # @!attribute [rw] name_prefix
1565
+ # Name of an event bus. The first character must be alphanumeric; the
1566
+ # remaining characters may also include '.', '-', and '\_'. The
1567
+ # grammar matches the name segment of EventBusArn
1568
+ # (event-busv2/<name>/<id>), so every valid name can be represented in
1569
+ # the bus's ARN. The same type is used everywhere a bus name
1570
+ # appears.</p> </id></name>
1571
+ # @return [String]
1572
+ #
1573
+ # @!attribute [rw] event_bus_account_id
1574
+ # AWS Account Id.
1575
+ # @return [String]
1576
+ #
1577
+ # @!attribute [rw] next_token
1578
+ # Opaque pagination token returned by a List operation. Pass it back
1579
+ # in the next request to retrieve the next page of results.
1580
+ # @return [String]
1581
+ #
1582
+ # @!attribute [rw] max_results
1583
+ # Maximum number of results to return in one page of a List operation.
1584
+ # @return [Integer]
1585
+ #
1586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListEventBusesRequest AWS API Documentation
1587
+ #
1588
+ class ListEventBusesRequest < Struct.new(
1589
+ :name_prefix,
1590
+ :event_bus_account_id,
1591
+ :next_token,
1592
+ :max_results)
1593
+ SENSITIVE = []
1594
+ include Aws::Structure
1595
+ end
1596
+
1597
+ # @!attribute [rw] event_buses
1598
+ # List of event bus summaries.
1599
+ # @return [Array<Types::EventBusSummary>]
1600
+ #
1601
+ # @!attribute [rw] next_token
1602
+ # Opaque pagination token returned by a List operation. Pass it back
1603
+ # in the next request to retrieve the next page of results.
1604
+ # @return [String]
1605
+ #
1606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListEventBusesResponse AWS API Documentation
1607
+ #
1608
+ class ListEventBusesResponse < Struct.new(
1609
+ :event_buses,
1610
+ :next_token)
1611
+ SENSITIVE = []
1612
+ include Aws::Structure
1613
+ end
1614
+
1615
+ # @!attribute [rw] event_bus_arn
1616
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
1617
+ # bus.
1618
+ # @return [String]
1619
+ #
1620
+ # @!attribute [rw] name_prefix
1621
+ # EventSource name. First character alphanumeric; the rest may add
1622
+ # '.', '-', '\_'. Names may not begin with the reserved "aws."
1623
+ # prefix. The grammar matches the ARN local-name segment in
1624
+ # EventSourceArn (event-sourcev2/<type>/<name>/<id>), mirroring
1625
+ # EventBusName, so a name the ARN cannot represent cannot be
1626
+ # created.</p> </id></name></type>
1627
+ # @return [String]
1628
+ #
1629
+ # @!attribute [rw] next_token
1630
+ # Opaque pagination token returned by a List operation. Pass it back
1631
+ # in the next request to retrieve the next page of results.
1632
+ # @return [String]
1633
+ #
1634
+ # @!attribute [rw] max_results
1635
+ # Maximum number of results to return in one page of a List operation.
1636
+ # @return [Integer]
1637
+ #
1638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListEventSourcesRequest AWS API Documentation
1639
+ #
1640
+ class ListEventSourcesRequest < Struct.new(
1641
+ :event_bus_arn,
1642
+ :name_prefix,
1643
+ :next_token,
1644
+ :max_results)
1645
+ SENSITIVE = []
1646
+ include Aws::Structure
1647
+ end
1648
+
1649
+ # @!attribute [rw] event_sources
1650
+ # List of EventSource summaries.
1651
+ # @return [Array<Types::EventSourceSummary>]
1652
+ #
1653
+ # @!attribute [rw] next_token
1654
+ # Opaque pagination token returned by a List operation. Pass it back
1655
+ # in the next request to retrieve the next page of results.
1656
+ # @return [String]
1657
+ #
1658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListEventSourcesResponse AWS API Documentation
1659
+ #
1660
+ class ListEventSourcesResponse < Struct.new(
1661
+ :event_sources,
1662
+ :next_token)
1663
+ SENSITIVE = []
1664
+ include Aws::Structure
1665
+ end
1666
+
1667
+ # @!attribute [rw] resource_arn
1668
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
1669
+ # bus.
1670
+ # @return [String]
1671
+ #
1672
+ # @!attribute [rw] next_token
1673
+ # Opaque pagination token returned by a List operation. Pass it back
1674
+ # in the next request to retrieve the next page of results.
1675
+ # @return [String]
1676
+ #
1677
+ # @!attribute [rw] max_results
1678
+ # Maximum number of results to return in one page of a List operation.
1679
+ # @return [Integer]
1680
+ #
1681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListResourcePoliciesRequest AWS API Documentation
1682
+ #
1683
+ class ListResourcePoliciesRequest < Struct.new(
1684
+ :resource_arn,
1685
+ :next_token,
1686
+ :max_results)
1687
+ SENSITIVE = []
1688
+ include Aws::Structure
1689
+ end
1690
+
1691
+ # Summaries only (policy name and revision ID). Use GetResourcePolicy to
1692
+ # retrieve a policy document.
1693
+ #
1694
+ # @!attribute [rw] policy_summaries
1695
+ # List of resource policy summaries.
1696
+ # @return [Array<Types::ResourcePolicySummary>]
1697
+ #
1698
+ # @!attribute [rw] next_token
1699
+ # Opaque pagination token returned by a List operation. Pass it back
1700
+ # in the next request to retrieve the next page of results.
1701
+ # @return [String]
1702
+ #
1703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListResourcePoliciesResponse AWS API Documentation
1704
+ #
1705
+ class ListResourcePoliciesResponse < Struct.new(
1706
+ :policy_summaries,
1707
+ :next_token)
1708
+ SENSITIVE = []
1709
+ include Aws::Structure
1710
+ end
1711
+
1712
+ # @!attribute [rw] event_bus_arn
1713
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
1714
+ # bus.
1715
+ # @return [String]
1716
+ #
1717
+ # @!attribute [rw] name_prefix
1718
+ # Name of a subscriber. The first character must be alphanumeric; the
1719
+ # remaining characters may also include '.', '-', and '\_'.
1720
+ # @return [String]
1721
+ #
1722
+ # @!attribute [rw] next_token
1723
+ # Opaque pagination token returned by a List operation. Pass it back
1724
+ # in the next request to retrieve the next page of results.
1725
+ # @return [String]
1726
+ #
1727
+ # @!attribute [rw] max_results
1728
+ # Maximum number of results to return in one page of a List operation.
1729
+ # @return [Integer]
1730
+ #
1731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListSubscribersRequest AWS API Documentation
1732
+ #
1733
+ class ListSubscribersRequest < Struct.new(
1734
+ :event_bus_arn,
1735
+ :name_prefix,
1736
+ :next_token,
1737
+ :max_results)
1738
+ SENSITIVE = []
1739
+ include Aws::Structure
1740
+ end
1741
+
1742
+ # @!attribute [rw] subscribers
1743
+ # List of subscriber summaries.
1744
+ # @return [Array<Types::SubscriberSummary>]
1745
+ #
1746
+ # @!attribute [rw] next_token
1747
+ # Opaque pagination token returned by a List operation. Pass it back
1748
+ # in the next request to retrieve the next page of results.
1749
+ # @return [String]
1750
+ #
1751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListSubscribersResponse AWS API Documentation
1752
+ #
1753
+ class ListSubscribersResponse < Struct.new(
1754
+ :subscribers,
1755
+ :next_token)
1756
+ SENSITIVE = []
1757
+ include Aws::Structure
1758
+ end
1759
+
1760
+ # @!attribute [rw] resource_arn
1761
+ # ARN for an EventBridge resource that supports tagging: event buses,
1762
+ # subscribers, and event sources.
1763
+ # @return [String]
1764
+ #
1765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListTagsForResourceRequest AWS API Documentation
1766
+ #
1767
+ class ListTagsForResourceRequest < Struct.new(
1768
+ :resource_arn)
1769
+ SENSITIVE = []
1770
+ include Aws::Structure
1771
+ end
1772
+
1773
+ # @!attribute [rw] tags
1774
+ # Tags attached to a resource, as key-value pairs.
1775
+ # @return [Hash<String,String>]
1776
+ #
1777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ListTagsForResourceResponse AWS API Documentation
1778
+ #
1779
+ class ListTagsForResourceResponse < Struct.new(
1780
+ :tags)
1781
+ SENSITIVE = []
1782
+ include Aws::Structure
1783
+ end
1784
+
1785
+ # Log configuration for a subscriber.
1786
+ #
1787
+ # @!attribute [rw] level
1788
+ # Minimum log level. Records below this level are not emitted.
1789
+ # Defaults to OFF.
1790
+ # @return [String]
1791
+ #
1792
+ # @!attribute [rw] include_payload
1793
+ # Whether the customer event payload is embedded in log records.
1794
+ # Defaults to ON\_ERROR\_ONLY.
1795
+ # @return [String]
1796
+ #
1797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/LogConfiguration AWS API Documentation
1798
+ #
1799
+ class LogConfiguration < Struct.new(
1800
+ :level,
1801
+ :include_payload)
1802
+ SENSITIVE = []
1803
+ include Aws::Structure
1804
+ end
1805
+
1806
+ # On-failure configuration: where a failed delivery is sent. Shared by
1807
+ # the subscriber and the EventSource.
1808
+ #
1809
+ # @!attribute [rw] arn
1810
+ # The ARN of the destination that receives events that could not be
1811
+ # delivered. An Amazon SQS queue is the supported destination.
1812
+ # @return [String]
1813
+ #
1814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/OnFailureConfiguration AWS API Documentation
1815
+ #
1816
+ class OnFailureConfiguration < Struct.new(
1817
+ :arn)
1818
+ SENSITIVE = []
1819
+ include Aws::Structure
1820
+ end
1821
+
1822
+ # Configuration for forwarding a partner event source's events through
1823
+ # a managed partner event bus.
1824
+ #
1825
+ # @!attribute [rw] partner_event_source_arn
1826
+ # ARN of the partner event source to forward. It is a partner-owned
1827
+ # resource, so the account segment is empty:
1828
+ # arn:aws:events:<region>::event-source/aws.partner/<name>.</p>
1829
+ # </name></region>
1830
+ # @return [String]
1831
+ #
1832
+ # @!attribute [rw] pattern
1833
+ # A filter pattern, as a JSON string, that defines which of the
1834
+ # partner event source's events are forwarded to the event bus. If no
1835
+ # pattern is specified, all events from the partner event source are
1836
+ # forwarded.
1837
+ # @return [String]
1838
+ #
1839
+ # @!attribute [rw] partner_bus_kms_key_identifier
1840
+ # Identifier of the AWS KMS customer managed key used to encrypt
1841
+ # events: a key ID, key ARN, alias name, or alias ARN. When absent,
1842
+ # events are encrypted with an AWS owned key.
1843
+ # @return [String]
1844
+ #
1845
+ # @!attribute [rw] on_failure_configuration
1846
+ # The destination for events that could not be forwarded, covering
1847
+ # both the forwarding target and the managed partner event bus.
1848
+ # @return [Types::OnFailureConfiguration]
1849
+ #
1850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PartnerEventsSourceConfiguration AWS API Documentation
1851
+ #
1852
+ class PartnerEventsSourceConfiguration < Struct.new(
1853
+ :partner_event_source_arn,
1854
+ :pattern,
1855
+ :partner_bus_kms_key_identifier,
1856
+ :on_failure_configuration)
1857
+ SENSITIVE = [:pattern]
1858
+ include Aws::Structure
1859
+ end
1860
+
1861
+ # Point-in-time configuration for a subscriber. Only applicable when
1862
+ # StartingPosition is POINT\_IN\_TIME.
1863
+ #
1864
+ # @!attribute [rw] point_type
1865
+ # Whether to start from the horizon or a specific timestamp.
1866
+ # @return [String]
1867
+ #
1868
+ # @!attribute [rw] starting_point
1869
+ # Timestamp to start from. Required when PointType is TIMESTAMP.
1870
+ # @return [Time]
1871
+ #
1872
+ # @!attribute [rw] end_point
1873
+ # Timestamp to stop at. Optional.
1874
+ # @return [Time]
1875
+ #
1876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PointInTimeConfiguration AWS API Documentation
1877
+ #
1878
+ class PointInTimeConfiguration < Struct.new(
1879
+ :point_type,
1880
+ :starting_point,
1881
+ :end_point)
1882
+ SENSITIVE = []
1883
+ include Aws::Structure
1884
+ end
1885
+
1886
+ # The policy document is larger than the account's resource policy size
1887
+ # quota, or larger than the service maximum.
1888
+ #
1889
+ # @!attribute [rw] message
1890
+ # @return [String]
1891
+ #
1892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PolicyLengthExceededException AWS API Documentation
1893
+ #
1894
+ class PolicyLengthExceededException < Struct.new(
1895
+ :message)
1896
+ SENSITIVE = []
1897
+ include Aws::Structure
1898
+ end
1899
+
1900
+ # The policy was rejected because it would grant public access to the
1901
+ # event bus. A statement grants public access when its principal is a
1902
+ # wildcard and no condition limits the callers to specific AWS accounts
1903
+ # or principals. To fix it, replace the wildcard principal with specific
1904
+ # principals, or add a condition that limits the callers to specific AWS
1905
+ # accounts. Conditions on event content (events:source,
1906
+ # events:detail-type, events:Metadata/*) do not identify the caller and
1907
+ # do not make a wildcard principal non-public. Returned only for the
1908
+ # "default" policy; the "AWS\_RAM" policy is composed by AWS Resource
1909
+ # Access Manager and never grants public access.
1910
+ #
1911
+ # @!attribute [rw] message
1912
+ # @return [String]
1913
+ #
1914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PublicPolicyException AWS API Documentation
1915
+ #
1916
+ class PublicPolicyException < Struct.new(
1917
+ :message)
1918
+ SENSITIVE = []
1919
+ include Aws::Structure
1920
+ end
1921
+
1922
+ # @!attribute [rw] event_bus_arn
1923
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
1924
+ # bus.
1925
+ # @return [String]
1926
+ #
1927
+ # @!attribute [rw] entries
1928
+ # List of event entries to publish. Must contain at least one entry.
1929
+ # @return [Array<Types::PutEventsRequestEntry>]
1930
+ #
1931
+ # @!attribute [rw] deduplication_configuration
1932
+ # Request-level deduplication settings, applied to every entry in the
1933
+ # batch.
1934
+ # @return [Types::DeduplicationConfiguration]
1935
+ #
1936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutEventsRequest AWS API Documentation
1937
+ #
1938
+ class PutEventsRequest < Struct.new(
1939
+ :event_bus_arn,
1940
+ :entries,
1941
+ :deduplication_configuration)
1942
+ SENSITIVE = []
1943
+ include Aws::Structure
1944
+ end
1945
+
1946
+ # A single event entry in a PutEvents request.
1947
+ #
1948
+ # @!attribute [rw] source
1949
+ # The source of the event. The `aws.` value prefix is service-reserved
1950
+ # and cannot be used as a value.
1951
+ # @return [String]
1952
+ #
1953
+ # @!attribute [rw] detail_type
1954
+ # Free-form detail-type classifying an event within its source.
1955
+ # @return [String]
1956
+ #
1957
+ # @!attribute [rw] detail
1958
+ # The event payload, as a valid JSON string.
1959
+ # @return [String]
1960
+ #
1961
+ # @!attribute [rw] resources
1962
+ # ARNs of resources the event concerns. Included in the event
1963
+ # delivered to subscribers.
1964
+ # @return [Array<String>]
1965
+ #
1966
+ # @!attribute [rw] time
1967
+ # The time the event occurred. Defaults to the time the service
1968
+ # receives the event when omitted.
1969
+ # @return [Time]
1970
+ #
1971
+ # @!attribute [rw] system_metadata
1972
+ # System metadata for PutEvents entries. ContentType is not applicable
1973
+ # (always application/eventbridge+json, set server-side).
1974
+ # @return [Types::PutEventsSystemMetadata]
1975
+ #
1976
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutEventsRequestEntry AWS API Documentation
1977
+ #
1978
+ class PutEventsRequestEntry < Struct.new(
1979
+ :source,
1980
+ :detail_type,
1981
+ :detail,
1982
+ :resources,
1983
+ :time,
1984
+ :system_metadata)
1985
+ SENSITIVE = [:detail]
1986
+ include Aws::Structure
1987
+ end
1988
+
1989
+ # @!attribute [rw] failed_entry_count
1990
+ # The number of entries in the batch that failed to be published.
1991
+ # @return [Integer]
1992
+ #
1993
+ # @!attribute [rw] entries
1994
+ # List of per-entry publish results, in the same order as the request
1995
+ # entries.
1996
+ # @return [Array<Types::PutEventsResultEntry>]
1997
+ #
1998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutEventsResponse AWS API Documentation
1999
+ #
2000
+ class PutEventsResponse < Struct.new(
2001
+ :failed_entry_count,
2002
+ :entries)
2003
+ SENSITIVE = []
2004
+ include Aws::Structure
2005
+ end
2006
+
2007
+ # Result entry for a published event. The position of each entry in the
2008
+ # response list aligns 1:1 with the corresponding request entry.
2009
+ #
2010
+ # @!attribute [rw] event_id
2011
+ # Unique event ID assigned by the service.
2012
+ # @return [String]
2013
+ #
2014
+ # @!attribute [rw] sequence_number
2015
+ # Sequence number assigned to the message for ordering within the
2016
+ # message group.
2017
+ # @return [String]
2018
+ #
2019
+ # @!attribute [rw] success_code
2020
+ # Indicates the outcome for a successfully processed publish entry.
2021
+ # @return [String]
2022
+ #
2023
+ # @!attribute [rw] error_code
2024
+ # Error code identifying why a publish batch entry failed.
2025
+ # @return [String]
2026
+ #
2027
+ # @!attribute [rw] error_message
2028
+ # Human-readable explanation of why a publish batch entry failed.
2029
+ # @return [String]
2030
+ #
2031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutEventsResultEntry AWS API Documentation
2032
+ #
2033
+ class PutEventsResultEntry < Struct.new(
2034
+ :event_id,
2035
+ :sequence_number,
2036
+ :success_code,
2037
+ :error_code,
2038
+ :error_message)
2039
+ SENSITIVE = []
2040
+ include Aws::Structure
2041
+ end
2042
+
2043
+ # System metadata for PutEvents entries. ContentType is not applicable
2044
+ # (always application/eventbridge+json, set server-side).
2045
+ #
2046
+ # @!attribute [rw] event_group_id
2047
+ # Event group ID for FIFO ordering.
2048
+ # @return [String]
2049
+ #
2050
+ # @!attribute [rw] deduplication_id
2051
+ # Deduplication ID for FIFO deduplication.
2052
+ # @return [String]
2053
+ #
2054
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutEventsSystemMetadata AWS API Documentation
2055
+ #
2056
+ class PutEventsSystemMetadata < Struct.new(
2057
+ :event_group_id,
2058
+ :deduplication_id)
2059
+ SENSITIVE = []
2060
+ include Aws::Structure
2061
+ end
2062
+
2063
+ # @!attribute [rw] event_bus_arn
2064
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
2065
+ # bus.
2066
+ # @return [String]
2067
+ #
2068
+ # @!attribute [rw] entries
2069
+ # List of event entries to publish. Must contain at least one entry.
2070
+ # @return [Array<Types::PutRawEventsRequestEntry>]
2071
+ #
2072
+ # @!attribute [rw] schema_registry_configuration
2073
+ # Schema-registry settings for encoding open-format (Avro/Protobuf)
2074
+ # events. Required for open-format entries; ignored for JSON entries.
2075
+ # The registry is read with the caller's credentials, so the caller
2076
+ # needs read access to the registry it references.
2077
+ # @return [Types::SchemaRegistryConfiguration]
2078
+ #
2079
+ # @!attribute [rw] deduplication_configuration
2080
+ # Request-level deduplication settings, applied to every entry in the
2081
+ # batch.
2082
+ # @return [Types::DeduplicationConfiguration]
2083
+ #
2084
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutRawEventsRequest AWS API Documentation
2085
+ #
2086
+ class PutRawEventsRequest < Struct.new(
2087
+ :event_bus_arn,
2088
+ :entries,
2089
+ :schema_registry_configuration,
2090
+ :deduplication_configuration)
2091
+ SENSITIVE = []
2092
+ include Aws::Structure
2093
+ end
2094
+
2095
+ # A single event entry in a raw publish request.
2096
+ #
2097
+ # @!attribute [rw] data
2098
+ # The event data as a base64-encoded blob. Supports binary formats.
2099
+ # @return [String]
2100
+ #
2101
+ # @!attribute [rw] metadata
2102
+ # Metadata key-value pairs you define. Keys must be 1-128 characters
2103
+ # and must not contain "/".
2104
+ # @return [Hash<String,String>]
2105
+ #
2106
+ # @!attribute [rw] system_metadata
2107
+ # Structured system metadata with defined properties.
2108
+ # @return [Types::PutRawEventsSystemMetadata]
2109
+ #
2110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutRawEventsRequestEntry AWS API Documentation
2111
+ #
2112
+ class PutRawEventsRequestEntry < Struct.new(
2113
+ :data,
2114
+ :metadata,
2115
+ :system_metadata)
2116
+ SENSITIVE = [:data, :metadata]
2117
+ include Aws::Structure
2118
+ end
2119
+
2120
+ # @!attribute [rw] failed_entry_count
2121
+ # The number of entries in the batch that failed to be published.
2122
+ # @return [Integer]
2123
+ #
2124
+ # @!attribute [rw] entries
2125
+ # List of per-entry publish results, in the same order as the request
2126
+ # entries.
2127
+ # @return [Array<Types::PutRawEventsResultEntry>]
2128
+ #
2129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutRawEventsResponse AWS API Documentation
2130
+ #
2131
+ class PutRawEventsResponse < Struct.new(
2132
+ :failed_entry_count,
2133
+ :entries)
2134
+ SENSITIVE = []
2135
+ include Aws::Structure
2136
+ end
2137
+
2138
+ # Result entry for a published event. The position of each entry in the
2139
+ # response list aligns 1:1 with the corresponding request entry,
2140
+ # enabling co-location by index.
2141
+ #
2142
+ # @!attribute [rw] event_id
2143
+ # Unique event ID assigned by the service. Present on successful
2144
+ # entries.
2145
+ # @return [String]
2146
+ #
2147
+ # @!attribute [rw] sequence_number
2148
+ # Sequence number for ordering within the event group.
2149
+ # @return [String]
2150
+ #
2151
+ # @!attribute [rw] success_code
2152
+ # Indicates how the entry was processed. Present only on successful
2153
+ # entries.
2154
+ # @return [String]
2155
+ #
2156
+ # @!attribute [rw] error_code
2157
+ # Error code if the entry failed.
2158
+ # @return [String]
2159
+ #
2160
+ # @!attribute [rw] error_message
2161
+ # Error message if the entry failed.
2162
+ # @return [String]
2163
+ #
2164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutRawEventsResultEntry AWS API Documentation
2165
+ #
2166
+ class PutRawEventsResultEntry < Struct.new(
2167
+ :event_id,
2168
+ :sequence_number,
2169
+ :success_code,
2170
+ :error_code,
2171
+ :error_message)
2172
+ SENSITIVE = []
2173
+ include Aws::Structure
2174
+ end
2175
+
2176
+ # System metadata for PutRawEvents entries. ContentType is required
2177
+ # because PutRawEvents supports arbitrary binary formats.
2178
+ #
2179
+ # @!attribute [rw] content_type
2180
+ # Content type of the event data (e.g.,
2181
+ # "application/cloudevents+json").
2182
+ # @return [String]
2183
+ #
2184
+ # @!attribute [rw] deduplication_id
2185
+ # Deduplication ID for FIFO deduplication.
2186
+ # @return [String]
2187
+ #
2188
+ # @!attribute [rw] event_group_id
2189
+ # Event group ID for FIFO ordering.
2190
+ # @return [String]
2191
+ #
2192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutRawEventsSystemMetadata AWS API Documentation
2193
+ #
2194
+ class PutRawEventsSystemMetadata < Struct.new(
2195
+ :content_type,
2196
+ :deduplication_id,
2197
+ :event_group_id)
2198
+ SENSITIVE = []
2199
+ include Aws::Structure
2200
+ end
2201
+
2202
+ # @!attribute [rw] resource_arn
2203
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
2204
+ # bus.
2205
+ # @return [String]
2206
+ #
2207
+ # @!attribute [rw] policy_document
2208
+ # A resource policy document, as a JSON string. The "default" policy
2209
+ # can be up to 20 KB (20,480 bytes of UTF-8) by default. This quota is
2210
+ # adjustable in Service Quotas. A "default" policy that exceeds the
2211
+ # quota is rejected with PolicyLengthExceededException. No policy
2212
+ # document can exceed 389,120 bytes of UTF-8, regardless of the quota.
2213
+ # @return [String]
2214
+ #
2215
+ # @!attribute [rw] policy_name
2216
+ # Which named policy to write. Defaults to "default", the
2217
+ # customer-managed policy, when omitted (a write AWS Resource Access
2218
+ # Manager makes on the owner's behalf resolves to "AWS\_RAM"
2219
+ # instead). The two writers are exclusive in both directions — only
2220
+ # Resource Access Manager can write "AWS\_RAM", and only the bus owner
2221
+ # can write "default" — so naming the other party's policy fails with
2222
+ # AccessDeniedException. A well-formed name that is neither of the two
2223
+ # fails with InvalidInputException.
2224
+ # @return [String]
2225
+ #
2226
+ # @!attribute [rw] expected_revision_id
2227
+ # The write succeeds only if the named policy's current revision ID
2228
+ # matches this value; a policy that does not exist yet matches only
2229
+ # the sentinel "NO\_POLICY" (create-only). On mismatch the operation
2230
+ # fails with ConflictException. When omitted, the write is
2231
+ # unconditional. Every attempt stores a newly generated revision ID,
2232
+ # so retrying an unanswered request can conflict with the caller's
2233
+ # own earlier attempt; read the policy back and compare it with the
2234
+ # one you intended before treating a conflict as another writer's
2235
+ # change.
2236
+ # @return [String]
2237
+ #
2238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutResourcePolicyRequest AWS API Documentation
2239
+ #
2240
+ class PutResourcePolicyRequest < Struct.new(
2241
+ :resource_arn,
2242
+ :policy_document,
2243
+ :policy_name,
2244
+ :expected_revision_id)
2245
+ SENSITIVE = []
2246
+ include Aws::Structure
2247
+ end
2248
+
2249
+ # @!attribute [rw] resource_arn
2250
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
2251
+ # bus.
2252
+ # @return [String]
2253
+ #
2254
+ # @!attribute [rw] policy_name
2255
+ # Name of a policy attached to a resource. Valid values: "default"
2256
+ # (the customer-managed policy) and "AWS\_RAM" (managed exclusively by
2257
+ # AWS Resource Access Manager). Any other value is rejected.
2258
+ # @return [String]
2259
+ #
2260
+ # @!attribute [rw] revision_id
2261
+ # Absent when the write removed the policy; a removal produces no new
2262
+ # revision.
2263
+ # @return [String]
2264
+ #
2265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/PutResourcePolicyResponse AWS API Documentation
2266
+ #
2267
+ class PutResourcePolicyResponse < Struct.new(
2268
+ :resource_arn,
2269
+ :policy_name,
2270
+ :revision_id)
2271
+ SENSITIVE = []
2272
+ include Aws::Structure
2273
+ end
2274
+
2275
+ # A resource with the same name already exists.
2276
+ #
2277
+ # @!attribute [rw] message
2278
+ # @return [String]
2279
+ #
2280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ResourceAlreadyExistsException AWS API Documentation
2281
+ #
2282
+ class ResourceAlreadyExistsException < Struct.new(
2283
+ :message)
2284
+ SENSITIVE = []
2285
+ include Aws::Structure
2286
+ end
2287
+
2288
+ # The resource is in use and cannot be deleted. For example, an event
2289
+ # bus with subscribers or event sources cannot be deleted until they are
2290
+ # deleted.
2291
+ #
2292
+ # @!attribute [rw] message
2293
+ # @return [String]
2294
+ #
2295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ResourceInUseException AWS API Documentation
2296
+ #
2297
+ class ResourceInUseException < Struct.new(
2298
+ :message)
2299
+ SENSITIVE = []
2300
+ include Aws::Structure
2301
+ end
2302
+
2303
+ # The resource does not exist.
2304
+ #
2305
+ # @!attribute [rw] message
2306
+ # @return [String]
2307
+ #
2308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ResourceNotFoundException AWS API Documentation
2309
+ #
2310
+ class ResourceNotFoundException < Struct.new(
2311
+ :message)
2312
+ SENSITIVE = []
2313
+ include Aws::Structure
2314
+ end
2315
+
2316
+ # Summary of a policy attached to a resource: its name and revision ID.
2317
+ #
2318
+ # @!attribute [rw] policy_name
2319
+ # Name of a policy attached to a resource. Valid values: "default"
2320
+ # (the customer-managed policy) and "AWS\_RAM" (managed exclusively by
2321
+ # AWS Resource Access Manager). Any other value is rejected.
2322
+ # @return [String]
2323
+ #
2324
+ # @!attribute [rw] revision_id
2325
+ # Revision ID of a resource policy. A new revision ID is generated on
2326
+ # every successful write.
2327
+ # @return [String]
2328
+ #
2329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ResourcePolicySummary AWS API Documentation
2330
+ #
2331
+ class ResourcePolicySummary < Struct.new(
2332
+ :policy_name,
2333
+ :revision_id)
2334
+ SENSITIVE = []
2335
+ include Aws::Structure
2336
+ end
2337
+
2338
+ # Retry policy for a subscriber.
2339
+ #
2340
+ # @!attribute [rw] max_retry_attempts
2341
+ # Maximum number of retry attempts (0-185, default: 5).
2342
+ # @return [Integer]
2343
+ #
2344
+ # @!attribute [rw] max_event_age_in_seconds
2345
+ # Maximum age of an event in seconds before it is discarded (60-86400,
2346
+ # default: 300).
2347
+ # @return [Integer]
2348
+ #
2349
+ # @!attribute [rw] retry_strategy
2350
+ # Strategy for determining which exceptions are retried. Default: ALL.
2351
+ # @return [String]
2352
+ #
2353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/RetryPolicy AWS API Documentation
2354
+ #
2355
+ class RetryPolicy < Struct.new(
2356
+ :max_retry_attempts,
2357
+ :max_event_age_in_seconds,
2358
+ :retry_strategy)
2359
+ SENSITIVE = []
2360
+ include Aws::Structure
2361
+ end
2362
+
2363
+ # @!attribute [rw] arn
2364
+ # ARN of a resource a bus owner can revoke: a subscriber or an
2365
+ # EventSource. The pattern is the revocable subset of
2366
+ # TaggableResourceArn; buses are not revocable.
2367
+ # @return [String]
2368
+ #
2369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/RevokeResourceRequest AWS API Documentation
2370
+ #
2371
+ class RevokeResourceRequest < Struct.new(
2372
+ :arn)
2373
+ SENSITIVE = []
2374
+ include Aws::Structure
2375
+ end
2376
+
2377
+ # @!attribute [rw] arn
2378
+ # ARN of a resource a bus owner can revoke: a subscriber or an
2379
+ # EventSource. The pattern is the revocable subset of
2380
+ # TaggableResourceArn; buses are not revocable.
2381
+ # @return [String]
2382
+ #
2383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/RevokeResourceResponse AWS API Documentation
2384
+ #
2385
+ class RevokeResourceResponse < Struct.new(
2386
+ :arn)
2387
+ SENSITIVE = []
2388
+ include Aws::Structure
2389
+ end
2390
+
2391
+ # Schema registry settings used to encode open-format (Avro/Protobuf)
2392
+ # events.
2393
+ #
2394
+ # @!attribute [rw] registry_uri
2395
+ # Glue Schema Registry ARN, or Confluent Cloud HTTPS URL.
2396
+ # @return [String]
2397
+ #
2398
+ # @!attribute [rw] confluent_public_registry_configuration
2399
+ # Required when RegistryUri is an HTTPS URL. Provides Connection-based
2400
+ # auth for Confluent Cloud.
2401
+ # @return [Types::ConfluentPublicRegistryConfiguration]
2402
+ #
2403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/SchemaRegistryConfiguration AWS API Documentation
2404
+ #
2405
+ class SchemaRegistryConfiguration < Struct.new(
2406
+ :registry_uri,
2407
+ :confluent_public_registry_configuration)
2408
+ SENSITIVE = []
2409
+ include Aws::Structure
2410
+ end
2411
+
2412
+ # The configured schema registry could not be reached. Retry the
2413
+ # request.
2414
+ #
2415
+ # @!attribute [rw] message
2416
+ # @return [String]
2417
+ #
2418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/SchemaRegistryUnavailableException AWS API Documentation
2419
+ #
2420
+ class SchemaRegistryUnavailableException < Struct.new(
2421
+ :message)
2422
+ SENSITIVE = []
2423
+ include Aws::Structure
2424
+ end
2425
+
2426
+ # A custom SNS message attribute (data type plus string or binary
2427
+ # value).
2428
+ #
2429
+ # @!attribute [rw] data_type
2430
+ # Attribute data type. Requiredness and the accepted vocabulary belong
2431
+ # to SNS, which rejects an attribute without a data type on delivery.
2432
+ # @return [String]
2433
+ #
2434
+ # @!attribute [rw] string_value
2435
+ # String attribute value. A JSONata expression resolves once per
2436
+ # delivered event.
2437
+ # @return [String]
2438
+ #
2439
+ # @!attribute [rw] binary_value
2440
+ # Base64-encoded literal binary attribute value.
2441
+ # @return [String]
2442
+ #
2443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/SnsMessageAttributeValue AWS API Documentation
2444
+ #
2445
+ class SnsMessageAttributeValue < Struct.new(
2446
+ :data_type,
2447
+ :string_value,
2448
+ :binary_value)
2449
+ SENSITIVE = []
2450
+ include Aws::Structure
2451
+ end
2452
+
2453
+ # SNS invocation parameters for subscribers. Values are forwarded to the
2454
+ # SNS PublishBatch API. All scalar values accept a literal or a JSONata
2455
+ # expression (e.g. "\{% $events.Data.groupId %}").
2456
+ #
2457
+ # @!attribute [rw] message_group_id
2458
+ # Message group ID for FIFO topics. Accepts JSONata expression.
2459
+ # @return [String]
2460
+ #
2461
+ # @!attribute [rw] message_deduplication_id
2462
+ # Message deduplication ID for FIFO topics. Accepts JSONata
2463
+ # expression.
2464
+ # @return [String]
2465
+ #
2466
+ # @!attribute [rw] subject
2467
+ # Subject line for email protocol subscriptions. Accepts JSONata
2468
+ # expression.
2469
+ # @return [String]
2470
+ #
2471
+ # @!attribute [rw] message_structure
2472
+ # Per-protocol message formatting mode, forwarded to SNS Publish
2473
+ # unchanged. Accepts JSONata expression.
2474
+ # @return [String]
2475
+ #
2476
+ # @!attribute [rw] message_attributes
2477
+ # Custom message attributes for SNS filtering.
2478
+ # @return [Hash<String,Types::SnsMessageAttributeValue>]
2479
+ #
2480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/SnsParameters AWS API Documentation
2481
+ #
2482
+ class SnsParameters < Struct.new(
2483
+ :message_group_id,
2484
+ :message_deduplication_id,
2485
+ :subject,
2486
+ :message_structure,
2487
+ :message_attributes)
2488
+ SENSITIVE = []
2489
+ include Aws::Structure
2490
+ end
2491
+
2492
+ # A custom SQS message attribute (data type plus string or binary
2493
+ # value).
2494
+ #
2495
+ # @!attribute [rw] data_type
2496
+ # Attribute data type. Requiredness, the accepted vocabulary, and any
2497
+ # custom label belong to SQS, which rejects an attribute without a
2498
+ # data type on delivery.
2499
+ # @return [String]
2500
+ #
2501
+ # @!attribute [rw] string_value
2502
+ # String attribute value. A JSONata expression resolves once per
2503
+ # delivered event.
2504
+ # @return [String]
2505
+ #
2506
+ # @!attribute [rw] binary_value
2507
+ # Base64-encoded literal binary attribute value.
2508
+ # @return [String]
2509
+ #
2510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/SqsMessageAttributeValue AWS API Documentation
2511
+ #
2512
+ class SqsMessageAttributeValue < Struct.new(
2513
+ :data_type,
2514
+ :string_value,
2515
+ :binary_value)
2516
+ SENSITIVE = []
2517
+ include Aws::Structure
2518
+ end
2519
+
2520
+ # SQS invocation parameters for subscribers. Values are forwarded to the
2521
+ # SQS SendMessageBatch API. All scalar values accept a literal or a
2522
+ # JSONata expression (e.g. "\{% $events.Data.groupId %}").
2523
+ #
2524
+ # @!attribute [rw] message_group_id
2525
+ # Message group ID for FIFO queues. Accepts JSONata expression.
2526
+ # @return [String]
2527
+ #
2528
+ # @!attribute [rw] message_deduplication_id
2529
+ # Message deduplication ID for FIFO queues. Accepts JSONata
2530
+ # expression.
2531
+ # @return [String]
2532
+ #
2533
+ # @!attribute [rw] delay_seconds
2534
+ # Delay in seconds before the message becomes visible, standard queues
2535
+ # only. Accepts JSONata expression.
2536
+ # @return [String]
2537
+ #
2538
+ # @!attribute [rw] message_attributes
2539
+ # Custom message attributes (name/type/value).
2540
+ # @return [Hash<String,Types::SqsMessageAttributeValue>]
2541
+ #
2542
+ # @!attribute [rw] message_system_attributes
2543
+ # System message attributes (e.g., AWSTraceHeader).
2544
+ # @return [Hash<String,Types::SqsMessageAttributeValue>]
2545
+ #
2546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/SqsParameters AWS API Documentation
2547
+ #
2548
+ class SqsParameters < Struct.new(
2549
+ :message_group_id,
2550
+ :message_deduplication_id,
2551
+ :delay_seconds,
2552
+ :message_attributes,
2553
+ :message_system_attributes)
2554
+ SENSITIVE = []
2555
+ include Aws::Structure
2556
+ end
2557
+
2558
+ # Step Functions invocation parameters for subscribers. Values are
2559
+ # forwarded to the Step Functions StartExecution or StartSyncExecution
2560
+ # API. Every string member accepts a literal or a JSONata expression
2561
+ # (e.g. "\{% $events.Data.executionName %}").
2562
+ #
2563
+ # @!attribute [rw] invocation_type
2564
+ # Selects StartExecution (EVENT) or StartSyncExecution
2565
+ # (REQUEST\_RESPONSE) at delivery.
2566
+ # @return [String]
2567
+ #
2568
+ # @!attribute [rw] name
2569
+ # Name for the execution. Must be unique per account/region/state
2570
+ # machine. Accepts JSONata expression.
2571
+ # @return [String]
2572
+ #
2573
+ # @!attribute [rw] trace_header
2574
+ # X-Ray trace header for distributed tracing. Accepts JSONata
2575
+ # expression.
2576
+ # @return [String]
2577
+ #
2578
+ # @!attribute [rw] invocation_timeout_seconds
2579
+ # Timeout in seconds for each invocation of the target (1-30).
2580
+ # String-typed (not integer) so the value may be a JSONata expression.
2581
+ # @return [String]
2582
+ #
2583
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/StepFunctionsParameters AWS API Documentation
2584
+ #
2585
+ class StepFunctionsParameters < Struct.new(
2586
+ :invocation_type,
2587
+ :name,
2588
+ :trace_header,
2589
+ :invocation_timeout_seconds)
2590
+ SENSITIVE = []
2591
+ include Aws::Structure
2592
+ end
2593
+
2594
+ # Event storage configuration for an event bus.
2595
+ #
2596
+ # @!attribute [rw] retention_period_in_days
2597
+ # Number of days events are retained on the event bus.
2598
+ # @return [Integer]
2599
+ #
2600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/StorageConfiguration AWS API Documentation
2601
+ #
2602
+ class StorageConfiguration < Struct.new(
2603
+ :retention_period_in_days)
2604
+ SENSITIVE = []
2605
+ include Aws::Structure
2606
+ end
2607
+
2608
+ # Event storage configuration of an event bus, as returned on reads.
2609
+ #
2610
+ # @!attribute [rw] retention_period_in_days
2611
+ # Number of days events are retained on the event bus.
2612
+ # @return [Integer]
2613
+ #
2614
+ # @!attribute [rw] retention_window_start_time
2615
+ # The earliest point in time from which stored events are available.
2616
+ # Events older than this have expired from retention.
2617
+ # @return [Time]
2618
+ #
2619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/StorageConfigurationOutput AWS API Documentation
2620
+ #
2621
+ class StorageConfigurationOutput < Struct.new(
2622
+ :retention_period_in_days,
2623
+ :retention_window_start_time)
2624
+ SENSITIVE = []
2625
+ include Aws::Structure
2626
+ end
2627
+
2628
+ # Summary of a subscriber, as returned by ListSubscribers.
2629
+ #
2630
+ # @!attribute [rw] subscriber_arn
2631
+ # The Amazon Resource Name (ARN) that uniquely identifies a
2632
+ # subscriber.
2633
+ # @return [String]
2634
+ #
2635
+ # @!attribute [rw] name
2636
+ # Name of a subscriber. The first character must be alphanumeric; the
2637
+ # remaining characters may also include '.', '-', and '\_'.
2638
+ # @return [String]
2639
+ #
2640
+ # @!attribute [rw] event_bus_arn
2641
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
2642
+ # bus.
2643
+ # @return [String]
2644
+ #
2645
+ # @!attribute [rw] target_arn
2646
+ # ARN of the target a subscriber invokes. The resource grammar is
2647
+ # service-neutral because target services use different separators and
2648
+ # the USI form omits region and account.
2649
+ # @return [String]
2650
+ #
2651
+ # @!attribute [rw] type
2652
+ # Delivery ordering mode of a subscriber: FIFO delivers events in
2653
+ # order within an event group; UNORDERED delivers without an ordering
2654
+ # guarantee.
2655
+ # @return [String]
2656
+ #
2657
+ # @!attribute [rw] revoked
2658
+ # True when the bus owner has revoked this subscriber. Present only
2659
+ # when true, so a bus owner listing subscribers sees at a glance which
2660
+ # ones they revoked. See DescribeSubscriberResponse$Revoked.
2661
+ # @return [Boolean]
2662
+ #
2663
+ # @!attribute [rw] state
2664
+ # Customer-controlled run state of a subscriber, set on create or
2665
+ # update. Distinct from the bus lifecycle vocabulary, where ACTIVE
2666
+ # means "provisioned and healthy". Delivery requires State RUNNING on
2667
+ # a subscriber that is not revoked.
2668
+ # @return [String]
2669
+ #
2670
+ # @!attribute [rw] creation_time
2671
+ # The time the subscriber was created.
2672
+ # @return [Time]
2673
+ #
2674
+ # @!attribute [rw] last_modified_time
2675
+ # The time the subscriber was last modified.
2676
+ # @return [Time]
2677
+ #
2678
+ # @!attribute [rw] subscriber_account_id
2679
+ # AWS Account Id.
2680
+ # @return [String]
2681
+ #
2682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/SubscriberSummary AWS API Documentation
2683
+ #
2684
+ class SubscriberSummary < Struct.new(
2685
+ :subscriber_arn,
2686
+ :name,
2687
+ :event_bus_arn,
2688
+ :target_arn,
2689
+ :type,
2690
+ :revoked,
2691
+ :state,
2692
+ :creation_time,
2693
+ :last_modified_time,
2694
+ :subscriber_account_id)
2695
+ SENSITIVE = []
2696
+ include Aws::Structure
2697
+ end
2698
+
2699
+ # @!attribute [rw] resource_arn
2700
+ # ARN for an EventBridge resource that supports tagging: event buses,
2701
+ # subscribers, and event sources.
2702
+ # @return [String]
2703
+ #
2704
+ # @!attribute [rw] tags
2705
+ # Tags attached to a resource, as key-value pairs.
2706
+ # @return [Hash<String,String>]
2707
+ #
2708
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/TagResourceRequest AWS API Documentation
2709
+ #
2710
+ class TagResourceRequest < Struct.new(
2711
+ :resource_arn,
2712
+ :tags)
2713
+ SENSITIVE = []
2714
+ include Aws::Structure
2715
+ end
2716
+
2717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/TagResourceResponse AWS API Documentation
2718
+ #
2719
+ class TagResourceResponse < Aws::EmptyStructure; end
2720
+
2721
+ # The request was throttled because it exceeds a request rate limit.
2722
+ # Retry the request with backoff.
2723
+ #
2724
+ # @!attribute [rw] message
2725
+ # @return [String]
2726
+ #
2727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/ThrottlingException AWS API Documentation
2728
+ #
2729
+ class ThrottlingException < Struct.new(
2730
+ :message)
2731
+ SENSITIVE = []
2732
+ include Aws::Structure
2733
+ end
2734
+
2735
+ # Transformer configuration for a subscriber.
2736
+ #
2737
+ # @!attribute [rw] type
2738
+ # Transform type.
2739
+ # @return [String]
2740
+ #
2741
+ # @!attribute [rw] jsonata_configuration
2742
+ # JSONata expression configuration. Required when Type is JSONATA.
2743
+ # @return [Types::JsonataConfiguration]
2744
+ #
2745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/Transformer AWS API Documentation
2746
+ #
2747
+ class Transformer < Struct.new(
2748
+ :type,
2749
+ :jsonata_configuration)
2750
+ SENSITIVE = [:jsonata_configuration]
2751
+ include Aws::Structure
2752
+ end
2753
+
2754
+ # Parameters for USI (Universal Service Integration) targets. Used when
2755
+ # TargetArn is in the format
2756
+ # arn:aws:events:::aws-sdk:\{service}:\{apiAction}
2757
+ #
2758
+ # @!attribute [rw] input
2759
+ # JSON string or JSONata expression that produces the API request.
2760
+ # Supports \{% ... %} JSONata expressions for dynamic values from the
2761
+ # event.
2762
+ # @return [String]
2763
+ #
2764
+ # @!attribute [rw] invocation_timeout_seconds
2765
+ # Timeout in seconds for each invocation of the target (1-30, default
2766
+ # 30). Accepts a literal integer or a \{% ... %} JSONata expression
2767
+ # evaluated against the event at invocation time. A JSONata expression
2768
+ # is syntax-checked at create time. Resolved values outside of the
2769
+ # range \[1, 30\] will be constrained to the nearest bound at delivery
2770
+ # time. Defaults to 30 seconds when unset.
2771
+ # @return [String]
2772
+ #
2773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UniversalTargetParameters AWS API Documentation
2774
+ #
2775
+ class UniversalTargetParameters < Struct.new(
2776
+ :input,
2777
+ :invocation_timeout_seconds)
2778
+ SENSITIVE = []
2779
+ include Aws::Structure
2780
+ end
2781
+
2782
+ # @!attribute [rw] resource_arn
2783
+ # ARN for an EventBridge resource that supports tagging: event buses,
2784
+ # subscribers, and event sources.
2785
+ # @return [String]
2786
+ #
2787
+ # @!attribute [rw] tag_keys
2788
+ # List of tag keys.
2789
+ # @return [Array<String>]
2790
+ #
2791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UntagResourceRequest AWS API Documentation
2792
+ #
2793
+ class UntagResourceRequest < Struct.new(
2794
+ :resource_arn,
2795
+ :tag_keys)
2796
+ SENSITIVE = []
2797
+ include Aws::Structure
2798
+ end
2799
+
2800
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UntagResourceResponse AWS API Documentation
2801
+ #
2802
+ class UntagResourceResponse < Aws::EmptyStructure; end
2803
+
2804
+ # @!attribute [rw] event_bus_arn
2805
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
2806
+ # bus.
2807
+ # @return [String]
2808
+ #
2809
+ # @!attribute [rw] description
2810
+ # Free-text description. Used by every resource type that has one:
2811
+ # event buses, subscribers, and event sources.
2812
+ # @return [String]
2813
+ #
2814
+ # @!attribute [rw] encryption_configuration
2815
+ # Encryption configuration for an event bus.
2816
+ # @return [Types::EncryptionConfiguration]
2817
+ #
2818
+ # @!attribute [rw] storage_configuration
2819
+ # Event storage configuration for an event bus.
2820
+ # @return [Types::StorageConfiguration]
2821
+ #
2822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateEventBusRequest AWS API Documentation
2823
+ #
2824
+ class UpdateEventBusRequest < Struct.new(
2825
+ :event_bus_arn,
2826
+ :description,
2827
+ :encryption_configuration,
2828
+ :storage_configuration)
2829
+ SENSITIVE = []
2830
+ include Aws::Structure
2831
+ end
2832
+
2833
+ # @!attribute [rw] event_bus_arn
2834
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
2835
+ # bus.
2836
+ # @return [String]
2837
+ #
2838
+ # @!attribute [rw] name
2839
+ # Name of an event bus. The first character must be alphanumeric; the
2840
+ # remaining characters may also include '.', '-', and '\_'. The
2841
+ # grammar matches the name segment of EventBusArn
2842
+ # (event-busv2/<name>/<id>), so every valid name can be represented in
2843
+ # the bus's ARN. The same type is used everywhere a bus name
2844
+ # appears.</p> </id></name>
2845
+ # @return [String]
2846
+ #
2847
+ # @!attribute [rw] description
2848
+ # Free-text description. Used by every resource type that has one:
2849
+ # event buses, subscribers, and event sources.
2850
+ # @return [String]
2851
+ #
2852
+ # @!attribute [rw] encryption_configuration
2853
+ # Encryption configuration for an event bus.
2854
+ # @return [Types::EncryptionConfiguration]
2855
+ #
2856
+ # @!attribute [rw] storage_configuration
2857
+ # Event storage configuration of an event bus, as returned on reads.
2858
+ # @return [Types::StorageConfigurationOutput]
2859
+ #
2860
+ # @!attribute [rw] state
2861
+ # Lifecycle state of an event bus.
2862
+ #
2863
+ # * CREATING: Bus creation is in progress.
2864
+ # * CREATE\_FAILED: Bus creation failed; see StateReason. The bus
2865
+ # cannot be recovered or recreated in place: delete it with
2866
+ # DeleteEventBus, then create a new bus.
2867
+ # * ACTIVE: Bus is fully operational and can accept events.
2868
+ # * UPDATING: Bus update is in progress.
2869
+ # * UPDATE\_FAILED: Bus update failed; the bus remains operational
2870
+ # with its previous configuration.
2871
+ # * DELETING: Bus deletion is actively in progress.
2872
+ # * DELETE\_FAILED: Bus deletion failed; see StateReason. Retry
2873
+ # DeleteEventBus after removing subscribers and event sources.
2874
+ # @return [String]
2875
+ #
2876
+ # @!attribute [rw] state_reason
2877
+ # Human-readable explanation of why an event bus is in its current
2878
+ # State. Omitted when the bus is in a normal operational state
2879
+ # (ACTIVE). It stands in for the error response an asynchronous
2880
+ # failure cannot return, so it applies only to resources with an
2881
+ # asynchronous lifecycle: event buses. EventSources and subscribers
2882
+ # are provisioned synchronously and report failures directly on the
2883
+ # request.
2884
+ # @return [String]
2885
+ #
2886
+ # @!attribute [rw] last_modified_time
2887
+ # The time the event bus was last modified.
2888
+ # @return [Time]
2889
+ #
2890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateEventBusResponse AWS API Documentation
2891
+ #
2892
+ class UpdateEventBusResponse < Struct.new(
2893
+ :event_bus_arn,
2894
+ :name,
2895
+ :description,
2896
+ :encryption_configuration,
2897
+ :storage_configuration,
2898
+ :state,
2899
+ :state_reason,
2900
+ :last_modified_time)
2901
+ SENSITIVE = []
2902
+ include Aws::Structure
2903
+ end
2904
+
2905
+ # @!attribute [rw] event_source_arn
2906
+ # EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
2907
+ # is set by the service (aws.service for AWS service events,
2908
+ # aws.partner for partner events) and is not part of the resource's
2909
+ # name. The id segment is a 25-character identifier generated by the
2910
+ # service.</p> </id></name></type>
2911
+ # @return [String]
2912
+ #
2913
+ # @!attribute [rw] configuration
2914
+ # Discriminated EventSource configuration. Exactly one variant must be
2915
+ # set.
2916
+ # @return [Types::EventSourceConfiguration]
2917
+ #
2918
+ # @!attribute [rw] description
2919
+ # Free-text description. Used by every resource type that has one:
2920
+ # event buses, subscribers, and event sources.
2921
+ # @return [String]
2922
+ #
2923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateEventSourceRequest AWS API Documentation
2924
+ #
2925
+ class UpdateEventSourceRequest < Struct.new(
2926
+ :event_source_arn,
2927
+ :configuration,
2928
+ :description)
2929
+ SENSITIVE = []
2930
+ include Aws::Structure
2931
+ end
2932
+
2933
+ # @!attribute [rw] event_source_arn
2934
+ # EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment
2935
+ # is set by the service (aws.service for AWS service events,
2936
+ # aws.partner for partner events) and is not part of the resource's
2937
+ # name. The id segment is a 25-character identifier generated by the
2938
+ # service.</p> </id></name></type>
2939
+ # @return [String]
2940
+ #
2941
+ # @!attribute [rw] name
2942
+ # EventSource name. First character alphanumeric; the rest may add
2943
+ # '.', '-', '\_'. Names may not begin with the reserved "aws."
2944
+ # prefix. The grammar matches the ARN local-name segment in
2945
+ # EventSourceArn (event-sourcev2/<type>/<name>/<id>), mirroring
2946
+ # EventBusName, so a name the ARN cannot represent cannot be
2947
+ # created.</p> </id></name></type>
2948
+ # @return [String]
2949
+ #
2950
+ # @!attribute [rw] event_bus_arn
2951
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
2952
+ # bus.
2953
+ # @return [String]
2954
+ #
2955
+ # @!attribute [rw] state
2956
+ # Lifecycle state of an EventSource. Revocation is reported by the
2957
+ # Revoked flag.
2958
+ # @return [String]
2959
+ #
2960
+ # @!attribute [rw] last_modified_time
2961
+ # The time the EventSource was last modified.
2962
+ # @return [Time]
2963
+ #
2964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateEventSourceResponse AWS API Documentation
2965
+ #
2966
+ class UpdateEventSourceResponse < Struct.new(
2967
+ :event_source_arn,
2968
+ :name,
2969
+ :event_bus_arn,
2970
+ :state,
2971
+ :last_modified_time)
2972
+ SENSITIVE = []
2973
+ include Aws::Structure
2974
+ end
2975
+
2976
+ # Update-able configuration for how the subscriber invokes its target.
2977
+ #
2978
+ # @!attribute [rw] role_arn
2979
+ # IAM role the service assumes to invoke the target. Must belong to
2980
+ # the calling account.
2981
+ # @return [String]
2982
+ #
2983
+ # @!attribute [rw] lambda_parameters
2984
+ # Lambda invocation parameters for subscribers. Values are forwarded
2985
+ # to the Lambda Invoke API. Every string member accepts a literal or a
2986
+ # JSONata expression (e.g. "\{% $events.Data.qualifier %}").
2987
+ # @return [Types::LambdaParameters]
2988
+ #
2989
+ # @!attribute [rw] sqs_parameters
2990
+ # SQS invocation parameters for subscribers. Values are forwarded to
2991
+ # the SQS SendMessageBatch API. All scalar values accept a literal or
2992
+ # a JSONata expression (e.g. "\{% $events.Data.groupId %}").
2993
+ # @return [Types::SqsParameters]
2994
+ #
2995
+ # @!attribute [rw] sns_parameters
2996
+ # SNS invocation parameters for subscribers. Values are forwarded to
2997
+ # the SNS PublishBatch API. All scalar values accept a literal or a
2998
+ # JSONata expression (e.g. "\{% $events.Data.groupId %}").
2999
+ # @return [Types::SnsParameters]
3000
+ #
3001
+ # @!attribute [rw] kinesis_parameters
3002
+ # Kinesis Data Streams invocation parameters for subscribers. Values
3003
+ # are forwarded to the Kinesis PutRecords API. All scalar values
3004
+ # accept a literal or a JSONata expression (e.g. "\{%
3005
+ # $events.Data.partitionKey %}").
3006
+ # @return [Types::KinesisParameters]
3007
+ #
3008
+ # @!attribute [rw] step_functions_parameters
3009
+ # Step Functions invocation parameters for subscribers. Values are
3010
+ # forwarded to the Step Functions StartExecution or StartSyncExecution
3011
+ # API. Every string member accepts a literal or a JSONata expression
3012
+ # (e.g. "\{% $events.Data.executionName %}").
3013
+ # @return [Types::StepFunctionsParameters]
3014
+ #
3015
+ # @!attribute [rw] http_parameters
3016
+ # HTTP invocation parameters for subscribers (API Gateway / API
3017
+ # Destination). Values are forwarded to the HTTP endpoint.
3018
+ # @return [Types::HttpParameters]
3019
+ #
3020
+ # @!attribute [rw] universal_target_parameters
3021
+ # Parameters for USI (Universal Service Integration) targets. Used
3022
+ # when TargetArn is in the format
3023
+ # arn:aws:events:::aws-sdk:\{service}:\{apiAction}
3024
+ # @return [Types::UniversalTargetParameters]
3025
+ #
3026
+ # @!attribute [rw] event_bus_v2_parameters
3027
+ # Parameters for forwarding events to another EventBridge event bus.
3028
+ # @return [Types::EventBusV2Parameters]
3029
+ #
3030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateInvokeConfiguration AWS API Documentation
3031
+ #
3032
+ class UpdateInvokeConfiguration < Struct.new(
3033
+ :role_arn,
3034
+ :lambda_parameters,
3035
+ :sqs_parameters,
3036
+ :sns_parameters,
3037
+ :kinesis_parameters,
3038
+ :step_functions_parameters,
3039
+ :http_parameters,
3040
+ :universal_target_parameters,
3041
+ :event_bus_v2_parameters)
3042
+ SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
3043
+ include Aws::Structure
3044
+ end
3045
+
3046
+ # @!attribute [rw] subscriber_arn
3047
+ # The Amazon Resource Name (ARN) that uniquely identifies a
3048
+ # subscriber.
3049
+ # @return [String]
3050
+ #
3051
+ # @!attribute [rw] description
3052
+ # Free-text description. Used by every resource type that has one:
3053
+ # event buses, subscribers, and event sources.
3054
+ # @return [String]
3055
+ #
3056
+ # @!attribute [rw] state
3057
+ # Customer-controlled run state of a subscriber, set on create or
3058
+ # update. Distinct from the bus lifecycle vocabulary, where ACTIVE
3059
+ # means "provisioned and healthy". Delivery requires State RUNNING on
3060
+ # a subscriber that is not revoked.
3061
+ # @return [String]
3062
+ #
3063
+ # @!attribute [rw] resume_position
3064
+ # Position from which delivery resumes when a subscriber is unpaused.
3065
+ # Honored only on an UpdateSubscriber call that transitions State from
3066
+ # STOPPED to RUNNING (unpause); ignored on any other call and not
3067
+ # accepted on Create. Defaults to LAST\_PROCESSED when omitted.
3068
+ # @return [String]
3069
+ #
3070
+ # @!attribute [rw] invoke_configuration
3071
+ # Update-able configuration for how the subscriber invokes its target.
3072
+ # @return [Types::UpdateInvokeConfiguration]
3073
+ #
3074
+ # @!attribute [rw] filter_configuration
3075
+ # Configuration for filtering events delivered to a subscriber. On
3076
+ # CreateSubscriber, Filters is required and must contain at least one
3077
+ # Filter with a non-empty Pattern. On UpdateSubscriber, an empty
3078
+ # `FilterConfiguration:{}` clears the existing filter. Any non-empty
3079
+ # shape (including `{Language:X}` without Filters) must contain a
3080
+ # valid Filters list — same contract as CreateSubscriber. A non-empty
3081
+ # Filters list overwrites; an omitted FilterConfiguration preserves
3082
+ # existing state. All Filters are implicitly ANDed — an event must
3083
+ # match every Filter to be delivered.
3084
+ # @return [Types::FilterConfiguration]
3085
+ #
3086
+ # @!attribute [rw] batch_configuration
3087
+ # Batching configuration for a subscriber.
3088
+ # @return [Types::BatchConfiguration]
3089
+ #
3090
+ # @!attribute [rw] transformer
3091
+ # Not applicable to universal (aws-sdk) targets, whose input
3092
+ # transformation is UniversalTargetParameters.Input; a Transformer on
3093
+ # such a target is rejected.
3094
+ # @return [Types::Transformer]
3095
+ #
3096
+ # @!attribute [rw] retry_policy
3097
+ # Retry policy for a subscriber.
3098
+ # @return [Types::RetryPolicy]
3099
+ #
3100
+ # @!attribute [rw] on_failure_configuration
3101
+ # On-failure configuration: where a failed delivery is sent. Shared by
3102
+ # the subscriber and the EventSource.
3103
+ # @return [Types::OnFailureConfiguration]
3104
+ #
3105
+ # @!attribute [rw] log_configuration
3106
+ # Log configuration for a subscriber.
3107
+ # @return [Types::LogConfiguration]
3108
+ #
3109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateSubscriberRequest AWS API Documentation
3110
+ #
3111
+ class UpdateSubscriberRequest < Struct.new(
3112
+ :subscriber_arn,
3113
+ :description,
3114
+ :state,
3115
+ :resume_position,
3116
+ :invoke_configuration,
3117
+ :filter_configuration,
3118
+ :batch_configuration,
3119
+ :transformer,
3120
+ :retry_policy,
3121
+ :on_failure_configuration,
3122
+ :log_configuration)
3123
+ SENSITIVE = []
3124
+ include Aws::Structure
3125
+ end
3126
+
3127
+ # @!attribute [rw] subscriber_arn
3128
+ # The Amazon Resource Name (ARN) that uniquely identifies a
3129
+ # subscriber.
3130
+ # @return [String]
3131
+ #
3132
+ # @!attribute [rw] name
3133
+ # Name of a subscriber. The first character must be alphanumeric; the
3134
+ # remaining characters may also include '.', '-', and '\_'.
3135
+ # @return [String]
3136
+ #
3137
+ # @!attribute [rw] event_bus_arn
3138
+ # The Amazon Resource Name (ARN) that uniquely identifies an event
3139
+ # bus.
3140
+ # @return [String]
3141
+ #
3142
+ # @!attribute [rw] type
3143
+ # Delivery ordering mode of a subscriber: FIFO delivers events in
3144
+ # order within an event group; UNORDERED delivers without an ordering
3145
+ # guarantee.
3146
+ # @return [String]
3147
+ #
3148
+ # @!attribute [rw] starting_position
3149
+ # Starting position for a subscriber.
3150
+ # @return [String]
3151
+ #
3152
+ # @!attribute [rw] point_in_time_configuration
3153
+ # Point-in-time configuration for a subscriber. Only applicable when
3154
+ # StartingPosition is POINT\_IN\_TIME.
3155
+ # @return [Types::PointInTimeConfiguration]
3156
+ #
3157
+ # @!attribute [rw] state
3158
+ # Customer-controlled run state of a subscriber, set on create or
3159
+ # update. Distinct from the bus lifecycle vocabulary, where ACTIVE
3160
+ # means "provisioned and healthy". Delivery requires State RUNNING on
3161
+ # a subscriber that is not revoked.
3162
+ # @return [String]
3163
+ #
3164
+ # @!attribute [rw] last_modified_time
3165
+ # The time the subscriber was last modified.
3166
+ # @return [Time]
3167
+ #
3168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridgev2-2025-05-15/UpdateSubscriberResponse AWS API Documentation
3169
+ #
3170
+ class UpdateSubscriberResponse < Struct.new(
3171
+ :subscriber_arn,
3172
+ :name,
3173
+ :event_bus_arn,
3174
+ :type,
3175
+ :starting_position,
3176
+ :point_in_time_configuration,
3177
+ :state,
3178
+ :last_modified_time)
3179
+ SENSITIVE = []
3180
+ include Aws::Structure
3181
+ end
3182
+
3183
+ end
3184
+ end
3185
+