aws-sdk-eventbridge 1.20.0 → 1.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +118 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-eventbridge.rb +1 -1
- data/lib/aws-sdk-eventbridge/client.rb +663 -1
- data/lib/aws-sdk-eventbridge/client_api.rb +431 -0
- data/lib/aws-sdk-eventbridge/types.rb +1781 -52
- metadata +6 -3
@@ -29,6 +29,62 @@ 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
|
+
|
32
88
|
# An `Archive` object that contains details about an archive.
|
33
89
|
#
|
34
90
|
# @!attribute [rw] archive_name
|
@@ -315,6 +371,403 @@ module Aws::EventBridge
|
|
315
371
|
include Aws::Structure
|
316
372
|
end
|
317
373
|
|
374
|
+
# Contains information about a connection.
|
375
|
+
#
|
376
|
+
# @!attribute [rw] connection_arn
|
377
|
+
# The ARN of the connection.
|
378
|
+
# @return [String]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] name
|
381
|
+
# The name of the connection.
|
382
|
+
# @return [String]
|
383
|
+
#
|
384
|
+
# @!attribute [rw] connection_state
|
385
|
+
# The state of the connection.
|
386
|
+
# @return [String]
|
387
|
+
#
|
388
|
+
# @!attribute [rw] state_reason
|
389
|
+
# The reason that the connection is in the connection state.
|
390
|
+
# @return [String]
|
391
|
+
#
|
392
|
+
# @!attribute [rw] authorization_type
|
393
|
+
# The authorization type specified for the connection.
|
394
|
+
# @return [String]
|
395
|
+
#
|
396
|
+
# @!attribute [rw] creation_time
|
397
|
+
# A time stamp for the time that the connection was created.
|
398
|
+
# @return [Time]
|
399
|
+
#
|
400
|
+
# @!attribute [rw] last_modified_time
|
401
|
+
# A time stamp for the time that the connection was last modified.
|
402
|
+
# @return [Time]
|
403
|
+
#
|
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,
|
412
|
+
:name,
|
413
|
+
:connection_state,
|
414
|
+
:state_reason,
|
415
|
+
:authorization_type,
|
416
|
+
:creation_time,
|
417
|
+
:last_modified_time,
|
418
|
+
:last_authorized_time)
|
419
|
+
SENSITIVE = []
|
420
|
+
include Aws::Structure
|
421
|
+
end
|
422
|
+
|
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.
|
429
|
+
# @return [String]
|
430
|
+
#
|
431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionApiKeyAuthResponseParameters AWS API Documentation
|
432
|
+
#
|
433
|
+
class ConnectionApiKeyAuthResponseParameters < Struct.new(
|
434
|
+
:api_key_name)
|
435
|
+
SENSITIVE = []
|
436
|
+
include Aws::Structure
|
437
|
+
end
|
438
|
+
|
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
|
489
|
+
# data as a hash:
|
490
|
+
#
|
491
|
+
# {
|
492
|
+
# key: "String",
|
493
|
+
# value: "String",
|
494
|
+
# is_value_secret: false,
|
495
|
+
# }
|
496
|
+
#
|
497
|
+
# @!attribute [rw] key
|
498
|
+
# The key for the parameter.
|
499
|
+
# @return [String]
|
500
|
+
#
|
501
|
+
# @!attribute [rw] value
|
502
|
+
# The value associated with the key.
|
503
|
+
# @return [String]
|
504
|
+
#
|
505
|
+
# @!attribute [rw] is_value_secret
|
506
|
+
# Specified whether the value is secret.
|
507
|
+
# @return [Boolean]
|
508
|
+
#
|
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)
|
515
|
+
SENSITIVE = []
|
516
|
+
include Aws::Structure
|
517
|
+
end
|
518
|
+
|
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.
|
534
|
+
# @return [String]
|
535
|
+
#
|
536
|
+
# @!attribute [rw] value
|
537
|
+
# The value associated with the key.
|
538
|
+
# @return [String]
|
539
|
+
#
|
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)
|
550
|
+
SENSITIVE = []
|
551
|
+
include Aws::Structure
|
552
|
+
end
|
553
|
+
|
554
|
+
# Contains additional parameters for the connection.
|
555
|
+
#
|
556
|
+
# @note When making an API call, you may pass ConnectionHttpParameters
|
557
|
+
# data as a hash:
|
558
|
+
#
|
559
|
+
# {
|
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
|
+
# ],
|
581
|
+
# }
|
582
|
+
#
|
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.
|
611
|
+
# @return [String]
|
612
|
+
#
|
613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionOAuthClientResponseParameters AWS API Documentation
|
614
|
+
#
|
615
|
+
class ConnectionOAuthClientResponseParameters < Struct.new(
|
616
|
+
:client_id)
|
617
|
+
SENSITIVE = []
|
618
|
+
include Aws::Structure
|
619
|
+
end
|
620
|
+
|
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
|
+
|
318
771
|
# @note When making an API call, you may pass CreateArchiveRequest
|
319
772
|
# data as a hash:
|
320
773
|
#
|
@@ -326,62 +779,444 @@ module Aws::EventBridge
|
|
326
779
|
# retention_days: 1,
|
327
780
|
# }
|
328
781
|
#
|
329
|
-
# @!attribute [rw] archive_name
|
330
|
-
# The name for the archive to create.
|
331
|
-
# @return [String]
|
332
|
-
#
|
333
|
-
# @!attribute [rw] event_source_arn
|
334
|
-
# The ARN of the event source associated with the archive.
|
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.
|
335
1171
|
# @return [String]
|
336
1172
|
#
|
337
1173
|
# @!attribute [rw] description
|
338
|
-
# A description for the
|
1174
|
+
# A description for the connection to create.
|
339
1175
|
# @return [String]
|
340
1176
|
#
|
341
|
-
# @!attribute [rw]
|
342
|
-
#
|
1177
|
+
# @!attribute [rw] authorization_type
|
1178
|
+
# The type of authorization to use for the connection.
|
343
1179
|
# @return [String]
|
344
1180
|
#
|
345
|
-
# @!attribute [rw]
|
346
|
-
#
|
347
|
-
# to
|
348
|
-
# @return [
|
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]
|
349
1185
|
#
|
350
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/
|
1186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionRequest AWS API Documentation
|
351
1187
|
#
|
352
|
-
class
|
353
|
-
:
|
354
|
-
:event_source_arn,
|
1188
|
+
class CreateConnectionRequest < Struct.new(
|
1189
|
+
:name,
|
355
1190
|
:description,
|
356
|
-
:
|
357
|
-
:
|
1191
|
+
:authorization_type,
|
1192
|
+
:auth_parameters)
|
358
1193
|
SENSITIVE = []
|
359
1194
|
include Aws::Structure
|
360
1195
|
end
|
361
1196
|
|
362
|
-
# @!attribute [rw]
|
363
|
-
# The ARN of the
|
1197
|
+
# @!attribute [rw] connection_arn
|
1198
|
+
# The ARN of the connection that was created by the request.
|
364
1199
|
# @return [String]
|
365
1200
|
#
|
366
|
-
# @!attribute [rw]
|
367
|
-
# The state of the
|
368
|
-
# @return [String]
|
369
|
-
#
|
370
|
-
# @!attribute [rw] state_reason
|
371
|
-
# The reason that the archive is in the state.
|
1201
|
+
# @!attribute [rw] connection_state
|
1202
|
+
# The state of the connection that was created by the request.
|
372
1203
|
# @return [String]
|
373
1204
|
#
|
374
1205
|
# @!attribute [rw] creation_time
|
375
|
-
#
|
1206
|
+
# A time stamp for the time that the connection was created.
|
376
1207
|
# @return [Time]
|
377
1208
|
#
|
378
|
-
#
|
1209
|
+
# @!attribute [rw] last_modified_time
|
1210
|
+
# A time stamp for the time that the connection was last updated.
|
1211
|
+
# @return [Time]
|
379
1212
|
#
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
:
|
384
|
-
:
|
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)
|
385
1220
|
SENSITIVE = []
|
386
1221
|
include Aws::Structure
|
387
1222
|
end
|
@@ -526,6 +1361,80 @@ module Aws::EventBridge
|
|
526
1361
|
include Aws::Structure
|
527
1362
|
end
|
528
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
|
+
|
529
1438
|
# @note When making an API call, you may pass DeleteArchiveRequest
|
530
1439
|
# data as a hash:
|
531
1440
|
#
|
@@ -549,6 +1458,59 @@ module Aws::EventBridge
|
|
549
1458
|
#
|
550
1459
|
class DeleteArchiveResponse < Aws::EmptyStructure; end
|
551
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
|
+
|
552
1514
|
# @note When making an API call, you may pass DeleteEventBusRequest
|
553
1515
|
# data as a hash:
|
554
1516
|
#
|
@@ -630,6 +1592,91 @@ module Aws::EventBridge
|
|
630
1592
|
include Aws::Structure
|
631
1593
|
end
|
632
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
|
+
|
633
1680
|
# @note When making an API call, you may pass DescribeArchiveRequest
|
634
1681
|
# data as a hash:
|
635
1682
|
#
|
@@ -711,6 +1758,88 @@ module Aws::EventBridge
|
|
711
1758
|
include Aws::Structure
|
712
1759
|
end
|
713
1760
|
|
1761
|
+
# @note When making an API call, you may pass DescribeConnectionRequest
|
1762
|
+
# data as a hash:
|
1763
|
+
#
|
1764
|
+
# {
|
1765
|
+
# name: "ConnectionName", # required
|
1766
|
+
# }
|
1767
|
+
#
|
1768
|
+
# @!attribute [rw] name
|
1769
|
+
# The name of the connection to retrieve.
|
1770
|
+
# @return [String]
|
1771
|
+
#
|
1772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeConnectionRequest AWS API Documentation
|
1773
|
+
#
|
1774
|
+
class DescribeConnectionRequest < Struct.new(
|
1775
|
+
:name)
|
1776
|
+
SENSITIVE = []
|
1777
|
+
include Aws::Structure
|
1778
|
+
end
|
1779
|
+
|
1780
|
+
# @!attribute [rw] connection_arn
|
1781
|
+
# The ARN of the connection retrieved.
|
1782
|
+
# @return [String]
|
1783
|
+
#
|
1784
|
+
# @!attribute [rw] name
|
1785
|
+
# The name of the connection retrieved.
|
1786
|
+
# @return [String]
|
1787
|
+
#
|
1788
|
+
# @!attribute [rw] description
|
1789
|
+
# The description for the connection retrieved.
|
1790
|
+
# @return [String]
|
1791
|
+
#
|
1792
|
+
# @!attribute [rw] connection_state
|
1793
|
+
# The state of the connection retrieved.
|
1794
|
+
# @return [String]
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] state_reason
|
1797
|
+
# The reason that the connection is in the current connection state.
|
1798
|
+
# @return [String]
|
1799
|
+
#
|
1800
|
+
# @!attribute [rw] authorization_type
|
1801
|
+
# The type of authorization specified for the connection.
|
1802
|
+
# @return [String]
|
1803
|
+
#
|
1804
|
+
# @!attribute [rw] secret_arn
|
1805
|
+
# The ARN of the secret created from the authorization parameters
|
1806
|
+
# specified for the connection.
|
1807
|
+
# @return [String]
|
1808
|
+
#
|
1809
|
+
# @!attribute [rw] auth_parameters
|
1810
|
+
# The parameters to use for authorization for the connection.
|
1811
|
+
# @return [Types::ConnectionAuthResponseParameters]
|
1812
|
+
#
|
1813
|
+
# @!attribute [rw] creation_time
|
1814
|
+
# A time stamp for the time that the connection was created.
|
1815
|
+
# @return [Time]
|
1816
|
+
#
|
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,
|
1829
|
+
:name,
|
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)
|
1839
|
+
SENSITIVE = []
|
1840
|
+
include Aws::Structure
|
1841
|
+
end
|
1842
|
+
|
714
1843
|
# @note When making an API call, you may pass DescribeEventBusRequest
|
715
1844
|
# data as a hash:
|
716
1845
|
#
|
@@ -1257,7 +2386,9 @@ module Aws::EventBridge
|
|
1257
2386
|
end
|
1258
2387
|
|
1259
2388
|
# These are custom parameter to be used when the target is an API
|
1260
|
-
# 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.
|
1261
2392
|
#
|
1262
2393
|
# @note When making an API call, you may pass HttpParameters
|
1263
2394
|
# data as a hash:
|
@@ -1274,17 +2405,17 @@ module Aws::EventBridge
|
|
1274
2405
|
#
|
1275
2406
|
# @!attribute [rw] path_parameter_values
|
1276
2407
|
# The path parameter values to be used to populate API Gateway REST
|
1277
|
-
# API path wildcards ("*").
|
2408
|
+
# API or EventBridge ApiDestination path wildcards ("*").
|
1278
2409
|
# @return [Array<String>]
|
1279
2410
|
#
|
1280
2411
|
# @!attribute [rw] header_parameters
|
1281
2412
|
# The headers that need to be sent as part of request invoking the API
|
1282
|
-
# Gateway REST API.
|
2413
|
+
# Gateway REST API or EventBridge ApiDestination.
|
1283
2414
|
# @return [Hash<String,String>]
|
1284
2415
|
#
|
1285
2416
|
# @!attribute [rw] query_string_parameters
|
1286
2417
|
# The query string keys/values that need to be sent as part of request
|
1287
|
-
# invoking the API Gateway REST API.
|
2418
|
+
# invoking the API Gateway REST API or EventBridge ApiDestination.
|
1288
2419
|
# @return [Hash<String,String>]
|
1289
2420
|
#
|
1290
2421
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/HttpParameters AWS API Documentation
|
@@ -1323,7 +2454,7 @@ module Aws::EventBridge
|
|
1323
2454
|
# output you want to be sent to the target.
|
1324
2455
|
#
|
1325
2456
|
# `InputPathsMap` is an array key-value pairs, where each value is a
|
1326
|
-
# valid JSON path. You can have as many as
|
2457
|
+
# valid JSON path. You can have as many as 100 key-value pairs. You
|
1327
2458
|
# must use JSON dot notation, not bracket notation.
|
1328
2459
|
#
|
1329
2460
|
# The keys cannot start with "AWS."
|
@@ -1340,7 +2471,7 @@ module Aws::EventBridge
|
|
1340
2471
|
#
|
1341
2472
|
# * The placeholder cannot be used as an object key.
|
1342
2473
|
#
|
1343
|
-
#
|
2474
|
+
# ^
|
1344
2475
|
#
|
1345
2476
|
# The following example shows the syntax for using `InputPathsMap` and
|
1346
2477
|
# `InputTemplate`.
|
@@ -1370,6 +2501,21 @@ module Aws::EventBridge
|
|
1370
2501
|
# `"InputTemplate": "<instance> is in state "<status>""`
|
1371
2502
|
#
|
1372
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
|
+
# `\}`
|
1373
2519
|
# @return [String]
|
1374
2520
|
#
|
1375
2521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InputTransformer AWS API Documentation
|
@@ -1422,20 +2568,78 @@ module Aws::EventBridge
|
|
1422
2568
|
# [1]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key
|
1423
2569
|
# @return [String]
|
1424
2570
|
#
|
1425
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/KinesisParameters AWS API Documentation
|
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
|
1426
2615
|
#
|
1427
|
-
class
|
1428
|
-
:
|
2616
|
+
class ListApiDestinationsRequest < Struct.new(
|
2617
|
+
:name_prefix,
|
2618
|
+
:connection_arn,
|
2619
|
+
:next_token,
|
2620
|
+
:limit)
|
1429
2621
|
SENSITIVE = []
|
1430
2622
|
include Aws::Structure
|
1431
2623
|
end
|
1432
2624
|
|
1433
|
-
#
|
1434
|
-
#
|
2625
|
+
# @!attribute [rw] api_destinations
|
2626
|
+
# An array of `ApiDestination` objects that include information about
|
2627
|
+
# an API destination.
|
2628
|
+
# @return [Array<Types::ApiDestination>]
|
1435
2629
|
#
|
1436
|
-
#
|
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]
|
1437
2634
|
#
|
1438
|
-
|
2635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListApiDestinationsResponse AWS API Documentation
|
2636
|
+
#
|
2637
|
+
class ListApiDestinationsResponse < Struct.new(
|
2638
|
+
:api_destinations,
|
2639
|
+
:next_token)
|
2640
|
+
SENSITIVE = []
|
2641
|
+
include Aws::Structure
|
2642
|
+
end
|
1439
2643
|
|
1440
2644
|
# @note When making an API call, you may pass ListArchivesRequest
|
1441
2645
|
# data as a hash:
|
@@ -1500,6 +2704,64 @@ module Aws::EventBridge
|
|
1500
2704
|
include Aws::Structure
|
1501
2705
|
end
|
1502
2706
|
|
2707
|
+
# @note When making an API call, you may pass ListConnectionsRequest
|
2708
|
+
# data as a hash:
|
2709
|
+
#
|
2710
|
+
# {
|
2711
|
+
# name_prefix: "ConnectionName",
|
2712
|
+
# connection_state: "CREATING", # accepts CREATING, UPDATING, DELETING, AUTHORIZED, DEAUTHORIZED, AUTHORIZING, DEAUTHORIZING
|
2713
|
+
# next_token: "NextToken",
|
2714
|
+
# limit: 1,
|
2715
|
+
# }
|
2716
|
+
#
|
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]
|
2721
|
+
#
|
2722
|
+
# @!attribute [rw] connection_state
|
2723
|
+
# The state of the connection.
|
2724
|
+
# @return [String]
|
2725
|
+
#
|
2726
|
+
# @!attribute [rw] next_token
|
2727
|
+
# The token returned by a previous call to retrieve the next set of
|
2728
|
+
# results.
|
2729
|
+
# @return [String]
|
2730
|
+
#
|
2731
|
+
# @!attribute [rw] limit
|
2732
|
+
# The maximum number of connections to return.
|
2733
|
+
# @return [Integer]
|
2734
|
+
#
|
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)
|
2742
|
+
SENSITIVE = []
|
2743
|
+
include Aws::Structure
|
2744
|
+
end
|
2745
|
+
|
2746
|
+
# @!attribute [rw] connections
|
2747
|
+
# An array of connections objects that include details about the
|
2748
|
+
# connections.
|
2749
|
+
# @return [Array<Types::Connection>]
|
2750
|
+
#
|
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]
|
2755
|
+
#
|
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
|
2764
|
+
|
1503
2765
|
# @note When making an API call, you may pass ListEventBusesRequest
|
1504
2766
|
# data as a hash:
|
1505
2767
|
#
|
@@ -3458,11 +4720,15 @@ module Aws::EventBridge
|
|
3458
4720
|
#
|
3459
4721
|
# @!attribute [rw] http_parameters
|
3460
4722
|
# Contains the HTTP parameters to use when the target is a API Gateway
|
3461
|
-
# REST endpoint.
|
3462
|
-
#
|
3463
|
-
# If you specify an API Gateway REST API
|
3464
|
-
# parameter to specify headers, path
|
3465
|
-
# keys/values as part of your target
|
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.
|
3466
4732
|
# @return [Types::HttpParameters]
|
3467
4733
|
#
|
3468
4734
|
# @!attribute [rw] redshift_data_parameters
|
@@ -3598,6 +4864,84 @@ module Aws::EventBridge
|
|
3598
4864
|
#
|
3599
4865
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
3600
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
|
+
|
3601
4945
|
# @note When making an API call, you may pass UpdateArchiveRequest
|
3602
4946
|
# data as a hash:
|
3603
4947
|
#
|
@@ -3662,5 +5006,390 @@ module Aws::EventBridge
|
|
3662
5006
|
include Aws::Structure
|
3663
5007
|
end
|
3664
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
|
+
|
3665
5394
|
end
|
3666
5395
|
end
|