aws-sdk-eventbridge 1.16.0 → 1.21.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -28,6 +28,7 @@ module Aws::EventBridge
28
28
  #
29
29
  # ## Error Classes
30
30
  # * {ConcurrentModificationException}
31
+ # * {IllegalStatusException}
31
32
  # * {InternalException}
32
33
  # * {InvalidEventPatternException}
33
34
  # * {InvalidStateException}
@@ -54,6 +55,16 @@ module Aws::EventBridge
54
55
  end
55
56
  end
56
57
 
58
+ class IllegalStatusException < ServiceError
59
+
60
+ # @param [Seahorse::Client::RequestContext] context
61
+ # @param [String] message
62
+ # @param [Aws::EventBridge::Types::IllegalStatusException] data
63
+ def initialize(context, message, data = Aws::EmptyStructure.new)
64
+ super(context, message, data)
65
+ end
66
+ end
67
+
57
68
  class InternalException < ServiceError
58
69
 
59
70
  # @param [Seahorse::Client::RequestContext] context
@@ -29,6 +29,114 @@ module Aws::EventBridge
29
29
  include Aws::Structure
30
30
  end
31
31
 
32
+ # Contains details about an API destination.
33
+ #
34
+ # @!attribute [rw] api_destination_arn
35
+ # The ARN of the API destination.
36
+ # @return [String]
37
+ #
38
+ # @!attribute [rw] name
39
+ # The name of the API destination.
40
+ # @return [String]
41
+ #
42
+ # @!attribute [rw] api_destination_state
43
+ # The state of the API destination.
44
+ # @return [String]
45
+ #
46
+ # @!attribute [rw] connection_arn
47
+ # The ARN of the connection specified for the API destination.
48
+ # @return [String]
49
+ #
50
+ # @!attribute [rw] invocation_endpoint
51
+ # The URL to the endpoint for the API destination.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] http_method
55
+ # The method to use to connect to the HTTP endpoint.
56
+ # @return [String]
57
+ #
58
+ # @!attribute [rw] invocation_rate_limit_per_second
59
+ # The maximum number of invocations per second to send to the HTTP
60
+ # endpoint.
61
+ # @return [Integer]
62
+ #
63
+ # @!attribute [rw] creation_time
64
+ # A time stamp for the time that the API destination was created.
65
+ # @return [Time]
66
+ #
67
+ # @!attribute [rw] last_modified_time
68
+ # A time stamp for the time that the API destination was last
69
+ # modified.
70
+ # @return [Time]
71
+ #
72
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ApiDestination AWS API Documentation
73
+ #
74
+ class ApiDestination < Struct.new(
75
+ :api_destination_arn,
76
+ :name,
77
+ :api_destination_state,
78
+ :connection_arn,
79
+ :invocation_endpoint,
80
+ :http_method,
81
+ :invocation_rate_limit_per_second,
82
+ :creation_time,
83
+ :last_modified_time)
84
+ SENSITIVE = []
85
+ include Aws::Structure
86
+ end
87
+
88
+ # An `Archive` object that contains details about an archive.
89
+ #
90
+ # @!attribute [rw] archive_name
91
+ # The name of the archive.
92
+ # @return [String]
93
+ #
94
+ # @!attribute [rw] event_source_arn
95
+ # The ARN of the event bus associated with the archive. Only events
96
+ # from this event bus are sent to the archive.
97
+ # @return [String]
98
+ #
99
+ # @!attribute [rw] state
100
+ # The current state of the archive.
101
+ # @return [String]
102
+ #
103
+ # @!attribute [rw] state_reason
104
+ # A description for the reason that the archive is in the current
105
+ # state.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] retention_days
109
+ # The number of days to retain events in the archive before they are
110
+ # deleted.
111
+ # @return [Integer]
112
+ #
113
+ # @!attribute [rw] size_bytes
114
+ # The size of the archive, in bytes.
115
+ # @return [Integer]
116
+ #
117
+ # @!attribute [rw] event_count
118
+ # The number of events in the archive.
119
+ # @return [Integer]
120
+ #
121
+ # @!attribute [rw] creation_time
122
+ # The time stamp for the time that the archive was created.
123
+ # @return [Time]
124
+ #
125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Archive AWS API Documentation
126
+ #
127
+ class Archive < Struct.new(
128
+ :archive_name,
129
+ :event_source_arn,
130
+ :state,
131
+ :state_reason,
132
+ :retention_days,
133
+ :size_bytes,
134
+ :event_count,
135
+ :creation_time)
136
+ SENSITIVE = []
137
+ include Aws::Structure
138
+ end
139
+
32
140
  # This structure specifies the VPC subnets and security groups for the
33
141
  # task, and whether a public IP address is to be used. This structure is
34
142
  # relevant only for ECS tasks that use the `awsvpc` network mode.
@@ -171,7 +279,49 @@ module Aws::EventBridge
171
279
  include Aws::Structure
172
280
  end
173
281
 
174
- # There is concurrent modification on a rule or target.
282
+ # @note When making an API call, you may pass CancelReplayRequest
283
+ # data as a hash:
284
+ #
285
+ # {
286
+ # replay_name: "ReplayName", # required
287
+ # }
288
+ #
289
+ # @!attribute [rw] replay_name
290
+ # The name of the replay to cancel.
291
+ # @return [String]
292
+ #
293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CancelReplayRequest AWS API Documentation
294
+ #
295
+ class CancelReplayRequest < Struct.new(
296
+ :replay_name)
297
+ SENSITIVE = []
298
+ include Aws::Structure
299
+ end
300
+
301
+ # @!attribute [rw] replay_arn
302
+ # The ARN of the replay to cancel.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] state
306
+ # The current state of the replay.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] state_reason
310
+ # The reason that the replay is in the current state.
311
+ # @return [String]
312
+ #
313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CancelReplayResponse AWS API Documentation
314
+ #
315
+ class CancelReplayResponse < Struct.new(
316
+ :replay_arn,
317
+ :state,
318
+ :state_reason)
319
+ SENSITIVE = []
320
+ include Aws::Structure
321
+ end
322
+
323
+ # There is concurrent modification on a rule, target, archive, or
324
+ # replay.
175
325
  #
176
326
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConcurrentModificationException AWS API Documentation
177
327
  #
@@ -221,223 +371,1471 @@ module Aws::EventBridge
221
371
  include Aws::Structure
222
372
  end
223
373
 
224
- # @note When making an API call, you may pass CreateEventBusRequest
225
- # data as a hash:
374
+ # Contains information about a connection.
226
375
  #
227
- # {
228
- # name: "EventBusName", # required
229
- # event_source_name: "EventSourceName",
230
- # tags: [
231
- # {
232
- # key: "TagKey", # required
233
- # value: "TagValue", # required
234
- # },
235
- # ],
236
- # }
376
+ # @!attribute [rw] connection_arn
377
+ # The ARN of the connection.
378
+ # @return [String]
237
379
  #
238
380
  # @!attribute [rw] name
239
- # The name of the new event bus.
381
+ # The name of the connection.
382
+ # @return [String]
240
383
  #
241
- # Event bus names cannot contain the / character. You can't use the
242
- # name `default` for a custom event bus, as this name is already used
243
- # for your account's default event bus.
384
+ # @!attribute [rw] connection_state
385
+ # The state of the connection.
386
+ # @return [String]
244
387
  #
245
- # If this is a partner event bus, the name must exactly match the name
246
- # of the partner event source that this event bus is matched to.
388
+ # @!attribute [rw] state_reason
389
+ # The reason that the connection is in the connection state.
247
390
  # @return [String]
248
391
  #
249
- # @!attribute [rw] event_source_name
250
- # If you are creating a partner event bus, this specifies the partner
251
- # event source that the new event bus will be matched with.
392
+ # @!attribute [rw] authorization_type
393
+ # The authorization type specified for the connection.
252
394
  # @return [String]
253
395
  #
254
- # @!attribute [rw] tags
255
- # Tags to associate with the event bus.
256
- # @return [Array<Types::Tag>]
396
+ # @!attribute [rw] creation_time
397
+ # A time stamp for the time that the connection was created.
398
+ # @return [Time]
257
399
  #
258
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEventBusRequest AWS API Documentation
400
+ # @!attribute [rw] last_modified_time
401
+ # A time stamp for the time that the connection was last modified.
402
+ # @return [Time]
259
403
  #
260
- class CreateEventBusRequest < Struct.new(
404
+ # @!attribute [rw] last_authorized_time
405
+ # A time stamp for the time that the connection was last authorized.
406
+ # @return [Time]
407
+ #
408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Connection AWS API Documentation
409
+ #
410
+ class Connection < Struct.new(
411
+ :connection_arn,
261
412
  :name,
262
- :event_source_name,
263
- :tags)
413
+ :connection_state,
414
+ :state_reason,
415
+ :authorization_type,
416
+ :creation_time,
417
+ :last_modified_time,
418
+ :last_authorized_time)
264
419
  SENSITIVE = []
265
420
  include Aws::Structure
266
421
  end
267
422
 
268
- # @!attribute [rw] event_bus_arn
269
- # The ARN of the new event bus.
423
+ # Contains the authorization parameters for the connection if API Key is
424
+ # specified as the authorization type.
425
+ #
426
+ # @!attribute [rw] api_key_name
427
+ # The name of the header to use for the `APIKeyValue` used for
428
+ # authorization.
270
429
  # @return [String]
271
430
  #
272
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEventBusResponse AWS API Documentation
431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionApiKeyAuthResponseParameters AWS API Documentation
273
432
  #
274
- class CreateEventBusResponse < Struct.new(
275
- :event_bus_arn)
433
+ class ConnectionApiKeyAuthResponseParameters < Struct.new(
434
+ :api_key_name)
276
435
  SENSITIVE = []
277
436
  include Aws::Structure
278
437
  end
279
438
 
280
- # @note When making an API call, you may pass CreatePartnerEventSourceRequest
439
+ # Contains the authorization parameters to use for the connection.
440
+ #
441
+ # @!attribute [rw] basic_auth_parameters
442
+ # The authorization parameters for Basic authorization.
443
+ # @return [Types::ConnectionBasicAuthResponseParameters]
444
+ #
445
+ # @!attribute [rw] o_auth_parameters
446
+ # The OAuth parameters to use for authorization.
447
+ # @return [Types::ConnectionOAuthResponseParameters]
448
+ #
449
+ # @!attribute [rw] api_key_auth_parameters
450
+ # The API Key parameters to use for authorization.
451
+ # @return [Types::ConnectionApiKeyAuthResponseParameters]
452
+ #
453
+ # @!attribute [rw] invocation_http_parameters
454
+ # Additional parameters for the connection that are passed through
455
+ # with every invocation to the HTTP endpoint.
456
+ # @return [Types::ConnectionHttpParameters]
457
+ #
458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionAuthResponseParameters AWS API Documentation
459
+ #
460
+ class ConnectionAuthResponseParameters < Struct.new(
461
+ :basic_auth_parameters,
462
+ :o_auth_parameters,
463
+ :api_key_auth_parameters,
464
+ :invocation_http_parameters)
465
+ SENSITIVE = []
466
+ include Aws::Structure
467
+ end
468
+
469
+ # Contains the authorization parameters for the connection if Basic is
470
+ # specified as the authorization type.
471
+ #
472
+ # @!attribute [rw] username
473
+ # The user name to use for Basic authorization.
474
+ # @return [String]
475
+ #
476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionBasicAuthResponseParameters AWS API Documentation
477
+ #
478
+ class ConnectionBasicAuthResponseParameters < Struct.new(
479
+ :username)
480
+ SENSITIVE = []
481
+ include Aws::Structure
482
+ end
483
+
484
+ # Additional parameter included in the body. You can include up to 100
485
+ # additional body parameters per request. An event payload cannot exceed
486
+ # 64 KB.
487
+ #
488
+ # @note When making an API call, you may pass ConnectionBodyParameter
281
489
  # data as a hash:
282
490
  #
283
491
  # {
284
- # name: "EventSourceName", # required
285
- # account: "AccountId", # required
492
+ # key: "String",
493
+ # value: "String",
494
+ # is_value_secret: false,
286
495
  # }
287
496
  #
288
- # @!attribute [rw] name
289
- # The name of the partner event source. This name must be unique and
290
- # must be in the format ` partner_name/event_namespace/event_name `.
291
- # The AWS account that wants to use this partner event source must
292
- # create a partner event bus with a name that matches the name of the
293
- # partner event source.
497
+ # @!attribute [rw] key
498
+ # The key for the parameter.
294
499
  # @return [String]
295
500
  #
296
- # @!attribute [rw] account
297
- # The AWS account ID that is permitted to create a matching partner
298
- # event bus for this partner event source.
501
+ # @!attribute [rw] value
502
+ # The value associated with the key.
299
503
  # @return [String]
300
504
  #
301
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
505
+ # @!attribute [rw] is_value_secret
506
+ # Specified whether the value is secret.
507
+ # @return [Boolean]
302
508
  #
303
- class CreatePartnerEventSourceRequest < Struct.new(
304
- :name,
305
- :account)
509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionBodyParameter AWS API Documentation
510
+ #
511
+ class ConnectionBodyParameter < Struct.new(
512
+ :key,
513
+ :value,
514
+ :is_value_secret)
306
515
  SENSITIVE = []
307
516
  include Aws::Structure
308
517
  end
309
518
 
310
- # @!attribute [rw] event_source_arn
311
- # The ARN of the partner event source.
519
+ # Additional parameter included in the header. You can include up to 100
520
+ # additional header parameters per request. An event payload cannot
521
+ # exceed 64 KB.
522
+ #
523
+ # @note When making an API call, you may pass ConnectionHeaderParameter
524
+ # data as a hash:
525
+ #
526
+ # {
527
+ # key: "HeaderKey",
528
+ # value: "HeaderValue",
529
+ # is_value_secret: false,
530
+ # }
531
+ #
532
+ # @!attribute [rw] key
533
+ # The key for the parameter.
312
534
  # @return [String]
313
535
  #
314
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceResponse AWS API Documentation
536
+ # @!attribute [rw] value
537
+ # The value associated with the key.
538
+ # @return [String]
315
539
  #
316
- class CreatePartnerEventSourceResponse < Struct.new(
317
- :event_source_arn)
540
+ # @!attribute [rw] is_value_secret
541
+ # Specified whether the value is a secret.
542
+ # @return [Boolean]
543
+ #
544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionHeaderParameter AWS API Documentation
545
+ #
546
+ class ConnectionHeaderParameter < Struct.new(
547
+ :key,
548
+ :value,
549
+ :is_value_secret)
318
550
  SENSITIVE = []
319
551
  include Aws::Structure
320
552
  end
321
553
 
322
- # @note When making an API call, you may pass DeactivateEventSourceRequest
554
+ # Contains additional parameters for the connection.
555
+ #
556
+ # @note When making an API call, you may pass ConnectionHttpParameters
323
557
  # data as a hash:
324
558
  #
325
559
  # {
326
- # name: "EventSourceName", # required
560
+ # header_parameters: [
561
+ # {
562
+ # key: "HeaderKey",
563
+ # value: "HeaderValue",
564
+ # is_value_secret: false,
565
+ # },
566
+ # ],
567
+ # query_string_parameters: [
568
+ # {
569
+ # key: "QueryStringKey",
570
+ # value: "QueryStringValue",
571
+ # is_value_secret: false,
572
+ # },
573
+ # ],
574
+ # body_parameters: [
575
+ # {
576
+ # key: "String",
577
+ # value: "String",
578
+ # is_value_secret: false,
579
+ # },
580
+ # ],
327
581
  # }
328
582
  #
329
- # @!attribute [rw] name
330
- # The name of the partner event source to deactivate.
583
+ # @!attribute [rw] header_parameters
584
+ # Contains additional header parameters for the connection.
585
+ # @return [Array<Types::ConnectionHeaderParameter>]
586
+ #
587
+ # @!attribute [rw] query_string_parameters
588
+ # Contains additional query string parameters for the connection.
589
+ # @return [Array<Types::ConnectionQueryStringParameter>]
590
+ #
591
+ # @!attribute [rw] body_parameters
592
+ # Contains additional body string parameters for the connection.
593
+ # @return [Array<Types::ConnectionBodyParameter>]
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionHttpParameters AWS API Documentation
596
+ #
597
+ class ConnectionHttpParameters < Struct.new(
598
+ :header_parameters,
599
+ :query_string_parameters,
600
+ :body_parameters)
601
+ SENSITIVE = []
602
+ include Aws::Structure
603
+ end
604
+
605
+ # Contains the client response parameters for the connection when OAuth
606
+ # is specified as the authorization type.
607
+ #
608
+ # @!attribute [rw] client_id
609
+ # The client ID associated with the response to the connection
610
+ # request.
331
611
  # @return [String]
332
612
  #
333
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeactivateEventSourceRequest AWS API Documentation
613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionOAuthClientResponseParameters AWS API Documentation
334
614
  #
335
- class DeactivateEventSourceRequest < Struct.new(
336
- :name)
615
+ class ConnectionOAuthClientResponseParameters < Struct.new(
616
+ :client_id)
337
617
  SENSITIVE = []
338
618
  include Aws::Structure
339
619
  end
340
620
 
341
- # A `DeadLetterConfig` object that contains information about a
342
- # dead-letter queue configuration.
621
+ # Contains the response parameters when OAuth is specified as the
622
+ # authorization type.
623
+ #
624
+ # @!attribute [rw] client_parameters
625
+ # A `ConnectionOAuthClientResponseParameters` object that contains
626
+ # details about the client parameters returned when OAuth is specified
627
+ # as the authorization type.
628
+ # @return [Types::ConnectionOAuthClientResponseParameters]
629
+ #
630
+ # @!attribute [rw] authorization_endpoint
631
+ # The URL to the HTTP endpoint that authorized the request.
632
+ # @return [String]
633
+ #
634
+ # @!attribute [rw] http_method
635
+ # The method used to connect to the HTTP endpoint.
636
+ # @return [String]
637
+ #
638
+ # @!attribute [rw] o_auth_http_parameters
639
+ # The additional HTTP parameters used for the OAuth authorization
640
+ # request.
641
+ # @return [Types::ConnectionHttpParameters]
642
+ #
643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionOAuthResponseParameters AWS API Documentation
644
+ #
645
+ class ConnectionOAuthResponseParameters < Struct.new(
646
+ :client_parameters,
647
+ :authorization_endpoint,
648
+ :http_method,
649
+ :o_auth_http_parameters)
650
+ SENSITIVE = []
651
+ include Aws::Structure
652
+ end
653
+
654
+ # Additional query string parameter for the connection. You can include
655
+ # up to 100 additional query string parameters per request. Each
656
+ # additional parameter counts towards the event payload size, which
657
+ # cannot exceed 64 KB.
658
+ #
659
+ # @note When making an API call, you may pass ConnectionQueryStringParameter
660
+ # data as a hash:
661
+ #
662
+ # {
663
+ # key: "QueryStringKey",
664
+ # value: "QueryStringValue",
665
+ # is_value_secret: false,
666
+ # }
667
+ #
668
+ # @!attribute [rw] key
669
+ # The key for a query string parameter.
670
+ # @return [String]
671
+ #
672
+ # @!attribute [rw] value
673
+ # The value associated with the key for the query string parameter.
674
+ # @return [String]
675
+ #
676
+ # @!attribute [rw] is_value_secret
677
+ # Specifies whether the value is secret.
678
+ # @return [Boolean]
679
+ #
680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionQueryStringParameter AWS API Documentation
681
+ #
682
+ class ConnectionQueryStringParameter < Struct.new(
683
+ :key,
684
+ :value,
685
+ :is_value_secret)
686
+ SENSITIVE = []
687
+ include Aws::Structure
688
+ end
689
+
690
+ # @note When making an API call, you may pass CreateApiDestinationRequest
691
+ # data as a hash:
692
+ #
693
+ # {
694
+ # name: "ApiDestinationName", # required
695
+ # description: "ApiDestinationDescription",
696
+ # connection_arn: "ConnectionArn", # required
697
+ # invocation_endpoint: "HttpsEndpoint", # required
698
+ # http_method: "POST", # required, accepts POST, GET, HEAD, OPTIONS, PUT, PATCH, DELETE
699
+ # invocation_rate_limit_per_second: 1,
700
+ # }
701
+ #
702
+ # @!attribute [rw] name
703
+ # The name for the API destination to create.
704
+ # @return [String]
705
+ #
706
+ # @!attribute [rw] description
707
+ # A description for the API destination to create.
708
+ # @return [String]
709
+ #
710
+ # @!attribute [rw] connection_arn
711
+ # The ARN of the connection to use for the API destination. The
712
+ # destination endpoint must support the authorization type specified
713
+ # for the connection.
714
+ # @return [String]
715
+ #
716
+ # @!attribute [rw] invocation_endpoint
717
+ # The URL to the HTTP invocation endpoint for the API destination.
718
+ # @return [String]
719
+ #
720
+ # @!attribute [rw] http_method
721
+ # The method to use for the request to the HTTP invocation endpoint.
722
+ # @return [String]
723
+ #
724
+ # @!attribute [rw] invocation_rate_limit_per_second
725
+ # The maximum number of requests per second to send to the HTTP
726
+ # invocation endpoint.
727
+ # @return [Integer]
728
+ #
729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateApiDestinationRequest AWS API Documentation
730
+ #
731
+ class CreateApiDestinationRequest < Struct.new(
732
+ :name,
733
+ :description,
734
+ :connection_arn,
735
+ :invocation_endpoint,
736
+ :http_method,
737
+ :invocation_rate_limit_per_second)
738
+ SENSITIVE = []
739
+ include Aws::Structure
740
+ end
741
+
742
+ # @!attribute [rw] api_destination_arn
743
+ # The ARN of the API destination that was created by the request.
744
+ # @return [String]
745
+ #
746
+ # @!attribute [rw] api_destination_state
747
+ # The state of the API destination that was created by the request.
748
+ # @return [String]
749
+ #
750
+ # @!attribute [rw] creation_time
751
+ # A time stamp indicating the time that the API destination was
752
+ # created.
753
+ # @return [Time]
754
+ #
755
+ # @!attribute [rw] last_modified_time
756
+ # A time stamp indicating the time that the API destination was last
757
+ # modified.
758
+ # @return [Time]
759
+ #
760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateApiDestinationResponse AWS API Documentation
761
+ #
762
+ class CreateApiDestinationResponse < Struct.new(
763
+ :api_destination_arn,
764
+ :api_destination_state,
765
+ :creation_time,
766
+ :last_modified_time)
767
+ SENSITIVE = []
768
+ include Aws::Structure
769
+ end
770
+
771
+ # @note When making an API call, you may pass CreateArchiveRequest
772
+ # data as a hash:
773
+ #
774
+ # {
775
+ # archive_name: "ArchiveName", # required
776
+ # event_source_arn: "Arn", # required
777
+ # description: "ArchiveDescription",
778
+ # event_pattern: "EventPattern",
779
+ # retention_days: 1,
780
+ # }
781
+ #
782
+ # @!attribute [rw] archive_name
783
+ # The name for the archive to create.
784
+ # @return [String]
785
+ #
786
+ # @!attribute [rw] event_source_arn
787
+ # The ARN of the event source associated with the archive.
788
+ # @return [String]
789
+ #
790
+ # @!attribute [rw] description
791
+ # A description for the archive.
792
+ # @return [String]
793
+ #
794
+ # @!attribute [rw] event_pattern
795
+ # An event pattern to use to filter events sent to the archive.
796
+ # @return [String]
797
+ #
798
+ # @!attribute [rw] retention_days
799
+ # The number of days to retain events for. Default value is 0. If set
800
+ # to 0, events are retained indefinitely
801
+ # @return [Integer]
802
+ #
803
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateArchiveRequest AWS API Documentation
804
+ #
805
+ class CreateArchiveRequest < Struct.new(
806
+ :archive_name,
807
+ :event_source_arn,
808
+ :description,
809
+ :event_pattern,
810
+ :retention_days)
811
+ SENSITIVE = []
812
+ include Aws::Structure
813
+ end
814
+
815
+ # @!attribute [rw] archive_arn
816
+ # The ARN of the archive that was created.
817
+ # @return [String]
818
+ #
819
+ # @!attribute [rw] state
820
+ # The state of the archive that was created.
821
+ # @return [String]
822
+ #
823
+ # @!attribute [rw] state_reason
824
+ # The reason that the archive is in the state.
825
+ # @return [String]
826
+ #
827
+ # @!attribute [rw] creation_time
828
+ # The time at which the archive was created.
829
+ # @return [Time]
830
+ #
831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateArchiveResponse AWS API Documentation
832
+ #
833
+ class CreateArchiveResponse < Struct.new(
834
+ :archive_arn,
835
+ :state,
836
+ :state_reason,
837
+ :creation_time)
838
+ SENSITIVE = []
839
+ include Aws::Structure
840
+ end
841
+
842
+ # Contains the API key authorization parameters for the connection.
843
+ #
844
+ # @note When making an API call, you may pass CreateConnectionApiKeyAuthRequestParameters
845
+ # data as a hash:
846
+ #
847
+ # {
848
+ # api_key_name: "AuthHeaderParameters", # required
849
+ # api_key_value: "AuthHeaderParameters", # required
850
+ # }
851
+ #
852
+ # @!attribute [rw] api_key_name
853
+ # The name of the API key to use for authorization.
854
+ # @return [String]
855
+ #
856
+ # @!attribute [rw] api_key_value
857
+ # The value for the API key to use for authorization.
858
+ # @return [String]
859
+ #
860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionApiKeyAuthRequestParameters AWS API Documentation
861
+ #
862
+ class CreateConnectionApiKeyAuthRequestParameters < Struct.new(
863
+ :api_key_name,
864
+ :api_key_value)
865
+ SENSITIVE = []
866
+ include Aws::Structure
867
+ end
868
+
869
+ # Contains the authorization parameters for the connection.
870
+ #
871
+ # @note When making an API call, you may pass CreateConnectionAuthRequestParameters
872
+ # data as a hash:
873
+ #
874
+ # {
875
+ # basic_auth_parameters: {
876
+ # username: "AuthHeaderParameters", # required
877
+ # password: "AuthHeaderParameters", # required
878
+ # },
879
+ # o_auth_parameters: {
880
+ # client_parameters: { # required
881
+ # client_id: "AuthHeaderParameters", # required
882
+ # client_secret: "AuthHeaderParameters", # required
883
+ # },
884
+ # authorization_endpoint: "HttpsEndpoint", # required
885
+ # http_method: "GET", # required, accepts GET, POST, PUT
886
+ # o_auth_http_parameters: {
887
+ # header_parameters: [
888
+ # {
889
+ # key: "HeaderKey",
890
+ # value: "HeaderValue",
891
+ # is_value_secret: false,
892
+ # },
893
+ # ],
894
+ # query_string_parameters: [
895
+ # {
896
+ # key: "QueryStringKey",
897
+ # value: "QueryStringValue",
898
+ # is_value_secret: false,
899
+ # },
900
+ # ],
901
+ # body_parameters: [
902
+ # {
903
+ # key: "String",
904
+ # value: "String",
905
+ # is_value_secret: false,
906
+ # },
907
+ # ],
908
+ # },
909
+ # },
910
+ # api_key_auth_parameters: {
911
+ # api_key_name: "AuthHeaderParameters", # required
912
+ # api_key_value: "AuthHeaderParameters", # required
913
+ # },
914
+ # invocation_http_parameters: {
915
+ # header_parameters: [
916
+ # {
917
+ # key: "HeaderKey",
918
+ # value: "HeaderValue",
919
+ # is_value_secret: false,
920
+ # },
921
+ # ],
922
+ # query_string_parameters: [
923
+ # {
924
+ # key: "QueryStringKey",
925
+ # value: "QueryStringValue",
926
+ # is_value_secret: false,
927
+ # },
928
+ # ],
929
+ # body_parameters: [
930
+ # {
931
+ # key: "String",
932
+ # value: "String",
933
+ # is_value_secret: false,
934
+ # },
935
+ # ],
936
+ # },
937
+ # }
938
+ #
939
+ # @!attribute [rw] basic_auth_parameters
940
+ # A `CreateConnectionBasicAuthRequestParameters` object that contains
941
+ # the Basic authorization parameters to use for the connection.
942
+ # @return [Types::CreateConnectionBasicAuthRequestParameters]
943
+ #
944
+ # @!attribute [rw] o_auth_parameters
945
+ # A `CreateConnectionOAuthRequestParameters` object that contains the
946
+ # OAuth authorization parameters to use for the connection.
947
+ # @return [Types::CreateConnectionOAuthRequestParameters]
948
+ #
949
+ # @!attribute [rw] api_key_auth_parameters
950
+ # A `CreateConnectionApiKeyAuthRequestParameters` object that contains
951
+ # the API key authorization parameters to use for the connection.
952
+ # @return [Types::CreateConnectionApiKeyAuthRequestParameters]
953
+ #
954
+ # @!attribute [rw] invocation_http_parameters
955
+ # A `ConnectionHttpParameters` object that contains the API key
956
+ # authorization parameters to use for the connection. Note that if you
957
+ # include additional parameters for the target of a rule via
958
+ # `HttpParameters`, including query strings, the parameters added for
959
+ # the connection take precedence.
960
+ # @return [Types::ConnectionHttpParameters]
961
+ #
962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionAuthRequestParameters AWS API Documentation
963
+ #
964
+ class CreateConnectionAuthRequestParameters < Struct.new(
965
+ :basic_auth_parameters,
966
+ :o_auth_parameters,
967
+ :api_key_auth_parameters,
968
+ :invocation_http_parameters)
969
+ SENSITIVE = []
970
+ include Aws::Structure
971
+ end
972
+
973
+ # Contains the Basic authorization parameters to use for the connection.
974
+ #
975
+ # @note When making an API call, you may pass CreateConnectionBasicAuthRequestParameters
976
+ # data as a hash:
977
+ #
978
+ # {
979
+ # username: "AuthHeaderParameters", # required
980
+ # password: "AuthHeaderParameters", # required
981
+ # }
982
+ #
983
+ # @!attribute [rw] username
984
+ # The user name to use for Basic authorization.
985
+ # @return [String]
986
+ #
987
+ # @!attribute [rw] password
988
+ # The password associated with the user name to use for Basic
989
+ # authorization.
990
+ # @return [String]
991
+ #
992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionBasicAuthRequestParameters AWS API Documentation
993
+ #
994
+ class CreateConnectionBasicAuthRequestParameters < Struct.new(
995
+ :username,
996
+ :password)
997
+ SENSITIVE = []
998
+ include Aws::Structure
999
+ end
1000
+
1001
+ # Contains the Basic authorization parameters to use for the connection.
1002
+ #
1003
+ # @note When making an API call, you may pass CreateConnectionOAuthClientRequestParameters
1004
+ # data as a hash:
1005
+ #
1006
+ # {
1007
+ # client_id: "AuthHeaderParameters", # required
1008
+ # client_secret: "AuthHeaderParameters", # required
1009
+ # }
1010
+ #
1011
+ # @!attribute [rw] client_id
1012
+ # The client ID to use for OAuth authorization for the connection.
1013
+ # @return [String]
1014
+ #
1015
+ # @!attribute [rw] client_secret
1016
+ # The client secret associated with the client ID to use for OAuth
1017
+ # authorization for the connection.
1018
+ # @return [String]
1019
+ #
1020
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionOAuthClientRequestParameters AWS API Documentation
1021
+ #
1022
+ class CreateConnectionOAuthClientRequestParameters < Struct.new(
1023
+ :client_id,
1024
+ :client_secret)
1025
+ SENSITIVE = []
1026
+ include Aws::Structure
1027
+ end
1028
+
1029
+ # Contains the OAuth authorization parameters to use for the connection.
1030
+ #
1031
+ # @note When making an API call, you may pass CreateConnectionOAuthRequestParameters
1032
+ # data as a hash:
1033
+ #
1034
+ # {
1035
+ # client_parameters: { # required
1036
+ # client_id: "AuthHeaderParameters", # required
1037
+ # client_secret: "AuthHeaderParameters", # required
1038
+ # },
1039
+ # authorization_endpoint: "HttpsEndpoint", # required
1040
+ # http_method: "GET", # required, accepts GET, POST, PUT
1041
+ # o_auth_http_parameters: {
1042
+ # header_parameters: [
1043
+ # {
1044
+ # key: "HeaderKey",
1045
+ # value: "HeaderValue",
1046
+ # is_value_secret: false,
1047
+ # },
1048
+ # ],
1049
+ # query_string_parameters: [
1050
+ # {
1051
+ # key: "QueryStringKey",
1052
+ # value: "QueryStringValue",
1053
+ # is_value_secret: false,
1054
+ # },
1055
+ # ],
1056
+ # body_parameters: [
1057
+ # {
1058
+ # key: "String",
1059
+ # value: "String",
1060
+ # is_value_secret: false,
1061
+ # },
1062
+ # ],
1063
+ # },
1064
+ # }
1065
+ #
1066
+ # @!attribute [rw] client_parameters
1067
+ # A `CreateConnectionOAuthClientRequestParameters` object that
1068
+ # contains the client parameters for OAuth authorization.
1069
+ # @return [Types::CreateConnectionOAuthClientRequestParameters]
1070
+ #
1071
+ # @!attribute [rw] authorization_endpoint
1072
+ # The URL to the authorization endpoint when OAuth is specified as the
1073
+ # authorization type.
1074
+ # @return [String]
1075
+ #
1076
+ # @!attribute [rw] http_method
1077
+ # The method to use for the authorization request.
1078
+ # @return [String]
1079
+ #
1080
+ # @!attribute [rw] o_auth_http_parameters
1081
+ # A `ConnectionHttpParameters` object that contains details about the
1082
+ # additional parameters to use for the connection.
1083
+ # @return [Types::ConnectionHttpParameters]
1084
+ #
1085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionOAuthRequestParameters AWS API Documentation
1086
+ #
1087
+ class CreateConnectionOAuthRequestParameters < Struct.new(
1088
+ :client_parameters,
1089
+ :authorization_endpoint,
1090
+ :http_method,
1091
+ :o_auth_http_parameters)
1092
+ SENSITIVE = []
1093
+ include Aws::Structure
1094
+ end
1095
+
1096
+ # @note When making an API call, you may pass CreateConnectionRequest
1097
+ # data as a hash:
1098
+ #
1099
+ # {
1100
+ # name: "ConnectionName", # required
1101
+ # description: "ConnectionDescription",
1102
+ # authorization_type: "BASIC", # required, accepts BASIC, OAUTH_CLIENT_CREDENTIALS, API_KEY
1103
+ # auth_parameters: { # required
1104
+ # basic_auth_parameters: {
1105
+ # username: "AuthHeaderParameters", # required
1106
+ # password: "AuthHeaderParameters", # required
1107
+ # },
1108
+ # o_auth_parameters: {
1109
+ # client_parameters: { # required
1110
+ # client_id: "AuthHeaderParameters", # required
1111
+ # client_secret: "AuthHeaderParameters", # required
1112
+ # },
1113
+ # authorization_endpoint: "HttpsEndpoint", # required
1114
+ # http_method: "GET", # required, accepts GET, POST, PUT
1115
+ # o_auth_http_parameters: {
1116
+ # header_parameters: [
1117
+ # {
1118
+ # key: "HeaderKey",
1119
+ # value: "HeaderValue",
1120
+ # is_value_secret: false,
1121
+ # },
1122
+ # ],
1123
+ # query_string_parameters: [
1124
+ # {
1125
+ # key: "QueryStringKey",
1126
+ # value: "QueryStringValue",
1127
+ # is_value_secret: false,
1128
+ # },
1129
+ # ],
1130
+ # body_parameters: [
1131
+ # {
1132
+ # key: "String",
1133
+ # value: "String",
1134
+ # is_value_secret: false,
1135
+ # },
1136
+ # ],
1137
+ # },
1138
+ # },
1139
+ # api_key_auth_parameters: {
1140
+ # api_key_name: "AuthHeaderParameters", # required
1141
+ # api_key_value: "AuthHeaderParameters", # required
1142
+ # },
1143
+ # invocation_http_parameters: {
1144
+ # header_parameters: [
1145
+ # {
1146
+ # key: "HeaderKey",
1147
+ # value: "HeaderValue",
1148
+ # is_value_secret: false,
1149
+ # },
1150
+ # ],
1151
+ # query_string_parameters: [
1152
+ # {
1153
+ # key: "QueryStringKey",
1154
+ # value: "QueryStringValue",
1155
+ # is_value_secret: false,
1156
+ # },
1157
+ # ],
1158
+ # body_parameters: [
1159
+ # {
1160
+ # key: "String",
1161
+ # value: "String",
1162
+ # is_value_secret: false,
1163
+ # },
1164
+ # ],
1165
+ # },
1166
+ # },
1167
+ # }
1168
+ #
1169
+ # @!attribute [rw] name
1170
+ # The name for the connection to create.
1171
+ # @return [String]
1172
+ #
1173
+ # @!attribute [rw] description
1174
+ # A description for the connection to create.
1175
+ # @return [String]
1176
+ #
1177
+ # @!attribute [rw] authorization_type
1178
+ # The type of authorization to use for the connection.
1179
+ # @return [String]
1180
+ #
1181
+ # @!attribute [rw] auth_parameters
1182
+ # A `CreateConnectionAuthRequestParameters` object that contains the
1183
+ # authorization parameters to use to authorize with the endpoint.
1184
+ # @return [Types::CreateConnectionAuthRequestParameters]
1185
+ #
1186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionRequest AWS API Documentation
1187
+ #
1188
+ class CreateConnectionRequest < Struct.new(
1189
+ :name,
1190
+ :description,
1191
+ :authorization_type,
1192
+ :auth_parameters)
1193
+ SENSITIVE = []
1194
+ include Aws::Structure
1195
+ end
1196
+
1197
+ # @!attribute [rw] connection_arn
1198
+ # The ARN of the connection that was created by the request.
1199
+ # @return [String]
1200
+ #
1201
+ # @!attribute [rw] connection_state
1202
+ # The state of the connection that was created by the request.
1203
+ # @return [String]
1204
+ #
1205
+ # @!attribute [rw] creation_time
1206
+ # A time stamp for the time that the connection was created.
1207
+ # @return [Time]
1208
+ #
1209
+ # @!attribute [rw] last_modified_time
1210
+ # A time stamp for the time that the connection was last updated.
1211
+ # @return [Time]
1212
+ #
1213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionResponse AWS API Documentation
1214
+ #
1215
+ class CreateConnectionResponse < Struct.new(
1216
+ :connection_arn,
1217
+ :connection_state,
1218
+ :creation_time,
1219
+ :last_modified_time)
1220
+ SENSITIVE = []
1221
+ include Aws::Structure
1222
+ end
1223
+
1224
+ # @note When making an API call, you may pass CreateEventBusRequest
1225
+ # data as a hash:
1226
+ #
1227
+ # {
1228
+ # name: "EventBusName", # required
1229
+ # event_source_name: "EventSourceName",
1230
+ # tags: [
1231
+ # {
1232
+ # key: "TagKey", # required
1233
+ # value: "TagValue", # required
1234
+ # },
1235
+ # ],
1236
+ # }
1237
+ #
1238
+ # @!attribute [rw] name
1239
+ # The name of the new event bus.
1240
+ #
1241
+ # Event bus names cannot contain the / character. You can't use the
1242
+ # name `default` for a custom event bus, as this name is already used
1243
+ # for your account's default event bus.
1244
+ #
1245
+ # If this is a partner event bus, the name must exactly match the name
1246
+ # of the partner event source that this event bus is matched to.
1247
+ # @return [String]
1248
+ #
1249
+ # @!attribute [rw] event_source_name
1250
+ # If you are creating a partner event bus, this specifies the partner
1251
+ # event source that the new event bus will be matched with.
1252
+ # @return [String]
1253
+ #
1254
+ # @!attribute [rw] tags
1255
+ # Tags to associate with the event bus.
1256
+ # @return [Array<Types::Tag>]
1257
+ #
1258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEventBusRequest AWS API Documentation
1259
+ #
1260
+ class CreateEventBusRequest < Struct.new(
1261
+ :name,
1262
+ :event_source_name,
1263
+ :tags)
1264
+ SENSITIVE = []
1265
+ include Aws::Structure
1266
+ end
1267
+
1268
+ # @!attribute [rw] event_bus_arn
1269
+ # The ARN of the new event bus.
1270
+ # @return [String]
1271
+ #
1272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEventBusResponse AWS API Documentation
1273
+ #
1274
+ class CreateEventBusResponse < Struct.new(
1275
+ :event_bus_arn)
1276
+ SENSITIVE = []
1277
+ include Aws::Structure
1278
+ end
1279
+
1280
+ # @note When making an API call, you may pass CreatePartnerEventSourceRequest
1281
+ # data as a hash:
1282
+ #
1283
+ # {
1284
+ # name: "EventSourceName", # required
1285
+ # account: "AccountId", # required
1286
+ # }
1287
+ #
1288
+ # @!attribute [rw] name
1289
+ # The name of the partner event source. This name must be unique and
1290
+ # must be in the format ` partner_name/event_namespace/event_name `.
1291
+ # The AWS account that wants to use this partner event source must
1292
+ # create a partner event bus with a name that matches the name of the
1293
+ # partner event source.
1294
+ # @return [String]
1295
+ #
1296
+ # @!attribute [rw] account
1297
+ # The AWS account ID that is permitted to create a matching partner
1298
+ # event bus for this partner event source.
1299
+ # @return [String]
1300
+ #
1301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
1302
+ #
1303
+ class CreatePartnerEventSourceRequest < Struct.new(
1304
+ :name,
1305
+ :account)
1306
+ SENSITIVE = []
1307
+ include Aws::Structure
1308
+ end
1309
+
1310
+ # @!attribute [rw] event_source_arn
1311
+ # The ARN of the partner event source.
1312
+ # @return [String]
1313
+ #
1314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceResponse AWS API Documentation
1315
+ #
1316
+ class CreatePartnerEventSourceResponse < Struct.new(
1317
+ :event_source_arn)
1318
+ SENSITIVE = []
1319
+ include Aws::Structure
1320
+ end
1321
+
1322
+ # @note When making an API call, you may pass DeactivateEventSourceRequest
1323
+ # data as a hash:
1324
+ #
1325
+ # {
1326
+ # name: "EventSourceName", # required
1327
+ # }
1328
+ #
1329
+ # @!attribute [rw] name
1330
+ # The name of the partner event source to deactivate.
1331
+ # @return [String]
1332
+ #
1333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeactivateEventSourceRequest AWS API Documentation
1334
+ #
1335
+ class DeactivateEventSourceRequest < Struct.new(
1336
+ :name)
1337
+ SENSITIVE = []
1338
+ include Aws::Structure
1339
+ end
1340
+
1341
+ # A `DeadLetterConfig` object that contains information about a
1342
+ # dead-letter queue configuration.
1343
+ #
1344
+ # @note When making an API call, you may pass DeadLetterConfig
1345
+ # data as a hash:
1346
+ #
1347
+ # {
1348
+ # arn: "ResourceArn",
1349
+ # }
1350
+ #
1351
+ # @!attribute [rw] arn
1352
+ # The ARN of the SQS queue specified as the target for the dead-letter
1353
+ # queue.
1354
+ # @return [String]
1355
+ #
1356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeadLetterConfig AWS API Documentation
1357
+ #
1358
+ class DeadLetterConfig < Struct.new(
1359
+ :arn)
1360
+ SENSITIVE = []
1361
+ include Aws::Structure
1362
+ end
1363
+
1364
+ # @note When making an API call, you may pass DeauthorizeConnectionRequest
1365
+ # data as a hash:
1366
+ #
1367
+ # {
1368
+ # name: "ConnectionName", # required
1369
+ # }
1370
+ #
1371
+ # @!attribute [rw] name
1372
+ # The name of the connection to remove authorization from.
1373
+ # @return [String]
1374
+ #
1375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeauthorizeConnectionRequest AWS API Documentation
1376
+ #
1377
+ class DeauthorizeConnectionRequest < Struct.new(
1378
+ :name)
1379
+ SENSITIVE = []
1380
+ include Aws::Structure
1381
+ end
1382
+
1383
+ # @!attribute [rw] connection_arn
1384
+ # The ARN of the connection that authorization was removed from.
1385
+ # @return [String]
1386
+ #
1387
+ # @!attribute [rw] connection_state
1388
+ # The state of the connection.
1389
+ # @return [String]
1390
+ #
1391
+ # @!attribute [rw] creation_time
1392
+ # A time stamp for the time that the connection was created.
1393
+ # @return [Time]
1394
+ #
1395
+ # @!attribute [rw] last_modified_time
1396
+ # A time stamp for the time that the connection was last updated.
1397
+ # @return [Time]
1398
+ #
1399
+ # @!attribute [rw] last_authorized_time
1400
+ # A time stamp for the time that the connection was last authorized.
1401
+ # @return [Time]
1402
+ #
1403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeauthorizeConnectionResponse AWS API Documentation
1404
+ #
1405
+ class DeauthorizeConnectionResponse < Struct.new(
1406
+ :connection_arn,
1407
+ :connection_state,
1408
+ :creation_time,
1409
+ :last_modified_time,
1410
+ :last_authorized_time)
1411
+ SENSITIVE = []
1412
+ include Aws::Structure
1413
+ end
1414
+
1415
+ # @note When making an API call, you may pass DeleteApiDestinationRequest
1416
+ # data as a hash:
1417
+ #
1418
+ # {
1419
+ # name: "ApiDestinationName", # required
1420
+ # }
1421
+ #
1422
+ # @!attribute [rw] name
1423
+ # The name of the destination to delete.
1424
+ # @return [String]
1425
+ #
1426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteApiDestinationRequest AWS API Documentation
1427
+ #
1428
+ class DeleteApiDestinationRequest < Struct.new(
1429
+ :name)
1430
+ SENSITIVE = []
1431
+ include Aws::Structure
1432
+ end
1433
+
1434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteApiDestinationResponse AWS API Documentation
1435
+ #
1436
+ class DeleteApiDestinationResponse < Aws::EmptyStructure; end
1437
+
1438
+ # @note When making an API call, you may pass DeleteArchiveRequest
1439
+ # data as a hash:
1440
+ #
1441
+ # {
1442
+ # archive_name: "ArchiveName", # required
1443
+ # }
1444
+ #
1445
+ # @!attribute [rw] archive_name
1446
+ # The name of the archive to delete.
1447
+ # @return [String]
1448
+ #
1449
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteArchiveRequest AWS API Documentation
1450
+ #
1451
+ class DeleteArchiveRequest < Struct.new(
1452
+ :archive_name)
1453
+ SENSITIVE = []
1454
+ include Aws::Structure
1455
+ end
1456
+
1457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteArchiveResponse AWS API Documentation
1458
+ #
1459
+ class DeleteArchiveResponse < Aws::EmptyStructure; end
1460
+
1461
+ # @note When making an API call, you may pass DeleteConnectionRequest
1462
+ # data as a hash:
1463
+ #
1464
+ # {
1465
+ # name: "ConnectionName", # required
1466
+ # }
1467
+ #
1468
+ # @!attribute [rw] name
1469
+ # The name of the connection to delete.
1470
+ # @return [String]
1471
+ #
1472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteConnectionRequest AWS API Documentation
1473
+ #
1474
+ class DeleteConnectionRequest < Struct.new(
1475
+ :name)
1476
+ SENSITIVE = []
1477
+ include Aws::Structure
1478
+ end
1479
+
1480
+ # @!attribute [rw] connection_arn
1481
+ # The ARN of the connection that was deleted.
1482
+ # @return [String]
1483
+ #
1484
+ # @!attribute [rw] connection_state
1485
+ # The state of the connection before it was deleted.
1486
+ # @return [String]
1487
+ #
1488
+ # @!attribute [rw] creation_time
1489
+ # A time stamp for the time that the connection was created.
1490
+ # @return [Time]
1491
+ #
1492
+ # @!attribute [rw] last_modified_time
1493
+ # A time stamp for the time that the connection was last modified
1494
+ # before it was deleted.
1495
+ # @return [Time]
1496
+ #
1497
+ # @!attribute [rw] last_authorized_time
1498
+ # A time stamp for the time that the connection was last authorized
1499
+ # before it wa deleted.
1500
+ # @return [Time]
1501
+ #
1502
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteConnectionResponse AWS API Documentation
1503
+ #
1504
+ class DeleteConnectionResponse < Struct.new(
1505
+ :connection_arn,
1506
+ :connection_state,
1507
+ :creation_time,
1508
+ :last_modified_time,
1509
+ :last_authorized_time)
1510
+ SENSITIVE = []
1511
+ include Aws::Structure
1512
+ end
1513
+
1514
+ # @note When making an API call, you may pass DeleteEventBusRequest
1515
+ # data as a hash:
1516
+ #
1517
+ # {
1518
+ # name: "EventBusName", # required
1519
+ # }
1520
+ #
1521
+ # @!attribute [rw] name
1522
+ # The name of the event bus to delete.
1523
+ # @return [String]
1524
+ #
1525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteEventBusRequest AWS API Documentation
1526
+ #
1527
+ class DeleteEventBusRequest < Struct.new(
1528
+ :name)
1529
+ SENSITIVE = []
1530
+ include Aws::Structure
1531
+ end
1532
+
1533
+ # @note When making an API call, you may pass DeletePartnerEventSourceRequest
1534
+ # data as a hash:
1535
+ #
1536
+ # {
1537
+ # name: "EventSourceName", # required
1538
+ # account: "AccountId", # required
1539
+ # }
1540
+ #
1541
+ # @!attribute [rw] name
1542
+ # The name of the event source to delete.
1543
+ # @return [String]
1544
+ #
1545
+ # @!attribute [rw] account
1546
+ # The AWS account ID of the AWS customer that the event source was
1547
+ # created for.
1548
+ # @return [String]
1549
+ #
1550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
1551
+ #
1552
+ class DeletePartnerEventSourceRequest < Struct.new(
1553
+ :name,
1554
+ :account)
1555
+ SENSITIVE = []
1556
+ include Aws::Structure
1557
+ end
1558
+
1559
+ # @note When making an API call, you may pass DeleteRuleRequest
1560
+ # data as a hash:
1561
+ #
1562
+ # {
1563
+ # name: "RuleName", # required
1564
+ # event_bus_name: "EventBusNameOrArn",
1565
+ # force: false,
1566
+ # }
1567
+ #
1568
+ # @!attribute [rw] name
1569
+ # The name of the rule.
1570
+ # @return [String]
1571
+ #
1572
+ # @!attribute [rw] event_bus_name
1573
+ # The name or ARN of the event bus associated with the rule. If you
1574
+ # omit this, the default event bus is used.
1575
+ # @return [String]
1576
+ #
1577
+ # @!attribute [rw] force
1578
+ # If this is a managed rule, created by an AWS service on your behalf,
1579
+ # you must specify `Force` as `True` to delete the rule. This
1580
+ # parameter is ignored for rules that are not managed rules. You can
1581
+ # check whether a rule is a managed rule by using `DescribeRule` or
1582
+ # `ListRules` and checking the `ManagedBy` field of the response.
1583
+ # @return [Boolean]
1584
+ #
1585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteRuleRequest AWS API Documentation
1586
+ #
1587
+ class DeleteRuleRequest < Struct.new(
1588
+ :name,
1589
+ :event_bus_name,
1590
+ :force)
1591
+ SENSITIVE = []
1592
+ include Aws::Structure
1593
+ end
1594
+
1595
+ # @note When making an API call, you may pass DescribeApiDestinationRequest
1596
+ # data as a hash:
1597
+ #
1598
+ # {
1599
+ # name: "ApiDestinationName", # required
1600
+ # }
1601
+ #
1602
+ # @!attribute [rw] name
1603
+ # The name of the API destination to retrieve.
1604
+ # @return [String]
1605
+ #
1606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeApiDestinationRequest AWS API Documentation
1607
+ #
1608
+ class DescribeApiDestinationRequest < Struct.new(
1609
+ :name)
1610
+ SENSITIVE = []
1611
+ include Aws::Structure
1612
+ end
1613
+
1614
+ # @!attribute [rw] api_destination_arn
1615
+ # The ARN of the API destination retrieved.
1616
+ # @return [String]
1617
+ #
1618
+ # @!attribute [rw] name
1619
+ # The name of the API destination retrieved.
1620
+ # @return [String]
1621
+ #
1622
+ # @!attribute [rw] description
1623
+ # The description for the API destination retrieved.
1624
+ # @return [String]
1625
+ #
1626
+ # @!attribute [rw] api_destination_state
1627
+ # The state of the API destination retrieved.
1628
+ # @return [String]
1629
+ #
1630
+ # @!attribute [rw] connection_arn
1631
+ # The ARN of the connection specified for the API destination
1632
+ # retrieved.
1633
+ # @return [String]
1634
+ #
1635
+ # @!attribute [rw] invocation_endpoint
1636
+ # The URL to use to connect to the HTTP endpoint.
1637
+ # @return [String]
1638
+ #
1639
+ # @!attribute [rw] http_method
1640
+ # The method to use to connect to the HTTP endpoint.
1641
+ # @return [String]
1642
+ #
1643
+ # @!attribute [rw] invocation_rate_limit_per_second
1644
+ # The maximum number of invocations per second to specified for the
1645
+ # API destination. Note that if you set the invocation rate maximum to
1646
+ # a value lower the rate necessary to send all events received on to
1647
+ # the destination HTTP endpoint, some events may not be delivered
1648
+ # within the 24-hour retry window. If you plan to set the rate lower
1649
+ # than the rate necessary to deliver all events, consider using a
1650
+ # dead-letter queue to catch events that are not delivered within 24
1651
+ # hours.
1652
+ # @return [Integer]
1653
+ #
1654
+ # @!attribute [rw] creation_time
1655
+ # A time stamp for the time that the API destination was created.
1656
+ # @return [Time]
1657
+ #
1658
+ # @!attribute [rw] last_modified_time
1659
+ # A time stamp for the time that the API destination was last
1660
+ # modified.
1661
+ # @return [Time]
1662
+ #
1663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeApiDestinationResponse AWS API Documentation
1664
+ #
1665
+ class DescribeApiDestinationResponse < Struct.new(
1666
+ :api_destination_arn,
1667
+ :name,
1668
+ :description,
1669
+ :api_destination_state,
1670
+ :connection_arn,
1671
+ :invocation_endpoint,
1672
+ :http_method,
1673
+ :invocation_rate_limit_per_second,
1674
+ :creation_time,
1675
+ :last_modified_time)
1676
+ SENSITIVE = []
1677
+ include Aws::Structure
1678
+ end
1679
+
1680
+ # @note When making an API call, you may pass DescribeArchiveRequest
1681
+ # data as a hash:
1682
+ #
1683
+ # {
1684
+ # archive_name: "ArchiveName", # required
1685
+ # }
1686
+ #
1687
+ # @!attribute [rw] archive_name
1688
+ # The name of the archive to retrieve.
1689
+ # @return [String]
1690
+ #
1691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeArchiveRequest AWS API Documentation
1692
+ #
1693
+ class DescribeArchiveRequest < Struct.new(
1694
+ :archive_name)
1695
+ SENSITIVE = []
1696
+ include Aws::Structure
1697
+ end
1698
+
1699
+ # @!attribute [rw] archive_arn
1700
+ # The ARN of the archive.
1701
+ # @return [String]
1702
+ #
1703
+ # @!attribute [rw] archive_name
1704
+ # The name of the archive.
1705
+ # @return [String]
1706
+ #
1707
+ # @!attribute [rw] event_source_arn
1708
+ # The ARN of the event source associated with the archive.
1709
+ # @return [String]
1710
+ #
1711
+ # @!attribute [rw] description
1712
+ # The description of the archive.
1713
+ # @return [String]
1714
+ #
1715
+ # @!attribute [rw] event_pattern
1716
+ # The event pattern used to filter events sent to the archive.
1717
+ # @return [String]
1718
+ #
1719
+ # @!attribute [rw] state
1720
+ # The state of the archive.
1721
+ # @return [String]
1722
+ #
1723
+ # @!attribute [rw] state_reason
1724
+ # The reason that the archive is in the state.
1725
+ # @return [String]
1726
+ #
1727
+ # @!attribute [rw] retention_days
1728
+ # The number of days to retain events for in the archive.
1729
+ # @return [Integer]
343
1730
  #
344
- # @note When making an API call, you may pass DeadLetterConfig
345
- # data as a hash:
1731
+ # @!attribute [rw] size_bytes
1732
+ # The size of the archive in bytes.
1733
+ # @return [Integer]
346
1734
  #
347
- # {
348
- # arn: "ResourceArn",
349
- # }
1735
+ # @!attribute [rw] event_count
1736
+ # The number of events in the archive.
1737
+ # @return [Integer]
350
1738
  #
351
- # @!attribute [rw] arn
352
- # The ARN of the SQS queue specified as the target for the dead-letter
353
- # queue.
354
- # @return [String]
1739
+ # @!attribute [rw] creation_time
1740
+ # The time at which the archive was created.
1741
+ # @return [Time]
355
1742
  #
356
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeadLetterConfig AWS API Documentation
1743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeArchiveResponse AWS API Documentation
357
1744
  #
358
- class DeadLetterConfig < Struct.new(
359
- :arn)
1745
+ class DescribeArchiveResponse < Struct.new(
1746
+ :archive_arn,
1747
+ :archive_name,
1748
+ :event_source_arn,
1749
+ :description,
1750
+ :event_pattern,
1751
+ :state,
1752
+ :state_reason,
1753
+ :retention_days,
1754
+ :size_bytes,
1755
+ :event_count,
1756
+ :creation_time)
360
1757
  SENSITIVE = []
361
1758
  include Aws::Structure
362
1759
  end
363
1760
 
364
- # @note When making an API call, you may pass DeleteEventBusRequest
1761
+ # @note When making an API call, you may pass DescribeConnectionRequest
365
1762
  # data as a hash:
366
1763
  #
367
1764
  # {
368
- # name: "EventBusName", # required
1765
+ # name: "ConnectionName", # required
369
1766
  # }
370
1767
  #
371
1768
  # @!attribute [rw] name
372
- # The name of the event bus to delete.
1769
+ # The name of the connection to retrieve.
373
1770
  # @return [String]
374
1771
  #
375
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteEventBusRequest AWS API Documentation
1772
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeConnectionRequest AWS API Documentation
376
1773
  #
377
- class DeleteEventBusRequest < Struct.new(
1774
+ class DescribeConnectionRequest < Struct.new(
378
1775
  :name)
379
1776
  SENSITIVE = []
380
1777
  include Aws::Structure
381
1778
  end
382
1779
 
383
- # @note When making an API call, you may pass DeletePartnerEventSourceRequest
384
- # data as a hash:
385
- #
386
- # {
387
- # name: "EventSourceName", # required
388
- # account: "AccountId", # required
389
- # }
1780
+ # @!attribute [rw] connection_arn
1781
+ # The ARN of the connection retrieved.
1782
+ # @return [String]
390
1783
  #
391
1784
  # @!attribute [rw] name
392
- # The name of the event source to delete.
1785
+ # The name of the connection retrieved.
393
1786
  # @return [String]
394
1787
  #
395
- # @!attribute [rw] account
396
- # The AWS account ID of the AWS customer that the event source was
397
- # created for.
1788
+ # @!attribute [rw] description
1789
+ # The description for the connection retrieved.
398
1790
  # @return [String]
399
1791
  #
400
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
401
- #
402
- class DeletePartnerEventSourceRequest < Struct.new(
403
- :name,
404
- :account)
405
- SENSITIVE = []
406
- include Aws::Structure
407
- end
408
-
409
- # @note When making an API call, you may pass DeleteRuleRequest
410
- # data as a hash:
1792
+ # @!attribute [rw] connection_state
1793
+ # The state of the connection retrieved.
1794
+ # @return [String]
411
1795
  #
412
- # {
413
- # name: "RuleName", # required
414
- # event_bus_name: "EventBusName",
415
- # force: false,
416
- # }
1796
+ # @!attribute [rw] state_reason
1797
+ # The reason that the connection is in the current connection state.
1798
+ # @return [String]
417
1799
  #
418
- # @!attribute [rw] name
419
- # The name of the rule.
1800
+ # @!attribute [rw] authorization_type
1801
+ # The type of authorization specified for the connection.
420
1802
  # @return [String]
421
1803
  #
422
- # @!attribute [rw] event_bus_name
423
- # The event bus associated with the rule. If you omit this, the
424
- # default event bus is used.
1804
+ # @!attribute [rw] secret_arn
1805
+ # The ARN of the secret created from the authorization parameters
1806
+ # specified for the connection.
425
1807
  # @return [String]
426
1808
  #
427
- # @!attribute [rw] force
428
- # If this is a managed rule, created by an AWS service on your behalf,
429
- # you must specify `Force` as `True` to delete the rule. This
430
- # parameter is ignored for rules that are not managed rules. You can
431
- # check whether a rule is a managed rule by using `DescribeRule` or
432
- # `ListRules` and checking the `ManagedBy` field of the response.
433
- # @return [Boolean]
1809
+ # @!attribute [rw] auth_parameters
1810
+ # The parameters to use for authorization for the connection.
1811
+ # @return [Types::ConnectionAuthResponseParameters]
434
1812
  #
435
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteRuleRequest AWS API Documentation
1813
+ # @!attribute [rw] creation_time
1814
+ # A time stamp for the time that the connection was created.
1815
+ # @return [Time]
436
1816
  #
437
- class DeleteRuleRequest < Struct.new(
1817
+ # @!attribute [rw] last_modified_time
1818
+ # A time stamp for the time that the connection was last modified.
1819
+ # @return [Time]
1820
+ #
1821
+ # @!attribute [rw] last_authorized_time
1822
+ # A time stamp for the time that the connection was last authorized.
1823
+ # @return [Time]
1824
+ #
1825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeConnectionResponse AWS API Documentation
1826
+ #
1827
+ class DescribeConnectionResponse < Struct.new(
1828
+ :connection_arn,
438
1829
  :name,
439
- :event_bus_name,
440
- :force)
1830
+ :description,
1831
+ :connection_state,
1832
+ :state_reason,
1833
+ :authorization_type,
1834
+ :secret_arn,
1835
+ :auth_parameters,
1836
+ :creation_time,
1837
+ :last_modified_time,
1838
+ :last_authorized_time)
441
1839
  SENSITIVE = []
442
1840
  include Aws::Structure
443
1841
  end
@@ -446,12 +1844,12 @@ module Aws::EventBridge
446
1844
  # data as a hash:
447
1845
  #
448
1846
  # {
449
- # name: "EventBusName",
1847
+ # name: "EventBusNameOrArn",
450
1848
  # }
451
1849
  #
452
1850
  # @!attribute [rw] name
453
- # The name of the event bus to show details for. If you omit this, the
454
- # default event bus is displayed.
1851
+ # The name or ARN of the event bus to show details for. If you omit
1852
+ # this, the default event bus is displayed.
455
1853
  # @return [String]
456
1854
  #
457
1855
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeEventBusRequest AWS API Documentation
@@ -584,12 +1982,100 @@ module Aws::EventBridge
584
1982
  include Aws::Structure
585
1983
  end
586
1984
 
1985
+ # @note When making an API call, you may pass DescribeReplayRequest
1986
+ # data as a hash:
1987
+ #
1988
+ # {
1989
+ # replay_name: "ReplayName", # required
1990
+ # }
1991
+ #
1992
+ # @!attribute [rw] replay_name
1993
+ # The name of the replay to retrieve.
1994
+ # @return [String]
1995
+ #
1996
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeReplayRequest AWS API Documentation
1997
+ #
1998
+ class DescribeReplayRequest < Struct.new(
1999
+ :replay_name)
2000
+ SENSITIVE = []
2001
+ include Aws::Structure
2002
+ end
2003
+
2004
+ # @!attribute [rw] replay_name
2005
+ # The name of the replay.
2006
+ # @return [String]
2007
+ #
2008
+ # @!attribute [rw] replay_arn
2009
+ # The ARN of the replay.
2010
+ # @return [String]
2011
+ #
2012
+ # @!attribute [rw] description
2013
+ # The description of the replay.
2014
+ # @return [String]
2015
+ #
2016
+ # @!attribute [rw] state
2017
+ # The current state of the replay.
2018
+ # @return [String]
2019
+ #
2020
+ # @!attribute [rw] state_reason
2021
+ # The reason that the replay is in the current state.
2022
+ # @return [String]
2023
+ #
2024
+ # @!attribute [rw] event_source_arn
2025
+ # The ARN of the archive events were replayed from.
2026
+ # @return [String]
2027
+ #
2028
+ # @!attribute [rw] destination
2029
+ # A `ReplayDestination` object that contains details about the replay.
2030
+ # @return [Types::ReplayDestination]
2031
+ #
2032
+ # @!attribute [rw] event_start_time
2033
+ # The time stamp of the first event that was last replayed from the
2034
+ # archive.
2035
+ # @return [Time]
2036
+ #
2037
+ # @!attribute [rw] event_end_time
2038
+ # The time stamp for the last event that was replayed from the
2039
+ # archive.
2040
+ # @return [Time]
2041
+ #
2042
+ # @!attribute [rw] event_last_replayed_time
2043
+ # The time that the event was last replayed.
2044
+ # @return [Time]
2045
+ #
2046
+ # @!attribute [rw] replay_start_time
2047
+ # A time stamp for the time that the replay started.
2048
+ # @return [Time]
2049
+ #
2050
+ # @!attribute [rw] replay_end_time
2051
+ # A time stamp for the time that the replay stopped.
2052
+ # @return [Time]
2053
+ #
2054
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeReplayResponse AWS API Documentation
2055
+ #
2056
+ class DescribeReplayResponse < Struct.new(
2057
+ :replay_name,
2058
+ :replay_arn,
2059
+ :description,
2060
+ :state,
2061
+ :state_reason,
2062
+ :event_source_arn,
2063
+ :destination,
2064
+ :event_start_time,
2065
+ :event_end_time,
2066
+ :event_last_replayed_time,
2067
+ :replay_start_time,
2068
+ :replay_end_time)
2069
+ SENSITIVE = []
2070
+ include Aws::Structure
2071
+ end
2072
+
587
2073
  # @note When making an API call, you may pass DescribeRuleRequest
588
2074
  # data as a hash:
589
2075
  #
590
2076
  # {
591
2077
  # name: "RuleName", # required
592
- # event_bus_name: "EventBusName",
2078
+ # event_bus_name: "EventBusNameOrArn",
593
2079
  # }
594
2080
  #
595
2081
  # @!attribute [rw] name
@@ -597,8 +2083,8 @@ module Aws::EventBridge
597
2083
  # @return [String]
598
2084
  #
599
2085
  # @!attribute [rw] event_bus_name
600
- # The event bus associated with the rule. If you omit this, the
601
- # default event bus is used.
2086
+ # The name or ARN of the event bus associated with the rule. If you
2087
+ # omit this, the default event bus is used.
602
2088
  # @return [String]
603
2089
  #
604
2090
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeRuleRequest AWS API Documentation
@@ -652,7 +2138,16 @@ module Aws::EventBridge
652
2138
  # @return [String]
653
2139
  #
654
2140
  # @!attribute [rw] event_bus_name
655
- # The event bus associated with the rule.
2141
+ # The name of the event bus associated with the rule.
2142
+ # @return [String]
2143
+ #
2144
+ # @!attribute [rw] created_by
2145
+ # The account ID of the user that created the rule. If you use
2146
+ # `PutRule` to put a rule on an event bus in another account, the
2147
+ # other account is the owner of the rule, and the rule ARN includes
2148
+ # the account ID for that account. However, the value for `CreatedBy`
2149
+ # is the account ID as the account that created the rule in the other
2150
+ # account.
656
2151
  # @return [String]
657
2152
  #
658
2153
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeRuleResponse AWS API Documentation
@@ -666,7 +2161,8 @@ module Aws::EventBridge
666
2161
  :description,
667
2162
  :role_arn,
668
2163
  :managed_by,
669
- :event_bus_name)
2164
+ :event_bus_name,
2165
+ :created_by)
670
2166
  SENSITIVE = []
671
2167
  include Aws::Structure
672
2168
  end
@@ -676,7 +2172,7 @@ module Aws::EventBridge
676
2172
  #
677
2173
  # {
678
2174
  # name: "RuleName", # required
679
- # event_bus_name: "EventBusName",
2175
+ # event_bus_name: "EventBusNameOrArn",
680
2176
  # }
681
2177
  #
682
2178
  # @!attribute [rw] name
@@ -684,8 +2180,8 @@ module Aws::EventBridge
684
2180
  # @return [String]
685
2181
  #
686
2182
  # @!attribute [rw] event_bus_name
687
- # The event bus associated with the rule. If you omit this, the
688
- # default event bus is used.
2183
+ # The name or ARN of the event bus associated with the rule. If you
2184
+ # omit this, the default event bus is used.
689
2185
  # @return [String]
690
2186
  #
691
2187
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DisableRuleRequest AWS API Documentation
@@ -789,7 +2285,7 @@ module Aws::EventBridge
789
2285
  #
790
2286
  # {
791
2287
  # name: "RuleName", # required
792
- # event_bus_name: "EventBusName",
2288
+ # event_bus_name: "EventBusNameOrArn",
793
2289
  # }
794
2290
  #
795
2291
  # @!attribute [rw] name
@@ -797,8 +2293,8 @@ module Aws::EventBridge
797
2293
  # @return [String]
798
2294
  #
799
2295
  # @!attribute [rw] event_bus_name
800
- # The event bus associated with the rule. If you omit this, the
801
- # default event bus is used.
2296
+ # The name or ARN of the event bus associated with the rule. If you
2297
+ # omit this, the default event bus is used.
802
2298
  # @return [String]
803
2299
  #
804
2300
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EnableRuleRequest AWS API Documentation
@@ -890,7 +2386,9 @@ module Aws::EventBridge
890
2386
  end
891
2387
 
892
2388
  # These are custom parameter to be used when the target is an API
893
- # Gateway REST APIs.
2389
+ # Gateway REST APIs or EventBridge ApiDestinations. In the latter case,
2390
+ # these are merged with any InvocationParameters specified on the
2391
+ # Connection, with any values from the Connection taking precedence.
894
2392
  #
895
2393
  # @note When making an API call, you may pass HttpParameters
896
2394
  # data as a hash:
@@ -907,17 +2405,17 @@ module Aws::EventBridge
907
2405
  #
908
2406
  # @!attribute [rw] path_parameter_values
909
2407
  # The path parameter values to be used to populate API Gateway REST
910
- # API path wildcards ("*").
2408
+ # API or EventBridge ApiDestination path wildcards ("*").
911
2409
  # @return [Array<String>]
912
2410
  #
913
2411
  # @!attribute [rw] header_parameters
914
2412
  # The headers that need to be sent as part of request invoking the API
915
- # Gateway REST API.
2413
+ # Gateway REST API or EventBridge ApiDestination.
916
2414
  # @return [Hash<String,String>]
917
2415
  #
918
2416
  # @!attribute [rw] query_string_parameters
919
2417
  # The query string keys/values that need to be sent as part of request
920
- # invoking the API Gateway REST API.
2418
+ # invoking the API Gateway REST API or EventBridge ApiDestination.
921
2419
  # @return [Hash<String,String>]
922
2420
  #
923
2421
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/HttpParameters AWS API Documentation
@@ -930,6 +2428,13 @@ module Aws::EventBridge
930
2428
  include Aws::Structure
931
2429
  end
932
2430
 
2431
+ # An error occurred because a replay can be canceled only when the state
2432
+ # is Running or Starting.
2433
+ #
2434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/IllegalStatusException AWS API Documentation
2435
+ #
2436
+ class IllegalStatusException < Aws::EmptyStructure; end
2437
+
933
2438
  # Contains the parameters needed for you to provide custom input to a
934
2439
  # target based on one or more pieces of data extracted from the event.
935
2440
  #
@@ -949,7 +2454,7 @@ module Aws::EventBridge
949
2454
  # output you want to be sent to the target.
950
2455
  #
951
2456
  # `InputPathsMap` is an array key-value pairs, where each value is a
952
- # valid JSON path. You can have as many as 10 key-value pairs. You
2457
+ # valid JSON path. You can have as many as 100 key-value pairs. You
953
2458
  # must use JSON dot notation, not bracket notation.
954
2459
  #
955
2460
  # The keys cannot start with "AWS."
@@ -966,7 +2471,7 @@ module Aws::EventBridge
966
2471
  #
967
2472
  # * The placeholder cannot be used as an object key.
968
2473
  #
969
- # * Object values cannot include quote marks.
2474
+ # ^
970
2475
  #
971
2476
  # The following example shows the syntax for using `InputPathsMap` and
972
2477
  # `InputTemplate`.
@@ -980,88 +2485,282 @@ module Aws::EventBridge
980
2485
  #
981
2486
  # `"InputTemplate": "<instance> is in state <status>"`
982
2487
  #
983
- # `\}`
2488
+ # `\}`
2489
+ #
2490
+ # To have the `InputTemplate` include quote marks within a JSON
2491
+ # string, escape each quote marks with a slash, as in the following
2492
+ # example:
2493
+ #
2494
+ # ` "InputTransformer":`
2495
+ #
2496
+ # `\{`
2497
+ #
2498
+ # `"InputPathsMap": \{"instance": "$.detail.instance","status":
2499
+ # "$.detail.status"\},`
2500
+ #
2501
+ # `"InputTemplate": "<instance> is in state "<status>""`
2502
+ #
2503
+ # `\}`
2504
+ #
2505
+ # The `InputTemplate` can also be valid JSON with varibles in quotes
2506
+ # or out, as in the following example:
2507
+ #
2508
+ # ` "InputTransformer":`
2509
+ #
2510
+ # `\{`
2511
+ #
2512
+ # `"InputPathsMap": \{"instance": "$.detail.instance","status":
2513
+ # "$.detail.status"\},`
2514
+ #
2515
+ # `"InputTemplate": '\{"myInstance": <instance>,"myStatus":
2516
+ # "<instance> is in state "<status>""\}'`
2517
+ #
2518
+ # `\}`
2519
+ # @return [String]
2520
+ #
2521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InputTransformer AWS API Documentation
2522
+ #
2523
+ class InputTransformer < Struct.new(
2524
+ :input_paths_map,
2525
+ :input_template)
2526
+ SENSITIVE = []
2527
+ include Aws::Structure
2528
+ end
2529
+
2530
+ # This exception occurs due to unexpected causes.
2531
+ #
2532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InternalException AWS API Documentation
2533
+ #
2534
+ class InternalException < Aws::EmptyStructure; end
2535
+
2536
+ # The event pattern is not valid.
2537
+ #
2538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InvalidEventPatternException AWS API Documentation
2539
+ #
2540
+ class InvalidEventPatternException < Aws::EmptyStructure; end
2541
+
2542
+ # The specified state is not a valid state for an event source.
2543
+ #
2544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InvalidStateException AWS API Documentation
2545
+ #
2546
+ class InvalidStateException < Aws::EmptyStructure; end
2547
+
2548
+ # This object enables you to specify a JSON path to extract from the
2549
+ # event and use as the partition key for the Amazon Kinesis data stream,
2550
+ # so that you can control the shard to which the event goes. If you do
2551
+ # not include this parameter, the default is to use the `eventId` as the
2552
+ # partition key.
2553
+ #
2554
+ # @note When making an API call, you may pass KinesisParameters
2555
+ # data as a hash:
2556
+ #
2557
+ # {
2558
+ # partition_key_path: "TargetPartitionKeyPath", # required
2559
+ # }
2560
+ #
2561
+ # @!attribute [rw] partition_key_path
2562
+ # The JSON path to be extracted from the event and used as the
2563
+ # partition key. For more information, see [Amazon Kinesis Streams Key
2564
+ # Concepts][1] in the *Amazon Kinesis Streams Developer Guide*.
2565
+ #
2566
+ #
2567
+ #
2568
+ # [1]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key
2569
+ # @return [String]
2570
+ #
2571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/KinesisParameters AWS API Documentation
2572
+ #
2573
+ class KinesisParameters < Struct.new(
2574
+ :partition_key_path)
2575
+ SENSITIVE = []
2576
+ include Aws::Structure
2577
+ end
2578
+
2579
+ # The request failed because it attempted to create resource beyond the
2580
+ # allowed service quota.
2581
+ #
2582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/LimitExceededException AWS API Documentation
2583
+ #
2584
+ class LimitExceededException < Aws::EmptyStructure; end
2585
+
2586
+ # @note When making an API call, you may pass ListApiDestinationsRequest
2587
+ # data as a hash:
2588
+ #
2589
+ # {
2590
+ # name_prefix: "ApiDestinationName",
2591
+ # connection_arn: "ConnectionArn",
2592
+ # next_token: "NextToken",
2593
+ # limit: 1,
2594
+ # }
2595
+ #
2596
+ # @!attribute [rw] name_prefix
2597
+ # A name prefix to filter results returned. Only API destinations with
2598
+ # a name that starts with the prefix are returned.
2599
+ # @return [String]
2600
+ #
2601
+ # @!attribute [rw] connection_arn
2602
+ # The ARN of the connection specified for the API destination.
2603
+ # @return [String]
2604
+ #
2605
+ # @!attribute [rw] next_token
2606
+ # The token returned by a previous call to retrieve the next set of
2607
+ # results.
2608
+ # @return [String]
2609
+ #
2610
+ # @!attribute [rw] limit
2611
+ # The maximum number of API destinations to include in the response.
2612
+ # @return [Integer]
2613
+ #
2614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListApiDestinationsRequest AWS API Documentation
2615
+ #
2616
+ class ListApiDestinationsRequest < Struct.new(
2617
+ :name_prefix,
2618
+ :connection_arn,
2619
+ :next_token,
2620
+ :limit)
2621
+ SENSITIVE = []
2622
+ include Aws::Structure
2623
+ end
2624
+
2625
+ # @!attribute [rw] api_destinations
2626
+ # An array of `ApiDestination` objects that include information about
2627
+ # an API destination.
2628
+ # @return [Array<Types::ApiDestination>]
2629
+ #
2630
+ # @!attribute [rw] next_token
2631
+ # A token you can use in a subsequent request to retrieve the next set
2632
+ # of results.
2633
+ # @return [String]
2634
+ #
2635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListApiDestinationsResponse AWS API Documentation
984
2636
  #
985
- # To have the `InputTemplate` include quote marks within a JSON
986
- # string, escape each quote marks with a slash, as in the following
987
- # example:
2637
+ class ListApiDestinationsResponse < Struct.new(
2638
+ :api_destinations,
2639
+ :next_token)
2640
+ SENSITIVE = []
2641
+ include Aws::Structure
2642
+ end
2643
+
2644
+ # @note When making an API call, you may pass ListArchivesRequest
2645
+ # data as a hash:
988
2646
  #
989
- # ` "InputTransformer":`
2647
+ # {
2648
+ # name_prefix: "ArchiveName",
2649
+ # event_source_arn: "Arn",
2650
+ # state: "ENABLED", # accepts ENABLED, DISABLED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED
2651
+ # next_token: "NextToken",
2652
+ # limit: 1,
2653
+ # }
990
2654
  #
991
- # `\{`
2655
+ # @!attribute [rw] name_prefix
2656
+ # A name prefix to filter the archives returned. Only archives with
2657
+ # name that match the prefix are returned.
2658
+ # @return [String]
992
2659
  #
993
- # `"InputPathsMap": \{"instance": "$.detail.instance","status":
994
- # "$.detail.status"\},`
2660
+ # @!attribute [rw] event_source_arn
2661
+ # The ARN of the event source associated with the archive.
2662
+ # @return [String]
995
2663
  #
996
- # `"InputTemplate": "<instance> is in state "<status>""`
2664
+ # @!attribute [rw] state
2665
+ # The state of the archive.
2666
+ # @return [String]
997
2667
  #
998
- # `\}`
2668
+ # @!attribute [rw] next_token
2669
+ # The token returned by a previous call to retrieve the next set of
2670
+ # results.
999
2671
  # @return [String]
1000
2672
  #
1001
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InputTransformer AWS API Documentation
2673
+ # @!attribute [rw] limit
2674
+ # The maximum number of results to return.
2675
+ # @return [Integer]
1002
2676
  #
1003
- class InputTransformer < Struct.new(
1004
- :input_paths_map,
1005
- :input_template)
2677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListArchivesRequest AWS API Documentation
2678
+ #
2679
+ class ListArchivesRequest < Struct.new(
2680
+ :name_prefix,
2681
+ :event_source_arn,
2682
+ :state,
2683
+ :next_token,
2684
+ :limit)
1006
2685
  SENSITIVE = []
1007
2686
  include Aws::Structure
1008
2687
  end
1009
2688
 
1010
- # This exception occurs due to unexpected causes.
1011
- #
1012
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InternalException AWS API Documentation
1013
- #
1014
- class InternalException < Aws::EmptyStructure; end
1015
-
1016
- # The event pattern is not valid.
2689
+ # @!attribute [rw] archives
2690
+ # An array of `Archive` objects that include details about an archive.
2691
+ # @return [Array<Types::Archive>]
1017
2692
  #
1018
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InvalidEventPatternException AWS API Documentation
1019
- #
1020
- class InvalidEventPatternException < Aws::EmptyStructure; end
1021
-
1022
- # The specified state is not a valid state for an event source.
2693
+ # @!attribute [rw] next_token
2694
+ # The token returned by a previous call to retrieve the next set of
2695
+ # results.
2696
+ # @return [String]
1023
2697
  #
1024
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InvalidStateException AWS API Documentation
2698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListArchivesResponse AWS API Documentation
1025
2699
  #
1026
- class InvalidStateException < Aws::EmptyStructure; end
2700
+ class ListArchivesResponse < Struct.new(
2701
+ :archives,
2702
+ :next_token)
2703
+ SENSITIVE = []
2704
+ include Aws::Structure
2705
+ end
1027
2706
 
1028
- # This object enables you to specify a JSON path to extract from the
1029
- # event and use as the partition key for the Amazon Kinesis data stream,
1030
- # so that you can control the shard to which the event goes. If you do
1031
- # not include this parameter, the default is to use the `eventId` as the
1032
- # partition key.
1033
- #
1034
- # @note When making an API call, you may pass KinesisParameters
2707
+ # @note When making an API call, you may pass ListConnectionsRequest
1035
2708
  # data as a hash:
1036
2709
  #
1037
2710
  # {
1038
- # partition_key_path: "TargetPartitionKeyPath", # required
2711
+ # name_prefix: "ConnectionName",
2712
+ # connection_state: "CREATING", # accepts CREATING, UPDATING, DELETING, AUTHORIZED, DEAUTHORIZED, AUTHORIZING, DEAUTHORIZING
2713
+ # next_token: "NextToken",
2714
+ # limit: 1,
1039
2715
  # }
1040
2716
  #
1041
- # @!attribute [rw] partition_key_path
1042
- # The JSON path to be extracted from the event and used as the
1043
- # partition key. For more information, see [Amazon Kinesis Streams Key
1044
- # Concepts][1] in the *Amazon Kinesis Streams Developer Guide*.
1045
- #
2717
+ # @!attribute [rw] name_prefix
2718
+ # A name prefix to filter results returned. Only connections with a
2719
+ # name that starts with the prefix are returned.
2720
+ # @return [String]
1046
2721
  #
2722
+ # @!attribute [rw] connection_state
2723
+ # The state of the connection.
2724
+ # @return [String]
1047
2725
  #
1048
- # [1]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key
2726
+ # @!attribute [rw] next_token
2727
+ # The token returned by a previous call to retrieve the next set of
2728
+ # results.
1049
2729
  # @return [String]
1050
2730
  #
1051
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/KinesisParameters AWS API Documentation
2731
+ # @!attribute [rw] limit
2732
+ # The maximum number of connections to return.
2733
+ # @return [Integer]
1052
2734
  #
1053
- class KinesisParameters < Struct.new(
1054
- :partition_key_path)
2735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListConnectionsRequest AWS API Documentation
2736
+ #
2737
+ class ListConnectionsRequest < Struct.new(
2738
+ :name_prefix,
2739
+ :connection_state,
2740
+ :next_token,
2741
+ :limit)
1055
2742
  SENSITIVE = []
1056
2743
  include Aws::Structure
1057
2744
  end
1058
2745
 
1059
- # You tried to create more rules or add more targets to a rule than is
1060
- # allowed.
2746
+ # @!attribute [rw] connections
2747
+ # An array of connections objects that include details about the
2748
+ # connections.
2749
+ # @return [Array<Types::Connection>]
1061
2750
  #
1062
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/LimitExceededException AWS API Documentation
2751
+ # @!attribute [rw] next_token
2752
+ # A token you can use in a subsequent request to retrieve the next set
2753
+ # of results.
2754
+ # @return [String]
1063
2755
  #
1064
- class LimitExceededException < Aws::EmptyStructure; end
2756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListConnectionsResponse AWS API Documentation
2757
+ #
2758
+ class ListConnectionsResponse < Struct.new(
2759
+ :connections,
2760
+ :next_token)
2761
+ SENSITIVE = []
2762
+ include Aws::Structure
2763
+ end
1065
2764
 
1066
2765
  # @note When making an API call, you may pass ListEventBusesRequest
1067
2766
  # data as a hash:
@@ -1275,12 +2974,76 @@ module Aws::EventBridge
1275
2974
  include Aws::Structure
1276
2975
  end
1277
2976
 
2977
+ # @note When making an API call, you may pass ListReplaysRequest
2978
+ # data as a hash:
2979
+ #
2980
+ # {
2981
+ # name_prefix: "ReplayName",
2982
+ # state: "STARTING", # accepts STARTING, RUNNING, CANCELLING, COMPLETED, CANCELLED, FAILED
2983
+ # event_source_arn: "Arn",
2984
+ # next_token: "NextToken",
2985
+ # limit: 1,
2986
+ # }
2987
+ #
2988
+ # @!attribute [rw] name_prefix
2989
+ # A name prefix to filter the replays returned. Only replays with name
2990
+ # that match the prefix are returned.
2991
+ # @return [String]
2992
+ #
2993
+ # @!attribute [rw] state
2994
+ # The state of the replay.
2995
+ # @return [String]
2996
+ #
2997
+ # @!attribute [rw] event_source_arn
2998
+ # The ARN of the event source associated with the replay.
2999
+ # @return [String]
3000
+ #
3001
+ # @!attribute [rw] next_token
3002
+ # The token returned by a previous call to retrieve the next set of
3003
+ # results.
3004
+ # @return [String]
3005
+ #
3006
+ # @!attribute [rw] limit
3007
+ # The maximum number of replays to retrieve.
3008
+ # @return [Integer]
3009
+ #
3010
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListReplaysRequest AWS API Documentation
3011
+ #
3012
+ class ListReplaysRequest < Struct.new(
3013
+ :name_prefix,
3014
+ :state,
3015
+ :event_source_arn,
3016
+ :next_token,
3017
+ :limit)
3018
+ SENSITIVE = []
3019
+ include Aws::Structure
3020
+ end
3021
+
3022
+ # @!attribute [rw] replays
3023
+ # An array of `Replay` objects that contain information about the
3024
+ # replay.
3025
+ # @return [Array<Types::Replay>]
3026
+ #
3027
+ # @!attribute [rw] next_token
3028
+ # The token returned by a previous call to retrieve the next set of
3029
+ # results.
3030
+ # @return [String]
3031
+ #
3032
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListReplaysResponse AWS API Documentation
3033
+ #
3034
+ class ListReplaysResponse < Struct.new(
3035
+ :replays,
3036
+ :next_token)
3037
+ SENSITIVE = []
3038
+ include Aws::Structure
3039
+ end
3040
+
1278
3041
  # @note When making an API call, you may pass ListRuleNamesByTargetRequest
1279
3042
  # data as a hash:
1280
3043
  #
1281
3044
  # {
1282
3045
  # target_arn: "TargetArn", # required
1283
- # event_bus_name: "EventBusName",
3046
+ # event_bus_name: "EventBusNameOrArn",
1284
3047
  # next_token: "NextToken",
1285
3048
  # limit: 1,
1286
3049
  # }
@@ -1290,8 +3053,8 @@ module Aws::EventBridge
1290
3053
  # @return [String]
1291
3054
  #
1292
3055
  # @!attribute [rw] event_bus_name
1293
- # Limits the results to show only the rules associated with the
1294
- # specified event bus.
3056
+ # The name or ARN of the event bus to list rules for. If you omit
3057
+ # this, the default event bus is used.
1295
3058
  # @return [String]
1296
3059
  #
1297
3060
  # @!attribute [rw] next_token
@@ -1337,7 +3100,7 @@ module Aws::EventBridge
1337
3100
  #
1338
3101
  # {
1339
3102
  # name_prefix: "RuleName",
1340
- # event_bus_name: "EventBusName",
3103
+ # event_bus_name: "EventBusNameOrArn",
1341
3104
  # next_token: "NextToken",
1342
3105
  # limit: 1,
1343
3106
  # }
@@ -1347,8 +3110,8 @@ module Aws::EventBridge
1347
3110
  # @return [String]
1348
3111
  #
1349
3112
  # @!attribute [rw] event_bus_name
1350
- # Limits the results to show only the rules associated with the
1351
- # specified event bus.
3113
+ # The name or ARN of the event bus to list the rules for. If you omit
3114
+ # this, the default event bus is used.
1352
3115
  # @return [String]
1353
3116
  #
1354
3117
  # @!attribute [rw] next_token
@@ -1426,7 +3189,7 @@ module Aws::EventBridge
1426
3189
  #
1427
3190
  # {
1428
3191
  # rule: "RuleName", # required
1429
- # event_bus_name: "EventBusName",
3192
+ # event_bus_name: "EventBusNameOrArn",
1430
3193
  # next_token: "NextToken",
1431
3194
  # limit: 1,
1432
3195
  # }
@@ -1436,8 +3199,8 @@ module Aws::EventBridge
1436
3199
  # @return [String]
1437
3200
  #
1438
3201
  # @!attribute [rw] event_bus_name
1439
- # The event bus associated with the rule. If you omit this, the
1440
- # default event bus is used.
3202
+ # The name or ARN of the event bus associated with the rule. If you
3203
+ # omit this, the default event bus is used.
1441
3204
  # @return [String]
1442
3205
  #
1443
3206
  # @!attribute [rw] next_token
@@ -1599,7 +3362,8 @@ module Aws::EventBridge
1599
3362
  # resources: ["EventResource"],
1600
3363
  # detail_type: "String",
1601
3364
  # detail: "String",
1602
- # event_bus_name: "NonPartnerEventBusName",
3365
+ # event_bus_name: "NonPartnerEventBusNameOrArn",
3366
+ # trace_header: "TraceHeader",
1603
3367
  # },
1604
3368
  # ],
1605
3369
  # }
@@ -1629,7 +3393,8 @@ module Aws::EventBridge
1629
3393
  # resources: ["EventResource"],
1630
3394
  # detail_type: "String",
1631
3395
  # detail: "String",
1632
- # event_bus_name: "NonPartnerEventBusName",
3396
+ # event_bus_name: "NonPartnerEventBusNameOrArn",
3397
+ # trace_header: "TraceHeader",
1633
3398
  # }
1634
3399
  #
1635
3400
  # @!attribute [rw] time
@@ -1662,8 +3427,21 @@ module Aws::EventBridge
1662
3427
  # @return [String]
1663
3428
  #
1664
3429
  # @!attribute [rw] event_bus_name
1665
- # The event bus that will receive the event. Only the rules that are
1666
- # associated with this event bus will be able to match the event.
3430
+ # The name or ARN of the event bus to receive the event. Only the
3431
+ # rules that are associated with this event bus are used to match the
3432
+ # event. If you omit this, the default event bus is used.
3433
+ # @return [String]
3434
+ #
3435
+ # @!attribute [rw] trace_header
3436
+ # An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id)
3437
+ # that contains the trace-id associated with the event.
3438
+ #
3439
+ # To learn more about X-Ray trace headers, see [Tracing header][1] in
3440
+ # the AWS X-Ray Developer Guide.
3441
+ #
3442
+ #
3443
+ #
3444
+ # [1]: https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader
1667
3445
  # @return [String]
1668
3446
  #
1669
3447
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutEventsRequestEntry AWS API Documentation
@@ -1674,7 +3452,8 @@ module Aws::EventBridge
1674
3452
  :resources,
1675
3453
  :detail_type,
1676
3454
  :detail,
1677
- :event_bus_name)
3455
+ :event_bus_name,
3456
+ :trace_header)
1678
3457
  SENSITIVE = []
1679
3458
  include Aws::Structure
1680
3459
  end
@@ -1847,19 +3626,20 @@ module Aws::EventBridge
1847
3626
  #
1848
3627
  # {
1849
3628
  # event_bus_name: "NonPartnerEventBusName",
1850
- # action: "Action", # required
1851
- # principal: "Principal", # required
1852
- # statement_id: "StatementId", # required
3629
+ # action: "Action",
3630
+ # principal: "Principal",
3631
+ # statement_id: "StatementId",
1853
3632
  # condition: {
1854
3633
  # type: "String", # required
1855
3634
  # key: "String", # required
1856
3635
  # value: "String", # required
1857
3636
  # },
3637
+ # policy: "String",
1858
3638
  # }
1859
3639
  #
1860
3640
  # @!attribute [rw] event_bus_name
1861
- # The event bus associated with the rule. If you omit this, the
1862
- # default event bus is used.
3641
+ # The name of the event bus associated with the rule. If you omit
3642
+ # this, the default event bus is used.
1863
3643
  # @return [String]
1864
3644
  #
1865
3645
  # @!attribute [rw] action
@@ -1906,6 +3686,12 @@ module Aws::EventBridge
1906
3686
  # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html
1907
3687
  # @return [Types::Condition]
1908
3688
  #
3689
+ # @!attribute [rw] policy
3690
+ # A JSON string that describes the permission policy statement. You
3691
+ # can include a `Policy` parameter in the request instead of using the
3692
+ # `StatementId`, `Action`, `Principal`, or `Condition` parameters.
3693
+ # @return [String]
3694
+ #
1909
3695
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutPermissionRequest AWS API Documentation
1910
3696
  #
1911
3697
  class PutPermissionRequest < Struct.new(
@@ -1913,7 +3699,8 @@ module Aws::EventBridge
1913
3699
  :action,
1914
3700
  :principal,
1915
3701
  :statement_id,
1916
- :condition)
3702
+ :condition,
3703
+ :policy)
1917
3704
  SENSITIVE = []
1918
3705
  include Aws::Structure
1919
3706
  end
@@ -1934,7 +3721,7 @@ module Aws::EventBridge
1934
3721
  # value: "TagValue", # required
1935
3722
  # },
1936
3723
  # ],
1937
- # event_bus_name: "EventBusName",
3724
+ # event_bus_name: "EventBusNameOrArn",
1938
3725
  # }
1939
3726
  #
1940
3727
  # @!attribute [rw] name
@@ -1973,8 +3760,8 @@ module Aws::EventBridge
1973
3760
  # @return [Array<Types::Tag>]
1974
3761
  #
1975
3762
  # @!attribute [rw] event_bus_name
1976
- # The event bus to associate with this rule. If you omit this, the
1977
- # default event bus is used.
3763
+ # The name or ARN of the event bus to associate with this rule. If you
3764
+ # omit this, the default event bus is used.
1978
3765
  # @return [String]
1979
3766
  #
1980
3767
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutRuleRequest AWS API Documentation
@@ -2009,7 +3796,7 @@ module Aws::EventBridge
2009
3796
  #
2010
3797
  # {
2011
3798
  # rule: "RuleName", # required
2012
- # event_bus_name: "EventBusName",
3799
+ # event_bus_name: "EventBusNameOrArn",
2013
3800
  # targets: [ # required
2014
3801
  # {
2015
3802
  # id: "TargetId", # required
@@ -2094,8 +3881,8 @@ module Aws::EventBridge
2094
3881
  # @return [String]
2095
3882
  #
2096
3883
  # @!attribute [rw] event_bus_name
2097
- # The name of the event bus associated with the rule. If you omit
2098
- # this, the default event bus is used.
3884
+ # The name or ARN of the event bus associated with the rule. If you
3885
+ # omit this, the default event bus is used.
2099
3886
  # @return [String]
2100
3887
  #
2101
3888
  # @!attribute [rw] targets
@@ -2217,7 +4004,8 @@ module Aws::EventBridge
2217
4004
  # data as a hash:
2218
4005
  #
2219
4006
  # {
2220
- # statement_id: "StatementId", # required
4007
+ # statement_id: "StatementId",
4008
+ # remove_all_permissions: false,
2221
4009
  # event_bus_name: "NonPartnerEventBusName",
2222
4010
  # }
2223
4011
  #
@@ -2226,6 +4014,10 @@ module Aws::EventBridge
2226
4014
  # allowed to put events to the default event bus.
2227
4015
  # @return [String]
2228
4016
  #
4017
+ # @!attribute [rw] remove_all_permissions
4018
+ # Specifies whether to remove all permissions.
4019
+ # @return [Boolean]
4020
+ #
2229
4021
  # @!attribute [rw] event_bus_name
2230
4022
  # The name of the event bus to revoke permissions for. If you omit
2231
4023
  # this, the default event bus is used.
@@ -2235,6 +4027,7 @@ module Aws::EventBridge
2235
4027
  #
2236
4028
  class RemovePermissionRequest < Struct.new(
2237
4029
  :statement_id,
4030
+ :remove_all_permissions,
2238
4031
  :event_bus_name)
2239
4032
  SENSITIVE = []
2240
4033
  include Aws::Structure
@@ -2245,7 +4038,7 @@ module Aws::EventBridge
2245
4038
  #
2246
4039
  # {
2247
4040
  # rule: "RuleName", # required
2248
- # event_bus_name: "EventBusName",
4041
+ # event_bus_name: "EventBusNameOrArn",
2249
4042
  # ids: ["TargetId"], # required
2250
4043
  # force: false,
2251
4044
  # }
@@ -2255,7 +4048,8 @@ module Aws::EventBridge
2255
4048
  # @return [String]
2256
4049
  #
2257
4050
  # @!attribute [rw] event_bus_name
2258
- # The name of the event bus associated with the rule.
4051
+ # The name or ARN of the event bus associated with the rule. If you
4052
+ # omit this, the default event bus is used.
2259
4053
  # @return [String]
2260
4054
  #
2261
4055
  # @!attribute [rw] ids
@@ -2324,6 +4118,94 @@ module Aws::EventBridge
2324
4118
  include Aws::Structure
2325
4119
  end
2326
4120
 
4121
+ # A `Replay` object that contains details about a replay.
4122
+ #
4123
+ # @!attribute [rw] replay_name
4124
+ # The name of the replay.
4125
+ # @return [String]
4126
+ #
4127
+ # @!attribute [rw] event_source_arn
4128
+ # The ARN of the archive to replay event from.
4129
+ # @return [String]
4130
+ #
4131
+ # @!attribute [rw] state
4132
+ # The current state of the replay.
4133
+ # @return [String]
4134
+ #
4135
+ # @!attribute [rw] state_reason
4136
+ # A description of why the replay is in the current state.
4137
+ # @return [String]
4138
+ #
4139
+ # @!attribute [rw] event_start_time
4140
+ # A time stamp for the time to start replaying events. This is
4141
+ # determined by the time in the event as described in [Time][1].
4142
+ #
4143
+ #
4144
+ #
4145
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time
4146
+ # @return [Time]
4147
+ #
4148
+ # @!attribute [rw] event_end_time
4149
+ # A time stamp for the time to start replaying events. Any event with
4150
+ # a creation time prior to the `EventEndTime` specified is replayed.
4151
+ # @return [Time]
4152
+ #
4153
+ # @!attribute [rw] event_last_replayed_time
4154
+ # A time stamp for the time that the last event was replayed.
4155
+ # @return [Time]
4156
+ #
4157
+ # @!attribute [rw] replay_start_time
4158
+ # A time stamp for the time that the replay started.
4159
+ # @return [Time]
4160
+ #
4161
+ # @!attribute [rw] replay_end_time
4162
+ # A time stamp for the time that the replay completed.
4163
+ # @return [Time]
4164
+ #
4165
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Replay AWS API Documentation
4166
+ #
4167
+ class Replay < Struct.new(
4168
+ :replay_name,
4169
+ :event_source_arn,
4170
+ :state,
4171
+ :state_reason,
4172
+ :event_start_time,
4173
+ :event_end_time,
4174
+ :event_last_replayed_time,
4175
+ :replay_start_time,
4176
+ :replay_end_time)
4177
+ SENSITIVE = []
4178
+ include Aws::Structure
4179
+ end
4180
+
4181
+ # A `ReplayDestination` object that contains details about a replay.
4182
+ #
4183
+ # @note When making an API call, you may pass ReplayDestination
4184
+ # data as a hash:
4185
+ #
4186
+ # {
4187
+ # arn: "Arn", # required
4188
+ # filter_arns: ["Arn"],
4189
+ # }
4190
+ #
4191
+ # @!attribute [rw] arn
4192
+ # The ARN of the event bus to replay event to. You can replay events
4193
+ # only to the event bus specified to create the archive.
4194
+ # @return [String]
4195
+ #
4196
+ # @!attribute [rw] filter_arns
4197
+ # A list of ARNs for rules to replay events to.
4198
+ # @return [Array<String>]
4199
+ #
4200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ReplayDestination AWS API Documentation
4201
+ #
4202
+ class ReplayDestination < Struct.new(
4203
+ :arn,
4204
+ :filter_arns)
4205
+ SENSITIVE = []
4206
+ include Aws::Structure
4207
+ end
4208
+
2327
4209
  # The resource you are trying to create already exists.
2328
4210
  #
2329
4211
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ResourceAlreadyExistsException AWS API Documentation
@@ -2412,7 +4294,8 @@ module Aws::EventBridge
2412
4294
  # @return [String]
2413
4295
  #
2414
4296
  # @!attribute [rw] event_bus_name
2415
- # The event bus associated with the rule.
4297
+ # The name or ARN of the event bus associated with the rule. If you
4298
+ # omit this, the default event bus is used.
2416
4299
  # @return [String]
2417
4300
  #
2418
4301
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Rule AWS API Documentation
@@ -2504,10 +4387,94 @@ module Aws::EventBridge
2504
4387
  # The FIFO message group ID to use as the target.
2505
4388
  # @return [String]
2506
4389
  #
2507
- # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/SqsParameters AWS API Documentation
4390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/SqsParameters AWS API Documentation
4391
+ #
4392
+ class SqsParameters < Struct.new(
4393
+ :message_group_id)
4394
+ SENSITIVE = []
4395
+ include Aws::Structure
4396
+ end
4397
+
4398
+ # @note When making an API call, you may pass StartReplayRequest
4399
+ # data as a hash:
4400
+ #
4401
+ # {
4402
+ # replay_name: "ReplayName", # required
4403
+ # description: "ReplayDescription",
4404
+ # event_source_arn: "Arn", # required
4405
+ # event_start_time: Time.now, # required
4406
+ # event_end_time: Time.now, # required
4407
+ # destination: { # required
4408
+ # arn: "Arn", # required
4409
+ # filter_arns: ["Arn"],
4410
+ # },
4411
+ # }
4412
+ #
4413
+ # @!attribute [rw] replay_name
4414
+ # The name of the replay to start.
4415
+ # @return [String]
4416
+ #
4417
+ # @!attribute [rw] description
4418
+ # A description for the replay to start.
4419
+ # @return [String]
4420
+ #
4421
+ # @!attribute [rw] event_source_arn
4422
+ # The ARN of the archive to replay events from.
4423
+ # @return [String]
4424
+ #
4425
+ # @!attribute [rw] event_start_time
4426
+ # A time stamp for the time to start replaying events. Only events
4427
+ # that occurred between the `EventStartTime` and `EventEndTime` are
4428
+ # replayed.
4429
+ # @return [Time]
4430
+ #
4431
+ # @!attribute [rw] event_end_time
4432
+ # A time stamp for the time to stop replaying events. Only events that
4433
+ # occurred between the `EventStartTime` and `EventEndTime` are
4434
+ # replayed.
4435
+ # @return [Time]
4436
+ #
4437
+ # @!attribute [rw] destination
4438
+ # A `ReplayDestination` object that includes details about the
4439
+ # destination for the replay.
4440
+ # @return [Types::ReplayDestination]
4441
+ #
4442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/StartReplayRequest AWS API Documentation
4443
+ #
4444
+ class StartReplayRequest < Struct.new(
4445
+ :replay_name,
4446
+ :description,
4447
+ :event_source_arn,
4448
+ :event_start_time,
4449
+ :event_end_time,
4450
+ :destination)
4451
+ SENSITIVE = []
4452
+ include Aws::Structure
4453
+ end
4454
+
4455
+ # @!attribute [rw] replay_arn
4456
+ # The ARN of the replay.
4457
+ # @return [String]
4458
+ #
4459
+ # @!attribute [rw] state
4460
+ # The state of the replay.
4461
+ # @return [String]
4462
+ #
4463
+ # @!attribute [rw] state_reason
4464
+ # The reason that the replay is in the state.
4465
+ # @return [String]
4466
+ #
4467
+ # @!attribute [rw] replay_start_time
4468
+ # The time at which the replay started.
4469
+ # @return [Time]
2508
4470
  #
2509
- class SqsParameters < Struct.new(
2510
- :message_group_id)
4471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/StartReplayResponse AWS API Documentation
4472
+ #
4473
+ class StartReplayResponse < Struct.new(
4474
+ :replay_arn,
4475
+ :state,
4476
+ :state_reason,
4477
+ :replay_start_time)
2511
4478
  SENSITIVE = []
2512
4479
  include Aws::Structure
2513
4480
  end
@@ -2753,11 +4720,15 @@ module Aws::EventBridge
2753
4720
  #
2754
4721
  # @!attribute [rw] http_parameters
2755
4722
  # Contains the HTTP parameters to use when the target is a API Gateway
2756
- # REST endpoint.
2757
- #
2758
- # If you specify an API Gateway REST API as a target, you can use this
2759
- # parameter to specify headers, path parameter, query string
2760
- # keys/values as part of your target invoking request.
4723
+ # REST endpoint or EventBridge ApiDestination.
4724
+ #
4725
+ # If you specify an API Gateway REST API or EventBridge ApiDestination
4726
+ # as a target, you can use this parameter to specify headers, path
4727
+ # parameters, and query string keys/values as part of your target
4728
+ # invoking request. If you're using ApiDestinations, the
4729
+ # corresponding Connection can also have these values configured. In
4730
+ # case of any conflicting keys, values from the Connection take
4731
+ # precedence.
2761
4732
  # @return [Types::HttpParameters]
2762
4733
  #
2763
4734
  # @!attribute [rw] redshift_data_parameters
@@ -2819,7 +4790,27 @@ module Aws::EventBridge
2819
4790
  # @return [String]
2820
4791
  #
2821
4792
  # @!attribute [rw] event
2822
- # The event, in JSON format, to test against the event pattern.
4793
+ # The event, in JSON format, to test against the event pattern. The
4794
+ # JSON must follow the format specified in [AWS Events][1], and the
4795
+ # following fields are mandatory:
4796
+ #
4797
+ # * `id`
4798
+ #
4799
+ # * `account`
4800
+ #
4801
+ # * `source`
4802
+ #
4803
+ # * `time`
4804
+ #
4805
+ # * `region`
4806
+ #
4807
+ # * `resources`
4808
+ #
4809
+ # * `detail-type`
4810
+ #
4811
+ #
4812
+ #
4813
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html
2823
4814
  # @return [String]
2824
4815
  #
2825
4816
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/TestEventPatternRequest AWS API Documentation
@@ -2873,5 +4864,532 @@ module Aws::EventBridge
2873
4864
  #
2874
4865
  class UntagResourceResponse < Aws::EmptyStructure; end
2875
4866
 
4867
+ # @note When making an API call, you may pass UpdateApiDestinationRequest
4868
+ # data as a hash:
4869
+ #
4870
+ # {
4871
+ # name: "ApiDestinationName", # required
4872
+ # description: "ApiDestinationDescription",
4873
+ # connection_arn: "ConnectionArn",
4874
+ # invocation_endpoint: "HttpsEndpoint",
4875
+ # http_method: "POST", # accepts POST, GET, HEAD, OPTIONS, PUT, PATCH, DELETE
4876
+ # invocation_rate_limit_per_second: 1,
4877
+ # }
4878
+ #
4879
+ # @!attribute [rw] name
4880
+ # The name of the API destination to update.
4881
+ # @return [String]
4882
+ #
4883
+ # @!attribute [rw] description
4884
+ # The name of the API destination to update.
4885
+ # @return [String]
4886
+ #
4887
+ # @!attribute [rw] connection_arn
4888
+ # The ARN of the connection to use for the API destination.
4889
+ # @return [String]
4890
+ #
4891
+ # @!attribute [rw] invocation_endpoint
4892
+ # The URL to the endpoint to use for the API destination.
4893
+ # @return [String]
4894
+ #
4895
+ # @!attribute [rw] http_method
4896
+ # The method to use for the API destination.
4897
+ # @return [String]
4898
+ #
4899
+ # @!attribute [rw] invocation_rate_limit_per_second
4900
+ # The maximum number of invocations per second to send to the API
4901
+ # destination.
4902
+ # @return [Integer]
4903
+ #
4904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateApiDestinationRequest AWS API Documentation
4905
+ #
4906
+ class UpdateApiDestinationRequest < Struct.new(
4907
+ :name,
4908
+ :description,
4909
+ :connection_arn,
4910
+ :invocation_endpoint,
4911
+ :http_method,
4912
+ :invocation_rate_limit_per_second)
4913
+ SENSITIVE = []
4914
+ include Aws::Structure
4915
+ end
4916
+
4917
+ # @!attribute [rw] api_destination_arn
4918
+ # The ARN of the API destination that was updated.
4919
+ # @return [String]
4920
+ #
4921
+ # @!attribute [rw] api_destination_state
4922
+ # The state of the API destination that was updated.
4923
+ # @return [String]
4924
+ #
4925
+ # @!attribute [rw] creation_time
4926
+ # A time stamp for the time that the API destination was created.
4927
+ # @return [Time]
4928
+ #
4929
+ # @!attribute [rw] last_modified_time
4930
+ # A time stamp for the time that the API destination was last
4931
+ # modified.
4932
+ # @return [Time]
4933
+ #
4934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateApiDestinationResponse AWS API Documentation
4935
+ #
4936
+ class UpdateApiDestinationResponse < Struct.new(
4937
+ :api_destination_arn,
4938
+ :api_destination_state,
4939
+ :creation_time,
4940
+ :last_modified_time)
4941
+ SENSITIVE = []
4942
+ include Aws::Structure
4943
+ end
4944
+
4945
+ # @note When making an API call, you may pass UpdateArchiveRequest
4946
+ # data as a hash:
4947
+ #
4948
+ # {
4949
+ # archive_name: "ArchiveName", # required
4950
+ # description: "ArchiveDescription",
4951
+ # event_pattern: "EventPattern",
4952
+ # retention_days: 1,
4953
+ # }
4954
+ #
4955
+ # @!attribute [rw] archive_name
4956
+ # The name of the archive to update.
4957
+ # @return [String]
4958
+ #
4959
+ # @!attribute [rw] description
4960
+ # The description for the archive.
4961
+ # @return [String]
4962
+ #
4963
+ # @!attribute [rw] event_pattern
4964
+ # The event pattern to use to filter events sent to the archive.
4965
+ # @return [String]
4966
+ #
4967
+ # @!attribute [rw] retention_days
4968
+ # The number of days to retain events in the archive.
4969
+ # @return [Integer]
4970
+ #
4971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateArchiveRequest AWS API Documentation
4972
+ #
4973
+ class UpdateArchiveRequest < Struct.new(
4974
+ :archive_name,
4975
+ :description,
4976
+ :event_pattern,
4977
+ :retention_days)
4978
+ SENSITIVE = []
4979
+ include Aws::Structure
4980
+ end
4981
+
4982
+ # @!attribute [rw] archive_arn
4983
+ # The ARN of the archive.
4984
+ # @return [String]
4985
+ #
4986
+ # @!attribute [rw] state
4987
+ # The state of the archive.
4988
+ # @return [String]
4989
+ #
4990
+ # @!attribute [rw] state_reason
4991
+ # The reason that the archive is in the current state.
4992
+ # @return [String]
4993
+ #
4994
+ # @!attribute [rw] creation_time
4995
+ # The time at which the archive was updated.
4996
+ # @return [Time]
4997
+ #
4998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateArchiveResponse AWS API Documentation
4999
+ #
5000
+ class UpdateArchiveResponse < Struct.new(
5001
+ :archive_arn,
5002
+ :state,
5003
+ :state_reason,
5004
+ :creation_time)
5005
+ SENSITIVE = []
5006
+ include Aws::Structure
5007
+ end
5008
+
5009
+ # Contains the API key authorization parameters to use to update the
5010
+ # connection.
5011
+ #
5012
+ # @note When making an API call, you may pass UpdateConnectionApiKeyAuthRequestParameters
5013
+ # data as a hash:
5014
+ #
5015
+ # {
5016
+ # api_key_name: "AuthHeaderParameters",
5017
+ # api_key_value: "AuthHeaderParameters",
5018
+ # }
5019
+ #
5020
+ # @!attribute [rw] api_key_name
5021
+ # The name of the API key to use for authorization.
5022
+ # @return [String]
5023
+ #
5024
+ # @!attribute [rw] api_key_value
5025
+ # The value associated with teh API key to use for authorization.
5026
+ # @return [String]
5027
+ #
5028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionApiKeyAuthRequestParameters AWS API Documentation
5029
+ #
5030
+ class UpdateConnectionApiKeyAuthRequestParameters < Struct.new(
5031
+ :api_key_name,
5032
+ :api_key_value)
5033
+ SENSITIVE = []
5034
+ include Aws::Structure
5035
+ end
5036
+
5037
+ # Contains the additional parameters to use for the connection.
5038
+ #
5039
+ # @note When making an API call, you may pass UpdateConnectionAuthRequestParameters
5040
+ # data as a hash:
5041
+ #
5042
+ # {
5043
+ # basic_auth_parameters: {
5044
+ # username: "AuthHeaderParameters",
5045
+ # password: "AuthHeaderParameters",
5046
+ # },
5047
+ # o_auth_parameters: {
5048
+ # client_parameters: {
5049
+ # client_id: "AuthHeaderParameters",
5050
+ # client_secret: "AuthHeaderParameters",
5051
+ # },
5052
+ # authorization_endpoint: "HttpsEndpoint",
5053
+ # http_method: "GET", # accepts GET, POST, PUT
5054
+ # o_auth_http_parameters: {
5055
+ # header_parameters: [
5056
+ # {
5057
+ # key: "HeaderKey",
5058
+ # value: "HeaderValue",
5059
+ # is_value_secret: false,
5060
+ # },
5061
+ # ],
5062
+ # query_string_parameters: [
5063
+ # {
5064
+ # key: "QueryStringKey",
5065
+ # value: "QueryStringValue",
5066
+ # is_value_secret: false,
5067
+ # },
5068
+ # ],
5069
+ # body_parameters: [
5070
+ # {
5071
+ # key: "String",
5072
+ # value: "String",
5073
+ # is_value_secret: false,
5074
+ # },
5075
+ # ],
5076
+ # },
5077
+ # },
5078
+ # api_key_auth_parameters: {
5079
+ # api_key_name: "AuthHeaderParameters",
5080
+ # api_key_value: "AuthHeaderParameters",
5081
+ # },
5082
+ # invocation_http_parameters: {
5083
+ # header_parameters: [
5084
+ # {
5085
+ # key: "HeaderKey",
5086
+ # value: "HeaderValue",
5087
+ # is_value_secret: false,
5088
+ # },
5089
+ # ],
5090
+ # query_string_parameters: [
5091
+ # {
5092
+ # key: "QueryStringKey",
5093
+ # value: "QueryStringValue",
5094
+ # is_value_secret: false,
5095
+ # },
5096
+ # ],
5097
+ # body_parameters: [
5098
+ # {
5099
+ # key: "String",
5100
+ # value: "String",
5101
+ # is_value_secret: false,
5102
+ # },
5103
+ # ],
5104
+ # },
5105
+ # }
5106
+ #
5107
+ # @!attribute [rw] basic_auth_parameters
5108
+ # A `UpdateConnectionBasicAuthRequestParameters` object that contains
5109
+ # the authorization parameters for Basic authorization.
5110
+ # @return [Types::UpdateConnectionBasicAuthRequestParameters]
5111
+ #
5112
+ # @!attribute [rw] o_auth_parameters
5113
+ # A `UpdateConnectionOAuthRequestParameters` object that contains the
5114
+ # authorization parameters for OAuth authorization.
5115
+ # @return [Types::UpdateConnectionOAuthRequestParameters]
5116
+ #
5117
+ # @!attribute [rw] api_key_auth_parameters
5118
+ # A `UpdateConnectionApiKeyAuthRequestParameters` object that contains
5119
+ # the authorization parameters for API key authorization.
5120
+ # @return [Types::UpdateConnectionApiKeyAuthRequestParameters]
5121
+ #
5122
+ # @!attribute [rw] invocation_http_parameters
5123
+ # A `ConnectionHttpParameters` object that contains the additional
5124
+ # parameters to use for the connection.
5125
+ # @return [Types::ConnectionHttpParameters]
5126
+ #
5127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionAuthRequestParameters AWS API Documentation
5128
+ #
5129
+ class UpdateConnectionAuthRequestParameters < Struct.new(
5130
+ :basic_auth_parameters,
5131
+ :o_auth_parameters,
5132
+ :api_key_auth_parameters,
5133
+ :invocation_http_parameters)
5134
+ SENSITIVE = []
5135
+ include Aws::Structure
5136
+ end
5137
+
5138
+ # Contains the Basic authorization parameters for the connection.
5139
+ #
5140
+ # @note When making an API call, you may pass UpdateConnectionBasicAuthRequestParameters
5141
+ # data as a hash:
5142
+ #
5143
+ # {
5144
+ # username: "AuthHeaderParameters",
5145
+ # password: "AuthHeaderParameters",
5146
+ # }
5147
+ #
5148
+ # @!attribute [rw] username
5149
+ # The user name to use for Basic authorization.
5150
+ # @return [String]
5151
+ #
5152
+ # @!attribute [rw] password
5153
+ # The password associated with the user name to use for Basic
5154
+ # authorization.
5155
+ # @return [String]
5156
+ #
5157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionBasicAuthRequestParameters AWS API Documentation
5158
+ #
5159
+ class UpdateConnectionBasicAuthRequestParameters < Struct.new(
5160
+ :username,
5161
+ :password)
5162
+ SENSITIVE = []
5163
+ include Aws::Structure
5164
+ end
5165
+
5166
+ # Contains the OAuth authorization parameters to use for the connection.
5167
+ #
5168
+ # @note When making an API call, you may pass UpdateConnectionOAuthClientRequestParameters
5169
+ # data as a hash:
5170
+ #
5171
+ # {
5172
+ # client_id: "AuthHeaderParameters",
5173
+ # client_secret: "AuthHeaderParameters",
5174
+ # }
5175
+ #
5176
+ # @!attribute [rw] client_id
5177
+ # The client ID to use for OAuth authorization.
5178
+ # @return [String]
5179
+ #
5180
+ # @!attribute [rw] client_secret
5181
+ # The client secret assciated with the client ID to use for OAuth
5182
+ # authorization.
5183
+ # @return [String]
5184
+ #
5185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionOAuthClientRequestParameters AWS API Documentation
5186
+ #
5187
+ class UpdateConnectionOAuthClientRequestParameters < Struct.new(
5188
+ :client_id,
5189
+ :client_secret)
5190
+ SENSITIVE = []
5191
+ include Aws::Structure
5192
+ end
5193
+
5194
+ # Contains the OAuth request parameters to use for the connection.
5195
+ #
5196
+ # @note When making an API call, you may pass UpdateConnectionOAuthRequestParameters
5197
+ # data as a hash:
5198
+ #
5199
+ # {
5200
+ # client_parameters: {
5201
+ # client_id: "AuthHeaderParameters",
5202
+ # client_secret: "AuthHeaderParameters",
5203
+ # },
5204
+ # authorization_endpoint: "HttpsEndpoint",
5205
+ # http_method: "GET", # accepts GET, POST, PUT
5206
+ # o_auth_http_parameters: {
5207
+ # header_parameters: [
5208
+ # {
5209
+ # key: "HeaderKey",
5210
+ # value: "HeaderValue",
5211
+ # is_value_secret: false,
5212
+ # },
5213
+ # ],
5214
+ # query_string_parameters: [
5215
+ # {
5216
+ # key: "QueryStringKey",
5217
+ # value: "QueryStringValue",
5218
+ # is_value_secret: false,
5219
+ # },
5220
+ # ],
5221
+ # body_parameters: [
5222
+ # {
5223
+ # key: "String",
5224
+ # value: "String",
5225
+ # is_value_secret: false,
5226
+ # },
5227
+ # ],
5228
+ # },
5229
+ # }
5230
+ #
5231
+ # @!attribute [rw] client_parameters
5232
+ # A `UpdateConnectionOAuthClientRequestParameters` object that
5233
+ # contains the client parameters to use for the connection when OAuth
5234
+ # is specified as the authorization type.
5235
+ # @return [Types::UpdateConnectionOAuthClientRequestParameters]
5236
+ #
5237
+ # @!attribute [rw] authorization_endpoint
5238
+ # The URL to the authorization endpoint when OAuth is specified as the
5239
+ # authorization type.
5240
+ # @return [String]
5241
+ #
5242
+ # @!attribute [rw] http_method
5243
+ # The method used to connect to the HTTP endpoint.
5244
+ # @return [String]
5245
+ #
5246
+ # @!attribute [rw] o_auth_http_parameters
5247
+ # The additional HTTP parameters used for the OAuth authorization
5248
+ # request.
5249
+ # @return [Types::ConnectionHttpParameters]
5250
+ #
5251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionOAuthRequestParameters AWS API Documentation
5252
+ #
5253
+ class UpdateConnectionOAuthRequestParameters < Struct.new(
5254
+ :client_parameters,
5255
+ :authorization_endpoint,
5256
+ :http_method,
5257
+ :o_auth_http_parameters)
5258
+ SENSITIVE = []
5259
+ include Aws::Structure
5260
+ end
5261
+
5262
+ # @note When making an API call, you may pass UpdateConnectionRequest
5263
+ # data as a hash:
5264
+ #
5265
+ # {
5266
+ # name: "ConnectionName", # required
5267
+ # description: "ConnectionDescription",
5268
+ # authorization_type: "BASIC", # accepts BASIC, OAUTH_CLIENT_CREDENTIALS, API_KEY
5269
+ # auth_parameters: {
5270
+ # basic_auth_parameters: {
5271
+ # username: "AuthHeaderParameters",
5272
+ # password: "AuthHeaderParameters",
5273
+ # },
5274
+ # o_auth_parameters: {
5275
+ # client_parameters: {
5276
+ # client_id: "AuthHeaderParameters",
5277
+ # client_secret: "AuthHeaderParameters",
5278
+ # },
5279
+ # authorization_endpoint: "HttpsEndpoint",
5280
+ # http_method: "GET", # accepts GET, POST, PUT
5281
+ # o_auth_http_parameters: {
5282
+ # header_parameters: [
5283
+ # {
5284
+ # key: "HeaderKey",
5285
+ # value: "HeaderValue",
5286
+ # is_value_secret: false,
5287
+ # },
5288
+ # ],
5289
+ # query_string_parameters: [
5290
+ # {
5291
+ # key: "QueryStringKey",
5292
+ # value: "QueryStringValue",
5293
+ # is_value_secret: false,
5294
+ # },
5295
+ # ],
5296
+ # body_parameters: [
5297
+ # {
5298
+ # key: "String",
5299
+ # value: "String",
5300
+ # is_value_secret: false,
5301
+ # },
5302
+ # ],
5303
+ # },
5304
+ # },
5305
+ # api_key_auth_parameters: {
5306
+ # api_key_name: "AuthHeaderParameters",
5307
+ # api_key_value: "AuthHeaderParameters",
5308
+ # },
5309
+ # invocation_http_parameters: {
5310
+ # header_parameters: [
5311
+ # {
5312
+ # key: "HeaderKey",
5313
+ # value: "HeaderValue",
5314
+ # is_value_secret: false,
5315
+ # },
5316
+ # ],
5317
+ # query_string_parameters: [
5318
+ # {
5319
+ # key: "QueryStringKey",
5320
+ # value: "QueryStringValue",
5321
+ # is_value_secret: false,
5322
+ # },
5323
+ # ],
5324
+ # body_parameters: [
5325
+ # {
5326
+ # key: "String",
5327
+ # value: "String",
5328
+ # is_value_secret: false,
5329
+ # },
5330
+ # ],
5331
+ # },
5332
+ # },
5333
+ # }
5334
+ #
5335
+ # @!attribute [rw] name
5336
+ # The name of the connection to update.
5337
+ # @return [String]
5338
+ #
5339
+ # @!attribute [rw] description
5340
+ # A description for the connection.
5341
+ # @return [String]
5342
+ #
5343
+ # @!attribute [rw] authorization_type
5344
+ # The type of authorization to use for the connection.
5345
+ # @return [String]
5346
+ #
5347
+ # @!attribute [rw] auth_parameters
5348
+ # The authorization parameters to use for the connection.
5349
+ # @return [Types::UpdateConnectionAuthRequestParameters]
5350
+ #
5351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionRequest AWS API Documentation
5352
+ #
5353
+ class UpdateConnectionRequest < Struct.new(
5354
+ :name,
5355
+ :description,
5356
+ :authorization_type,
5357
+ :auth_parameters)
5358
+ SENSITIVE = []
5359
+ include Aws::Structure
5360
+ end
5361
+
5362
+ # @!attribute [rw] connection_arn
5363
+ # The ARN of the connection that was updated.
5364
+ # @return [String]
5365
+ #
5366
+ # @!attribute [rw] connection_state
5367
+ # The state of the connection that was updated.
5368
+ # @return [String]
5369
+ #
5370
+ # @!attribute [rw] creation_time
5371
+ # A time stamp for the time that the connection was created.
5372
+ # @return [Time]
5373
+ #
5374
+ # @!attribute [rw] last_modified_time
5375
+ # A time stamp for the time that the connection was last modified.
5376
+ # @return [Time]
5377
+ #
5378
+ # @!attribute [rw] last_authorized_time
5379
+ # A time stamp for the time that the connection was last authorized.
5380
+ # @return [Time]
5381
+ #
5382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionResponse AWS API Documentation
5383
+ #
5384
+ class UpdateConnectionResponse < Struct.new(
5385
+ :connection_arn,
5386
+ :connection_state,
5387
+ :creation_time,
5388
+ :last_modified_time,
5389
+ :last_authorized_time)
5390
+ SENSITIVE = []
5391
+ include Aws::Structure
5392
+ end
5393
+
2876
5394
  end
2877
5395
  end