aws-sdk-eventbridge 1.20.0 → 1.25.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +138 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-eventbridge.rb +2 -2
- data/lib/aws-sdk-eventbridge/client.rb +775 -35
- data/lib/aws-sdk-eventbridge/client_api.rb +489 -1
- data/lib/aws-sdk-eventbridge/errors.rb +1 -1
- data/lib/aws-sdk-eventbridge/resource.rb +1 -1
- data/lib/aws-sdk-eventbridge/types.rb +2295 -197
- metadata +9 -7
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -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
|
@@ -264,6 +320,50 @@ module Aws::EventBridge
|
|
264
320
|
include Aws::Structure
|
265
321
|
end
|
266
322
|
|
323
|
+
# The details of a capacity provider strategy. To learn more, see
|
324
|
+
# [CapacityProviderStrategyItem][1] in the Amazon ECS API Reference.
|
325
|
+
#
|
326
|
+
#
|
327
|
+
#
|
328
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html
|
329
|
+
#
|
330
|
+
# @note When making an API call, you may pass CapacityProviderStrategyItem
|
331
|
+
# data as a hash:
|
332
|
+
#
|
333
|
+
# {
|
334
|
+
# capacity_provider: "CapacityProvider", # required
|
335
|
+
# weight: 1,
|
336
|
+
# base: 1,
|
337
|
+
# }
|
338
|
+
#
|
339
|
+
# @!attribute [rw] capacity_provider
|
340
|
+
# The short name of the capacity provider.
|
341
|
+
# @return [String]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] weight
|
344
|
+
# The weight value designates the relative percentage of the total
|
345
|
+
# number of tasks launched that should use the specified capacity
|
346
|
+
# provider. The weight value is taken into consideration after the
|
347
|
+
# base value, if defined, is satisfied.
|
348
|
+
# @return [Integer]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] base
|
351
|
+
# The base value designates how many tasks, at a minimum, to run on
|
352
|
+
# the specified capacity provider. Only one capacity provider in a
|
353
|
+
# capacity provider strategy can have a base defined. If no value is
|
354
|
+
# specified, the default value of 0 is used.
|
355
|
+
# @return [Integer]
|
356
|
+
#
|
357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CapacityProviderStrategyItem AWS API Documentation
|
358
|
+
#
|
359
|
+
class CapacityProviderStrategyItem < Struct.new(
|
360
|
+
:capacity_provider,
|
361
|
+
:weight,
|
362
|
+
:base)
|
363
|
+
SENSITIVE = []
|
364
|
+
include Aws::Structure
|
365
|
+
end
|
366
|
+
|
267
367
|
# There is concurrent modification on a rule, target, archive, or
|
268
368
|
# replay.
|
269
369
|
#
|
@@ -315,274 +415,1180 @@ module Aws::EventBridge
|
|
315
415
|
include Aws::Structure
|
316
416
|
end
|
317
417
|
|
318
|
-
#
|
319
|
-
# data as a hash:
|
418
|
+
# Contains information about a connection.
|
320
419
|
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
# description: "ArchiveDescription",
|
325
|
-
# event_pattern: "EventPattern",
|
326
|
-
# retention_days: 1,
|
327
|
-
# }
|
420
|
+
# @!attribute [rw] connection_arn
|
421
|
+
# The ARN of the connection.
|
422
|
+
# @return [String]
|
328
423
|
#
|
329
|
-
# @!attribute [rw]
|
330
|
-
# The name
|
424
|
+
# @!attribute [rw] name
|
425
|
+
# The name of the connection.
|
331
426
|
# @return [String]
|
332
427
|
#
|
333
|
-
# @!attribute [rw]
|
334
|
-
# The
|
428
|
+
# @!attribute [rw] connection_state
|
429
|
+
# The state of the connection.
|
335
430
|
# @return [String]
|
336
431
|
#
|
337
|
-
# @!attribute [rw]
|
338
|
-
#
|
432
|
+
# @!attribute [rw] state_reason
|
433
|
+
# The reason that the connection is in the connection state.
|
339
434
|
# @return [String]
|
340
435
|
#
|
341
|
-
# @!attribute [rw]
|
342
|
-
#
|
436
|
+
# @!attribute [rw] authorization_type
|
437
|
+
# The authorization type specified for the connection.
|
343
438
|
# @return [String]
|
344
439
|
#
|
345
|
-
# @!attribute [rw]
|
346
|
-
#
|
347
|
-
#
|
348
|
-
# @return [Integer]
|
440
|
+
# @!attribute [rw] creation_time
|
441
|
+
# A time stamp for the time that the connection was created.
|
442
|
+
# @return [Time]
|
349
443
|
#
|
350
|
-
#
|
444
|
+
# @!attribute [rw] last_modified_time
|
445
|
+
# A time stamp for the time that the connection was last modified.
|
446
|
+
# @return [Time]
|
351
447
|
#
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
448
|
+
# @!attribute [rw] last_authorized_time
|
449
|
+
# A time stamp for the time that the connection was last authorized.
|
450
|
+
# @return [Time]
|
451
|
+
#
|
452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Connection AWS API Documentation
|
453
|
+
#
|
454
|
+
class Connection < Struct.new(
|
455
|
+
:connection_arn,
|
456
|
+
:name,
|
457
|
+
:connection_state,
|
458
|
+
:state_reason,
|
459
|
+
:authorization_type,
|
460
|
+
:creation_time,
|
461
|
+
:last_modified_time,
|
462
|
+
:last_authorized_time)
|
358
463
|
SENSITIVE = []
|
359
464
|
include Aws::Structure
|
360
465
|
end
|
361
466
|
|
362
|
-
#
|
363
|
-
#
|
364
|
-
# @return [String]
|
365
|
-
#
|
366
|
-
# @!attribute [rw] state
|
367
|
-
# The state of the archive that was created.
|
368
|
-
# @return [String]
|
467
|
+
# Contains the authorization parameters for the connection if API Key is
|
468
|
+
# specified as the authorization type.
|
369
469
|
#
|
370
|
-
# @!attribute [rw]
|
371
|
-
# The
|
470
|
+
# @!attribute [rw] api_key_name
|
471
|
+
# The name of the header to use for the `APIKeyValue` used for
|
472
|
+
# authorization.
|
372
473
|
# @return [String]
|
373
474
|
#
|
374
|
-
#
|
375
|
-
# The time at which the archive was created.
|
376
|
-
# @return [Time]
|
377
|
-
#
|
378
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateArchiveResponse AWS API Documentation
|
475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionApiKeyAuthResponseParameters AWS API Documentation
|
379
476
|
#
|
380
|
-
class
|
381
|
-
:
|
382
|
-
:state,
|
383
|
-
:state_reason,
|
384
|
-
:creation_time)
|
477
|
+
class ConnectionApiKeyAuthResponseParameters < Struct.new(
|
478
|
+
:api_key_name)
|
385
479
|
SENSITIVE = []
|
386
480
|
include Aws::Structure
|
387
481
|
end
|
388
482
|
|
389
|
-
#
|
390
|
-
# data as a hash:
|
391
|
-
#
|
392
|
-
# {
|
393
|
-
# name: "EventBusName", # required
|
394
|
-
# event_source_name: "EventSourceName",
|
395
|
-
# tags: [
|
396
|
-
# {
|
397
|
-
# key: "TagKey", # required
|
398
|
-
# value: "TagValue", # required
|
399
|
-
# },
|
400
|
-
# ],
|
401
|
-
# }
|
483
|
+
# Contains the authorization parameters to use for the connection.
|
402
484
|
#
|
403
|
-
# @!attribute [rw]
|
404
|
-
# The
|
405
|
-
#
|
406
|
-
# Event bus names cannot contain the / character. You can't use the
|
407
|
-
# name `default` for a custom event bus, as this name is already used
|
408
|
-
# for your account's default event bus.
|
485
|
+
# @!attribute [rw] basic_auth_parameters
|
486
|
+
# The authorization parameters for Basic authorization.
|
487
|
+
# @return [Types::ConnectionBasicAuthResponseParameters]
|
409
488
|
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
# @return [
|
489
|
+
# @!attribute [rw] o_auth_parameters
|
490
|
+
# The OAuth parameters to use for authorization.
|
491
|
+
# @return [Types::ConnectionOAuthResponseParameters]
|
413
492
|
#
|
414
|
-
# @!attribute [rw]
|
415
|
-
#
|
416
|
-
#
|
417
|
-
# @return [String]
|
493
|
+
# @!attribute [rw] api_key_auth_parameters
|
494
|
+
# The API Key parameters to use for authorization.
|
495
|
+
# @return [Types::ConnectionApiKeyAuthResponseParameters]
|
418
496
|
#
|
419
|
-
# @!attribute [rw]
|
420
|
-
#
|
421
|
-
#
|
497
|
+
# @!attribute [rw] invocation_http_parameters
|
498
|
+
# Additional parameters for the connection that are passed through
|
499
|
+
# with every invocation to the HTTP endpoint.
|
500
|
+
# @return [Types::ConnectionHttpParameters]
|
422
501
|
#
|
423
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/
|
502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionAuthResponseParameters AWS API Documentation
|
424
503
|
#
|
425
|
-
class
|
426
|
-
:
|
427
|
-
:
|
428
|
-
:
|
504
|
+
class ConnectionAuthResponseParameters < Struct.new(
|
505
|
+
:basic_auth_parameters,
|
506
|
+
:o_auth_parameters,
|
507
|
+
:api_key_auth_parameters,
|
508
|
+
:invocation_http_parameters)
|
429
509
|
SENSITIVE = []
|
430
510
|
include Aws::Structure
|
431
511
|
end
|
432
512
|
|
433
|
-
#
|
434
|
-
#
|
513
|
+
# Contains the authorization parameters for the connection if Basic is
|
514
|
+
# specified as the authorization type.
|
515
|
+
#
|
516
|
+
# @!attribute [rw] username
|
517
|
+
# The user name to use for Basic authorization.
|
435
518
|
# @return [String]
|
436
519
|
#
|
437
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/
|
520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionBasicAuthResponseParameters AWS API Documentation
|
438
521
|
#
|
439
|
-
class
|
440
|
-
:
|
522
|
+
class ConnectionBasicAuthResponseParameters < Struct.new(
|
523
|
+
:username)
|
441
524
|
SENSITIVE = []
|
442
525
|
include Aws::Structure
|
443
526
|
end
|
444
527
|
|
445
|
-
#
|
528
|
+
# Additional parameter included in the body. You can include up to 100
|
529
|
+
# additional body parameters per request. An event payload cannot exceed
|
530
|
+
# 64 KB.
|
531
|
+
#
|
532
|
+
# @note When making an API call, you may pass ConnectionBodyParameter
|
446
533
|
# data as a hash:
|
447
534
|
#
|
448
535
|
# {
|
449
|
-
#
|
450
|
-
#
|
536
|
+
# key: "String",
|
537
|
+
# value: "String",
|
538
|
+
# is_value_secret: false,
|
451
539
|
# }
|
452
540
|
#
|
453
|
-
# @!attribute [rw]
|
454
|
-
# The
|
455
|
-
# must be in the format ` partner_name/event_namespace/event_name `.
|
456
|
-
# The AWS account that wants to use this partner event source must
|
457
|
-
# create a partner event bus with a name that matches the name of the
|
458
|
-
# partner event source.
|
541
|
+
# @!attribute [rw] key
|
542
|
+
# The key for the parameter.
|
459
543
|
# @return [String]
|
460
544
|
#
|
461
|
-
# @!attribute [rw]
|
462
|
-
# The
|
463
|
-
# event bus for this partner event source.
|
545
|
+
# @!attribute [rw] value
|
546
|
+
# The value associated with the key.
|
464
547
|
# @return [String]
|
465
548
|
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
|
469
|
-
:name,
|
470
|
-
:account)
|
471
|
-
SENSITIVE = []
|
472
|
-
include Aws::Structure
|
473
|
-
end
|
474
|
-
|
475
|
-
# @!attribute [rw] event_source_arn
|
476
|
-
# The ARN of the partner event source.
|
477
|
-
# @return [String]
|
549
|
+
# @!attribute [rw] is_value_secret
|
550
|
+
# Specified whether the value is secret.
|
551
|
+
# @return [Boolean]
|
478
552
|
#
|
479
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/
|
553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionBodyParameter AWS API Documentation
|
480
554
|
#
|
481
|
-
class
|
482
|
-
:
|
555
|
+
class ConnectionBodyParameter < Struct.new(
|
556
|
+
:key,
|
557
|
+
:value,
|
558
|
+
:is_value_secret)
|
483
559
|
SENSITIVE = []
|
484
560
|
include Aws::Structure
|
485
561
|
end
|
486
562
|
|
487
|
-
#
|
563
|
+
# Additional parameter included in the header. You can include up to 100
|
564
|
+
# additional header parameters per request. An event payload cannot
|
565
|
+
# exceed 64 KB.
|
566
|
+
#
|
567
|
+
# @note When making an API call, you may pass ConnectionHeaderParameter
|
488
568
|
# data as a hash:
|
489
569
|
#
|
490
570
|
# {
|
491
|
-
#
|
571
|
+
# key: "HeaderKey",
|
572
|
+
# value: "HeaderValue",
|
573
|
+
# is_value_secret: false,
|
492
574
|
# }
|
493
575
|
#
|
494
|
-
# @!attribute [rw]
|
495
|
-
# The
|
576
|
+
# @!attribute [rw] key
|
577
|
+
# The key for the parameter.
|
496
578
|
# @return [String]
|
497
579
|
#
|
498
|
-
#
|
580
|
+
# @!attribute [rw] value
|
581
|
+
# The value associated with the key.
|
582
|
+
# @return [String]
|
499
583
|
#
|
500
|
-
|
501
|
-
|
584
|
+
# @!attribute [rw] is_value_secret
|
585
|
+
# Specified whether the value is a secret.
|
586
|
+
# @return [Boolean]
|
587
|
+
#
|
588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionHeaderParameter AWS API Documentation
|
589
|
+
#
|
590
|
+
class ConnectionHeaderParameter < Struct.new(
|
591
|
+
:key,
|
592
|
+
:value,
|
593
|
+
:is_value_secret)
|
502
594
|
SENSITIVE = []
|
503
595
|
include Aws::Structure
|
504
596
|
end
|
505
597
|
|
506
|
-
#
|
507
|
-
# dead-letter queue configuration.
|
598
|
+
# Contains additional parameters for the connection.
|
508
599
|
#
|
509
|
-
# @note When making an API call, you may pass
|
600
|
+
# @note When making an API call, you may pass ConnectionHttpParameters
|
510
601
|
# data as a hash:
|
511
602
|
#
|
512
603
|
# {
|
513
|
-
#
|
604
|
+
# header_parameters: [
|
605
|
+
# {
|
606
|
+
# key: "HeaderKey",
|
607
|
+
# value: "HeaderValue",
|
608
|
+
# is_value_secret: false,
|
609
|
+
# },
|
610
|
+
# ],
|
611
|
+
# query_string_parameters: [
|
612
|
+
# {
|
613
|
+
# key: "QueryStringKey",
|
614
|
+
# value: "QueryStringValue",
|
615
|
+
# is_value_secret: false,
|
616
|
+
# },
|
617
|
+
# ],
|
618
|
+
# body_parameters: [
|
619
|
+
# {
|
620
|
+
# key: "String",
|
621
|
+
# value: "String",
|
622
|
+
# is_value_secret: false,
|
623
|
+
# },
|
624
|
+
# ],
|
514
625
|
# }
|
515
626
|
#
|
516
|
-
# @!attribute [rw]
|
517
|
-
#
|
518
|
-
#
|
519
|
-
# @return [String]
|
627
|
+
# @!attribute [rw] header_parameters
|
628
|
+
# Contains additional header parameters for the connection.
|
629
|
+
# @return [Array<Types::ConnectionHeaderParameter>]
|
520
630
|
#
|
521
|
-
#
|
631
|
+
# @!attribute [rw] query_string_parameters
|
632
|
+
# Contains additional query string parameters for the connection.
|
633
|
+
# @return [Array<Types::ConnectionQueryStringParameter>]
|
522
634
|
#
|
523
|
-
|
524
|
-
|
635
|
+
# @!attribute [rw] body_parameters
|
636
|
+
# Contains additional body string parameters for the connection.
|
637
|
+
# @return [Array<Types::ConnectionBodyParameter>]
|
638
|
+
#
|
639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionHttpParameters AWS API Documentation
|
640
|
+
#
|
641
|
+
class ConnectionHttpParameters < Struct.new(
|
642
|
+
:header_parameters,
|
643
|
+
:query_string_parameters,
|
644
|
+
:body_parameters)
|
525
645
|
SENSITIVE = []
|
526
646
|
include Aws::Structure
|
527
647
|
end
|
528
648
|
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
# {
|
533
|
-
# archive_name: "ArchiveName", # required
|
534
|
-
# }
|
649
|
+
# Contains the client response parameters for the connection when OAuth
|
650
|
+
# is specified as the authorization type.
|
535
651
|
#
|
536
|
-
# @!attribute [rw]
|
537
|
-
# The
|
652
|
+
# @!attribute [rw] client_id
|
653
|
+
# The client ID associated with the response to the connection
|
654
|
+
# request.
|
538
655
|
# @return [String]
|
539
656
|
#
|
540
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/
|
657
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionOAuthClientResponseParameters AWS API Documentation
|
541
658
|
#
|
542
|
-
class
|
543
|
-
:
|
659
|
+
class ConnectionOAuthClientResponseParameters < Struct.new(
|
660
|
+
:client_id)
|
544
661
|
SENSITIVE = []
|
545
662
|
include Aws::Structure
|
546
663
|
end
|
547
664
|
|
548
|
-
#
|
665
|
+
# Contains the response parameters when OAuth is specified as the
|
666
|
+
# authorization type.
|
549
667
|
#
|
550
|
-
|
551
|
-
|
552
|
-
#
|
553
|
-
#
|
668
|
+
# @!attribute [rw] client_parameters
|
669
|
+
# A `ConnectionOAuthClientResponseParameters` object that contains
|
670
|
+
# details about the client parameters returned when OAuth is specified
|
671
|
+
# as the authorization type.
|
672
|
+
# @return [Types::ConnectionOAuthClientResponseParameters]
|
554
673
|
#
|
555
|
-
#
|
556
|
-
#
|
557
|
-
#
|
674
|
+
# @!attribute [rw] authorization_endpoint
|
675
|
+
# The URL to the HTTP endpoint that authorized the request.
|
676
|
+
# @return [String]
|
558
677
|
#
|
559
|
-
# @!attribute [rw]
|
560
|
-
# The
|
678
|
+
# @!attribute [rw] http_method
|
679
|
+
# The method used to connect to the HTTP endpoint.
|
561
680
|
# @return [String]
|
562
681
|
#
|
563
|
-
#
|
682
|
+
# @!attribute [rw] o_auth_http_parameters
|
683
|
+
# The additional HTTP parameters used for the OAuth authorization
|
684
|
+
# request.
|
685
|
+
# @return [Types::ConnectionHttpParameters]
|
564
686
|
#
|
565
|
-
|
566
|
-
|
687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionOAuthResponseParameters AWS API Documentation
|
688
|
+
#
|
689
|
+
class ConnectionOAuthResponseParameters < Struct.new(
|
690
|
+
:client_parameters,
|
691
|
+
:authorization_endpoint,
|
692
|
+
:http_method,
|
693
|
+
:o_auth_http_parameters)
|
567
694
|
SENSITIVE = []
|
568
695
|
include Aws::Structure
|
569
696
|
end
|
570
697
|
|
571
|
-
#
|
698
|
+
# Additional query string parameter for the connection. You can include
|
699
|
+
# up to 100 additional query string parameters per request. Each
|
700
|
+
# additional parameter counts towards the event payload size, which
|
701
|
+
# cannot exceed 64 KB.
|
702
|
+
#
|
703
|
+
# @note When making an API call, you may pass ConnectionQueryStringParameter
|
572
704
|
# data as a hash:
|
573
705
|
#
|
574
706
|
# {
|
575
|
-
#
|
576
|
-
#
|
707
|
+
# key: "QueryStringKey",
|
708
|
+
# value: "QueryStringValue",
|
709
|
+
# is_value_secret: false,
|
577
710
|
# }
|
578
711
|
#
|
579
|
-
# @!attribute [rw]
|
580
|
-
# The
|
712
|
+
# @!attribute [rw] key
|
713
|
+
# The key for a query string parameter.
|
581
714
|
# @return [String]
|
582
715
|
#
|
583
|
-
# @!attribute [rw]
|
584
|
-
# The
|
585
|
-
#
|
716
|
+
# @!attribute [rw] value
|
717
|
+
# The value associated with the key for the query string parameter.
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] is_value_secret
|
721
|
+
# Specifies whether the value is secret.
|
722
|
+
# @return [Boolean]
|
723
|
+
#
|
724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ConnectionQueryStringParameter AWS API Documentation
|
725
|
+
#
|
726
|
+
class ConnectionQueryStringParameter < Struct.new(
|
727
|
+
:key,
|
728
|
+
:value,
|
729
|
+
:is_value_secret)
|
730
|
+
SENSITIVE = []
|
731
|
+
include Aws::Structure
|
732
|
+
end
|
733
|
+
|
734
|
+
# @note When making an API call, you may pass CreateApiDestinationRequest
|
735
|
+
# data as a hash:
|
736
|
+
#
|
737
|
+
# {
|
738
|
+
# name: "ApiDestinationName", # required
|
739
|
+
# description: "ApiDestinationDescription",
|
740
|
+
# connection_arn: "ConnectionArn", # required
|
741
|
+
# invocation_endpoint: "HttpsEndpoint", # required
|
742
|
+
# http_method: "POST", # required, accepts POST, GET, HEAD, OPTIONS, PUT, PATCH, DELETE
|
743
|
+
# invocation_rate_limit_per_second: 1,
|
744
|
+
# }
|
745
|
+
#
|
746
|
+
# @!attribute [rw] name
|
747
|
+
# The name for the API destination to create.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @!attribute [rw] description
|
751
|
+
# A description for the API destination to create.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] connection_arn
|
755
|
+
# The ARN of the connection to use for the API destination. The
|
756
|
+
# destination endpoint must support the authorization type specified
|
757
|
+
# for the connection.
|
758
|
+
# @return [String]
|
759
|
+
#
|
760
|
+
# @!attribute [rw] invocation_endpoint
|
761
|
+
# The URL to the HTTP invocation endpoint for the API destination.
|
762
|
+
# @return [String]
|
763
|
+
#
|
764
|
+
# @!attribute [rw] http_method
|
765
|
+
# The method to use for the request to the HTTP invocation endpoint.
|
766
|
+
# @return [String]
|
767
|
+
#
|
768
|
+
# @!attribute [rw] invocation_rate_limit_per_second
|
769
|
+
# The maximum number of requests per second to send to the HTTP
|
770
|
+
# invocation endpoint.
|
771
|
+
# @return [Integer]
|
772
|
+
#
|
773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateApiDestinationRequest AWS API Documentation
|
774
|
+
#
|
775
|
+
class CreateApiDestinationRequest < Struct.new(
|
776
|
+
:name,
|
777
|
+
:description,
|
778
|
+
:connection_arn,
|
779
|
+
:invocation_endpoint,
|
780
|
+
:http_method,
|
781
|
+
:invocation_rate_limit_per_second)
|
782
|
+
SENSITIVE = []
|
783
|
+
include Aws::Structure
|
784
|
+
end
|
785
|
+
|
786
|
+
# @!attribute [rw] api_destination_arn
|
787
|
+
# The ARN of the API destination that was created by the request.
|
788
|
+
# @return [String]
|
789
|
+
#
|
790
|
+
# @!attribute [rw] api_destination_state
|
791
|
+
# The state of the API destination that was created by the request.
|
792
|
+
# @return [String]
|
793
|
+
#
|
794
|
+
# @!attribute [rw] creation_time
|
795
|
+
# A time stamp indicating the time that the API destination was
|
796
|
+
# created.
|
797
|
+
# @return [Time]
|
798
|
+
#
|
799
|
+
# @!attribute [rw] last_modified_time
|
800
|
+
# A time stamp indicating the time that the API destination was last
|
801
|
+
# modified.
|
802
|
+
# @return [Time]
|
803
|
+
#
|
804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateApiDestinationResponse AWS API Documentation
|
805
|
+
#
|
806
|
+
class CreateApiDestinationResponse < Struct.new(
|
807
|
+
:api_destination_arn,
|
808
|
+
:api_destination_state,
|
809
|
+
:creation_time,
|
810
|
+
:last_modified_time)
|
811
|
+
SENSITIVE = []
|
812
|
+
include Aws::Structure
|
813
|
+
end
|
814
|
+
|
815
|
+
# @note When making an API call, you may pass CreateArchiveRequest
|
816
|
+
# data as a hash:
|
817
|
+
#
|
818
|
+
# {
|
819
|
+
# archive_name: "ArchiveName", # required
|
820
|
+
# event_source_arn: "Arn", # required
|
821
|
+
# description: "ArchiveDescription",
|
822
|
+
# event_pattern: "EventPattern",
|
823
|
+
# retention_days: 1,
|
824
|
+
# }
|
825
|
+
#
|
826
|
+
# @!attribute [rw] archive_name
|
827
|
+
# The name for the archive to create.
|
828
|
+
# @return [String]
|
829
|
+
#
|
830
|
+
# @!attribute [rw] event_source_arn
|
831
|
+
# The ARN of the event source associated with the archive.
|
832
|
+
# @return [String]
|
833
|
+
#
|
834
|
+
# @!attribute [rw] description
|
835
|
+
# A description for the archive.
|
836
|
+
# @return [String]
|
837
|
+
#
|
838
|
+
# @!attribute [rw] event_pattern
|
839
|
+
# An event pattern to use to filter events sent to the archive.
|
840
|
+
# @return [String]
|
841
|
+
#
|
842
|
+
# @!attribute [rw] retention_days
|
843
|
+
# The number of days to retain events for. Default value is 0. If set
|
844
|
+
# to 0, events are retained indefinitely
|
845
|
+
# @return [Integer]
|
846
|
+
#
|
847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateArchiveRequest AWS API Documentation
|
848
|
+
#
|
849
|
+
class CreateArchiveRequest < Struct.new(
|
850
|
+
:archive_name,
|
851
|
+
:event_source_arn,
|
852
|
+
:description,
|
853
|
+
:event_pattern,
|
854
|
+
:retention_days)
|
855
|
+
SENSITIVE = []
|
856
|
+
include Aws::Structure
|
857
|
+
end
|
858
|
+
|
859
|
+
# @!attribute [rw] archive_arn
|
860
|
+
# The ARN of the archive that was created.
|
861
|
+
# @return [String]
|
862
|
+
#
|
863
|
+
# @!attribute [rw] state
|
864
|
+
# The state of the archive that was created.
|
865
|
+
# @return [String]
|
866
|
+
#
|
867
|
+
# @!attribute [rw] state_reason
|
868
|
+
# The reason that the archive is in the state.
|
869
|
+
# @return [String]
|
870
|
+
#
|
871
|
+
# @!attribute [rw] creation_time
|
872
|
+
# The time at which the archive was created.
|
873
|
+
# @return [Time]
|
874
|
+
#
|
875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateArchiveResponse AWS API Documentation
|
876
|
+
#
|
877
|
+
class CreateArchiveResponse < Struct.new(
|
878
|
+
:archive_arn,
|
879
|
+
:state,
|
880
|
+
:state_reason,
|
881
|
+
:creation_time)
|
882
|
+
SENSITIVE = []
|
883
|
+
include Aws::Structure
|
884
|
+
end
|
885
|
+
|
886
|
+
# Contains the API key authorization parameters for the connection.
|
887
|
+
#
|
888
|
+
# @note When making an API call, you may pass CreateConnectionApiKeyAuthRequestParameters
|
889
|
+
# data as a hash:
|
890
|
+
#
|
891
|
+
# {
|
892
|
+
# api_key_name: "AuthHeaderParameters", # required
|
893
|
+
# api_key_value: "AuthHeaderParameters", # required
|
894
|
+
# }
|
895
|
+
#
|
896
|
+
# @!attribute [rw] api_key_name
|
897
|
+
# The name of the API key to use for authorization.
|
898
|
+
# @return [String]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] api_key_value
|
901
|
+
# The value for the API key to use for authorization.
|
902
|
+
# @return [String]
|
903
|
+
#
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionApiKeyAuthRequestParameters AWS API Documentation
|
905
|
+
#
|
906
|
+
class CreateConnectionApiKeyAuthRequestParameters < Struct.new(
|
907
|
+
:api_key_name,
|
908
|
+
:api_key_value)
|
909
|
+
SENSITIVE = []
|
910
|
+
include Aws::Structure
|
911
|
+
end
|
912
|
+
|
913
|
+
# Contains the authorization parameters for the connection.
|
914
|
+
#
|
915
|
+
# @note When making an API call, you may pass CreateConnectionAuthRequestParameters
|
916
|
+
# data as a hash:
|
917
|
+
#
|
918
|
+
# {
|
919
|
+
# basic_auth_parameters: {
|
920
|
+
# username: "AuthHeaderParameters", # required
|
921
|
+
# password: "AuthHeaderParameters", # required
|
922
|
+
# },
|
923
|
+
# o_auth_parameters: {
|
924
|
+
# client_parameters: { # required
|
925
|
+
# client_id: "AuthHeaderParameters", # required
|
926
|
+
# client_secret: "AuthHeaderParameters", # required
|
927
|
+
# },
|
928
|
+
# authorization_endpoint: "HttpsEndpoint", # required
|
929
|
+
# http_method: "GET", # required, accepts GET, POST, PUT
|
930
|
+
# o_auth_http_parameters: {
|
931
|
+
# header_parameters: [
|
932
|
+
# {
|
933
|
+
# key: "HeaderKey",
|
934
|
+
# value: "HeaderValue",
|
935
|
+
# is_value_secret: false,
|
936
|
+
# },
|
937
|
+
# ],
|
938
|
+
# query_string_parameters: [
|
939
|
+
# {
|
940
|
+
# key: "QueryStringKey",
|
941
|
+
# value: "QueryStringValue",
|
942
|
+
# is_value_secret: false,
|
943
|
+
# },
|
944
|
+
# ],
|
945
|
+
# body_parameters: [
|
946
|
+
# {
|
947
|
+
# key: "String",
|
948
|
+
# value: "String",
|
949
|
+
# is_value_secret: false,
|
950
|
+
# },
|
951
|
+
# ],
|
952
|
+
# },
|
953
|
+
# },
|
954
|
+
# api_key_auth_parameters: {
|
955
|
+
# api_key_name: "AuthHeaderParameters", # required
|
956
|
+
# api_key_value: "AuthHeaderParameters", # required
|
957
|
+
# },
|
958
|
+
# invocation_http_parameters: {
|
959
|
+
# header_parameters: [
|
960
|
+
# {
|
961
|
+
# key: "HeaderKey",
|
962
|
+
# value: "HeaderValue",
|
963
|
+
# is_value_secret: false,
|
964
|
+
# },
|
965
|
+
# ],
|
966
|
+
# query_string_parameters: [
|
967
|
+
# {
|
968
|
+
# key: "QueryStringKey",
|
969
|
+
# value: "QueryStringValue",
|
970
|
+
# is_value_secret: false,
|
971
|
+
# },
|
972
|
+
# ],
|
973
|
+
# body_parameters: [
|
974
|
+
# {
|
975
|
+
# key: "String",
|
976
|
+
# value: "String",
|
977
|
+
# is_value_secret: false,
|
978
|
+
# },
|
979
|
+
# ],
|
980
|
+
# },
|
981
|
+
# }
|
982
|
+
#
|
983
|
+
# @!attribute [rw] basic_auth_parameters
|
984
|
+
# A `CreateConnectionBasicAuthRequestParameters` object that contains
|
985
|
+
# the Basic authorization parameters to use for the connection.
|
986
|
+
# @return [Types::CreateConnectionBasicAuthRequestParameters]
|
987
|
+
#
|
988
|
+
# @!attribute [rw] o_auth_parameters
|
989
|
+
# A `CreateConnectionOAuthRequestParameters` object that contains the
|
990
|
+
# OAuth authorization parameters to use for the connection.
|
991
|
+
# @return [Types::CreateConnectionOAuthRequestParameters]
|
992
|
+
#
|
993
|
+
# @!attribute [rw] api_key_auth_parameters
|
994
|
+
# A `CreateConnectionApiKeyAuthRequestParameters` object that contains
|
995
|
+
# the API key authorization parameters to use for the connection.
|
996
|
+
# @return [Types::CreateConnectionApiKeyAuthRequestParameters]
|
997
|
+
#
|
998
|
+
# @!attribute [rw] invocation_http_parameters
|
999
|
+
# A `ConnectionHttpParameters` object that contains the API key
|
1000
|
+
# authorization parameters to use for the connection. Note that if you
|
1001
|
+
# include additional parameters for the target of a rule via
|
1002
|
+
# `HttpParameters`, including query strings, the parameters added for
|
1003
|
+
# the connection take precedence.
|
1004
|
+
# @return [Types::ConnectionHttpParameters]
|
1005
|
+
#
|
1006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionAuthRequestParameters AWS API Documentation
|
1007
|
+
#
|
1008
|
+
class CreateConnectionAuthRequestParameters < Struct.new(
|
1009
|
+
:basic_auth_parameters,
|
1010
|
+
:o_auth_parameters,
|
1011
|
+
:api_key_auth_parameters,
|
1012
|
+
:invocation_http_parameters)
|
1013
|
+
SENSITIVE = []
|
1014
|
+
include Aws::Structure
|
1015
|
+
end
|
1016
|
+
|
1017
|
+
# Contains the Basic authorization parameters to use for the connection.
|
1018
|
+
#
|
1019
|
+
# @note When making an API call, you may pass CreateConnectionBasicAuthRequestParameters
|
1020
|
+
# data as a hash:
|
1021
|
+
#
|
1022
|
+
# {
|
1023
|
+
# username: "AuthHeaderParameters", # required
|
1024
|
+
# password: "AuthHeaderParameters", # required
|
1025
|
+
# }
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] username
|
1028
|
+
# The user name to use for Basic authorization.
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
1031
|
+
# @!attribute [rw] password
|
1032
|
+
# The password associated with the user name to use for Basic
|
1033
|
+
# authorization.
|
1034
|
+
# @return [String]
|
1035
|
+
#
|
1036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionBasicAuthRequestParameters AWS API Documentation
|
1037
|
+
#
|
1038
|
+
class CreateConnectionBasicAuthRequestParameters < Struct.new(
|
1039
|
+
:username,
|
1040
|
+
:password)
|
1041
|
+
SENSITIVE = []
|
1042
|
+
include Aws::Structure
|
1043
|
+
end
|
1044
|
+
|
1045
|
+
# Contains the Basic authorization parameters to use for the connection.
|
1046
|
+
#
|
1047
|
+
# @note When making an API call, you may pass CreateConnectionOAuthClientRequestParameters
|
1048
|
+
# data as a hash:
|
1049
|
+
#
|
1050
|
+
# {
|
1051
|
+
# client_id: "AuthHeaderParameters", # required
|
1052
|
+
# client_secret: "AuthHeaderParameters", # required
|
1053
|
+
# }
|
1054
|
+
#
|
1055
|
+
# @!attribute [rw] client_id
|
1056
|
+
# The client ID to use for OAuth authorization for the connection.
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] client_secret
|
1060
|
+
# The client secret associated with the client ID to use for OAuth
|
1061
|
+
# authorization for the connection.
|
1062
|
+
# @return [String]
|
1063
|
+
#
|
1064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionOAuthClientRequestParameters AWS API Documentation
|
1065
|
+
#
|
1066
|
+
class CreateConnectionOAuthClientRequestParameters < Struct.new(
|
1067
|
+
:client_id,
|
1068
|
+
:client_secret)
|
1069
|
+
SENSITIVE = []
|
1070
|
+
include Aws::Structure
|
1071
|
+
end
|
1072
|
+
|
1073
|
+
# Contains the OAuth authorization parameters to use for the connection.
|
1074
|
+
#
|
1075
|
+
# @note When making an API call, you may pass CreateConnectionOAuthRequestParameters
|
1076
|
+
# data as a hash:
|
1077
|
+
#
|
1078
|
+
# {
|
1079
|
+
# client_parameters: { # required
|
1080
|
+
# client_id: "AuthHeaderParameters", # required
|
1081
|
+
# client_secret: "AuthHeaderParameters", # required
|
1082
|
+
# },
|
1083
|
+
# authorization_endpoint: "HttpsEndpoint", # required
|
1084
|
+
# http_method: "GET", # required, accepts GET, POST, PUT
|
1085
|
+
# o_auth_http_parameters: {
|
1086
|
+
# header_parameters: [
|
1087
|
+
# {
|
1088
|
+
# key: "HeaderKey",
|
1089
|
+
# value: "HeaderValue",
|
1090
|
+
# is_value_secret: false,
|
1091
|
+
# },
|
1092
|
+
# ],
|
1093
|
+
# query_string_parameters: [
|
1094
|
+
# {
|
1095
|
+
# key: "QueryStringKey",
|
1096
|
+
# value: "QueryStringValue",
|
1097
|
+
# is_value_secret: false,
|
1098
|
+
# },
|
1099
|
+
# ],
|
1100
|
+
# body_parameters: [
|
1101
|
+
# {
|
1102
|
+
# key: "String",
|
1103
|
+
# value: "String",
|
1104
|
+
# is_value_secret: false,
|
1105
|
+
# },
|
1106
|
+
# ],
|
1107
|
+
# },
|
1108
|
+
# }
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] client_parameters
|
1111
|
+
# A `CreateConnectionOAuthClientRequestParameters` object that
|
1112
|
+
# contains the client parameters for OAuth authorization.
|
1113
|
+
# @return [Types::CreateConnectionOAuthClientRequestParameters]
|
1114
|
+
#
|
1115
|
+
# @!attribute [rw] authorization_endpoint
|
1116
|
+
# The URL to the authorization endpoint when OAuth is specified as the
|
1117
|
+
# authorization type.
|
1118
|
+
# @return [String]
|
1119
|
+
#
|
1120
|
+
# @!attribute [rw] http_method
|
1121
|
+
# The method to use for the authorization request.
|
1122
|
+
# @return [String]
|
1123
|
+
#
|
1124
|
+
# @!attribute [rw] o_auth_http_parameters
|
1125
|
+
# A `ConnectionHttpParameters` object that contains details about the
|
1126
|
+
# additional parameters to use for the connection.
|
1127
|
+
# @return [Types::ConnectionHttpParameters]
|
1128
|
+
#
|
1129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionOAuthRequestParameters AWS API Documentation
|
1130
|
+
#
|
1131
|
+
class CreateConnectionOAuthRequestParameters < Struct.new(
|
1132
|
+
:client_parameters,
|
1133
|
+
:authorization_endpoint,
|
1134
|
+
:http_method,
|
1135
|
+
:o_auth_http_parameters)
|
1136
|
+
SENSITIVE = []
|
1137
|
+
include Aws::Structure
|
1138
|
+
end
|
1139
|
+
|
1140
|
+
# @note When making an API call, you may pass CreateConnectionRequest
|
1141
|
+
# data as a hash:
|
1142
|
+
#
|
1143
|
+
# {
|
1144
|
+
# name: "ConnectionName", # required
|
1145
|
+
# description: "ConnectionDescription",
|
1146
|
+
# authorization_type: "BASIC", # required, accepts BASIC, OAUTH_CLIENT_CREDENTIALS, API_KEY
|
1147
|
+
# auth_parameters: { # required
|
1148
|
+
# basic_auth_parameters: {
|
1149
|
+
# username: "AuthHeaderParameters", # required
|
1150
|
+
# password: "AuthHeaderParameters", # required
|
1151
|
+
# },
|
1152
|
+
# o_auth_parameters: {
|
1153
|
+
# client_parameters: { # required
|
1154
|
+
# client_id: "AuthHeaderParameters", # required
|
1155
|
+
# client_secret: "AuthHeaderParameters", # required
|
1156
|
+
# },
|
1157
|
+
# authorization_endpoint: "HttpsEndpoint", # required
|
1158
|
+
# http_method: "GET", # required, accepts GET, POST, PUT
|
1159
|
+
# o_auth_http_parameters: {
|
1160
|
+
# header_parameters: [
|
1161
|
+
# {
|
1162
|
+
# key: "HeaderKey",
|
1163
|
+
# value: "HeaderValue",
|
1164
|
+
# is_value_secret: false,
|
1165
|
+
# },
|
1166
|
+
# ],
|
1167
|
+
# query_string_parameters: [
|
1168
|
+
# {
|
1169
|
+
# key: "QueryStringKey",
|
1170
|
+
# value: "QueryStringValue",
|
1171
|
+
# is_value_secret: false,
|
1172
|
+
# },
|
1173
|
+
# ],
|
1174
|
+
# body_parameters: [
|
1175
|
+
# {
|
1176
|
+
# key: "String",
|
1177
|
+
# value: "String",
|
1178
|
+
# is_value_secret: false,
|
1179
|
+
# },
|
1180
|
+
# ],
|
1181
|
+
# },
|
1182
|
+
# },
|
1183
|
+
# api_key_auth_parameters: {
|
1184
|
+
# api_key_name: "AuthHeaderParameters", # required
|
1185
|
+
# api_key_value: "AuthHeaderParameters", # required
|
1186
|
+
# },
|
1187
|
+
# invocation_http_parameters: {
|
1188
|
+
# header_parameters: [
|
1189
|
+
# {
|
1190
|
+
# key: "HeaderKey",
|
1191
|
+
# value: "HeaderValue",
|
1192
|
+
# is_value_secret: false,
|
1193
|
+
# },
|
1194
|
+
# ],
|
1195
|
+
# query_string_parameters: [
|
1196
|
+
# {
|
1197
|
+
# key: "QueryStringKey",
|
1198
|
+
# value: "QueryStringValue",
|
1199
|
+
# is_value_secret: false,
|
1200
|
+
# },
|
1201
|
+
# ],
|
1202
|
+
# body_parameters: [
|
1203
|
+
# {
|
1204
|
+
# key: "String",
|
1205
|
+
# value: "String",
|
1206
|
+
# is_value_secret: false,
|
1207
|
+
# },
|
1208
|
+
# ],
|
1209
|
+
# },
|
1210
|
+
# },
|
1211
|
+
# }
|
1212
|
+
#
|
1213
|
+
# @!attribute [rw] name
|
1214
|
+
# The name for the connection to create.
|
1215
|
+
# @return [String]
|
1216
|
+
#
|
1217
|
+
# @!attribute [rw] description
|
1218
|
+
# A description for the connection to create.
|
1219
|
+
# @return [String]
|
1220
|
+
#
|
1221
|
+
# @!attribute [rw] authorization_type
|
1222
|
+
# The type of authorization to use for the connection.
|
1223
|
+
# @return [String]
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] auth_parameters
|
1226
|
+
# A `CreateConnectionAuthRequestParameters` object that contains the
|
1227
|
+
# authorization parameters to use to authorize with the endpoint.
|
1228
|
+
# @return [Types::CreateConnectionAuthRequestParameters]
|
1229
|
+
#
|
1230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionRequest AWS API Documentation
|
1231
|
+
#
|
1232
|
+
class CreateConnectionRequest < Struct.new(
|
1233
|
+
:name,
|
1234
|
+
:description,
|
1235
|
+
:authorization_type,
|
1236
|
+
:auth_parameters)
|
1237
|
+
SENSITIVE = []
|
1238
|
+
include Aws::Structure
|
1239
|
+
end
|
1240
|
+
|
1241
|
+
# @!attribute [rw] connection_arn
|
1242
|
+
# The ARN of the connection that was created by the request.
|
1243
|
+
# @return [String]
|
1244
|
+
#
|
1245
|
+
# @!attribute [rw] connection_state
|
1246
|
+
# The state of the connection that was created by the request.
|
1247
|
+
# @return [String]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] creation_time
|
1250
|
+
# A time stamp for the time that the connection was created.
|
1251
|
+
# @return [Time]
|
1252
|
+
#
|
1253
|
+
# @!attribute [rw] last_modified_time
|
1254
|
+
# A time stamp for the time that the connection was last updated.
|
1255
|
+
# @return [Time]
|
1256
|
+
#
|
1257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateConnectionResponse AWS API Documentation
|
1258
|
+
#
|
1259
|
+
class CreateConnectionResponse < Struct.new(
|
1260
|
+
:connection_arn,
|
1261
|
+
:connection_state,
|
1262
|
+
:creation_time,
|
1263
|
+
:last_modified_time)
|
1264
|
+
SENSITIVE = []
|
1265
|
+
include Aws::Structure
|
1266
|
+
end
|
1267
|
+
|
1268
|
+
# @note When making an API call, you may pass CreateEventBusRequest
|
1269
|
+
# data as a hash:
|
1270
|
+
#
|
1271
|
+
# {
|
1272
|
+
# name: "EventBusName", # required
|
1273
|
+
# event_source_name: "EventSourceName",
|
1274
|
+
# tags: [
|
1275
|
+
# {
|
1276
|
+
# key: "TagKey", # required
|
1277
|
+
# value: "TagValue", # required
|
1278
|
+
# },
|
1279
|
+
# ],
|
1280
|
+
# }
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] name
|
1283
|
+
# The name of the new event bus.
|
1284
|
+
#
|
1285
|
+
# Event bus names cannot contain the / character. You can't use the
|
1286
|
+
# name `default` for a custom event bus, as this name is already used
|
1287
|
+
# for your account's default event bus.
|
1288
|
+
#
|
1289
|
+
# If this is a partner event bus, the name must exactly match the name
|
1290
|
+
# of the partner event source that this event bus is matched to.
|
1291
|
+
# @return [String]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] event_source_name
|
1294
|
+
# If you are creating a partner event bus, this specifies the partner
|
1295
|
+
# event source that the new event bus will be matched with.
|
1296
|
+
# @return [String]
|
1297
|
+
#
|
1298
|
+
# @!attribute [rw] tags
|
1299
|
+
# Tags to associate with the event bus.
|
1300
|
+
# @return [Array<Types::Tag>]
|
1301
|
+
#
|
1302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEventBusRequest AWS API Documentation
|
1303
|
+
#
|
1304
|
+
class CreateEventBusRequest < Struct.new(
|
1305
|
+
:name,
|
1306
|
+
:event_source_name,
|
1307
|
+
:tags)
|
1308
|
+
SENSITIVE = []
|
1309
|
+
include Aws::Structure
|
1310
|
+
end
|
1311
|
+
|
1312
|
+
# @!attribute [rw] event_bus_arn
|
1313
|
+
# The ARN of the new event bus.
|
1314
|
+
# @return [String]
|
1315
|
+
#
|
1316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEventBusResponse AWS API Documentation
|
1317
|
+
#
|
1318
|
+
class CreateEventBusResponse < Struct.new(
|
1319
|
+
:event_bus_arn)
|
1320
|
+
SENSITIVE = []
|
1321
|
+
include Aws::Structure
|
1322
|
+
end
|
1323
|
+
|
1324
|
+
# @note When making an API call, you may pass CreatePartnerEventSourceRequest
|
1325
|
+
# data as a hash:
|
1326
|
+
#
|
1327
|
+
# {
|
1328
|
+
# name: "EventSourceName", # required
|
1329
|
+
# account: "AccountId", # required
|
1330
|
+
# }
|
1331
|
+
#
|
1332
|
+
# @!attribute [rw] name
|
1333
|
+
# The name of the partner event source. This name must be unique and
|
1334
|
+
# must be in the format ` partner_name/event_namespace/event_name `.
|
1335
|
+
# The AWS account that wants to use this partner event source must
|
1336
|
+
# create a partner event bus with a name that matches the name of the
|
1337
|
+
# partner event source.
|
1338
|
+
# @return [String]
|
1339
|
+
#
|
1340
|
+
# @!attribute [rw] account
|
1341
|
+
# The AWS account ID that is permitted to create a matching partner
|
1342
|
+
# event bus for this partner event source.
|
1343
|
+
# @return [String]
|
1344
|
+
#
|
1345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
|
1346
|
+
#
|
1347
|
+
class CreatePartnerEventSourceRequest < Struct.new(
|
1348
|
+
:name,
|
1349
|
+
:account)
|
1350
|
+
SENSITIVE = []
|
1351
|
+
include Aws::Structure
|
1352
|
+
end
|
1353
|
+
|
1354
|
+
# @!attribute [rw] event_source_arn
|
1355
|
+
# The ARN of the partner event source.
|
1356
|
+
# @return [String]
|
1357
|
+
#
|
1358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceResponse AWS API Documentation
|
1359
|
+
#
|
1360
|
+
class CreatePartnerEventSourceResponse < Struct.new(
|
1361
|
+
:event_source_arn)
|
1362
|
+
SENSITIVE = []
|
1363
|
+
include Aws::Structure
|
1364
|
+
end
|
1365
|
+
|
1366
|
+
# @note When making an API call, you may pass DeactivateEventSourceRequest
|
1367
|
+
# data as a hash:
|
1368
|
+
#
|
1369
|
+
# {
|
1370
|
+
# name: "EventSourceName", # required
|
1371
|
+
# }
|
1372
|
+
#
|
1373
|
+
# @!attribute [rw] name
|
1374
|
+
# The name of the partner event source to deactivate.
|
1375
|
+
# @return [String]
|
1376
|
+
#
|
1377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeactivateEventSourceRequest AWS API Documentation
|
1378
|
+
#
|
1379
|
+
class DeactivateEventSourceRequest < Struct.new(
|
1380
|
+
:name)
|
1381
|
+
SENSITIVE = []
|
1382
|
+
include Aws::Structure
|
1383
|
+
end
|
1384
|
+
|
1385
|
+
# A `DeadLetterConfig` object that contains information about a
|
1386
|
+
# dead-letter queue configuration.
|
1387
|
+
#
|
1388
|
+
# @note When making an API call, you may pass DeadLetterConfig
|
1389
|
+
# data as a hash:
|
1390
|
+
#
|
1391
|
+
# {
|
1392
|
+
# arn: "ResourceArn",
|
1393
|
+
# }
|
1394
|
+
#
|
1395
|
+
# @!attribute [rw] arn
|
1396
|
+
# The ARN of the SQS queue specified as the target for the dead-letter
|
1397
|
+
# queue.
|
1398
|
+
# @return [String]
|
1399
|
+
#
|
1400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeadLetterConfig AWS API Documentation
|
1401
|
+
#
|
1402
|
+
class DeadLetterConfig < Struct.new(
|
1403
|
+
:arn)
|
1404
|
+
SENSITIVE = []
|
1405
|
+
include Aws::Structure
|
1406
|
+
end
|
1407
|
+
|
1408
|
+
# @note When making an API call, you may pass DeauthorizeConnectionRequest
|
1409
|
+
# data as a hash:
|
1410
|
+
#
|
1411
|
+
# {
|
1412
|
+
# name: "ConnectionName", # required
|
1413
|
+
# }
|
1414
|
+
#
|
1415
|
+
# @!attribute [rw] name
|
1416
|
+
# The name of the connection to remove authorization from.
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeauthorizeConnectionRequest AWS API Documentation
|
1420
|
+
#
|
1421
|
+
class DeauthorizeConnectionRequest < Struct.new(
|
1422
|
+
:name)
|
1423
|
+
SENSITIVE = []
|
1424
|
+
include Aws::Structure
|
1425
|
+
end
|
1426
|
+
|
1427
|
+
# @!attribute [rw] connection_arn
|
1428
|
+
# The ARN of the connection that authorization was removed from.
|
1429
|
+
# @return [String]
|
1430
|
+
#
|
1431
|
+
# @!attribute [rw] connection_state
|
1432
|
+
# The state of the connection.
|
1433
|
+
# @return [String]
|
1434
|
+
#
|
1435
|
+
# @!attribute [rw] creation_time
|
1436
|
+
# A time stamp for the time that the connection was created.
|
1437
|
+
# @return [Time]
|
1438
|
+
#
|
1439
|
+
# @!attribute [rw] last_modified_time
|
1440
|
+
# A time stamp for the time that the connection was last updated.
|
1441
|
+
# @return [Time]
|
1442
|
+
#
|
1443
|
+
# @!attribute [rw] last_authorized_time
|
1444
|
+
# A time stamp for the time that the connection was last authorized.
|
1445
|
+
# @return [Time]
|
1446
|
+
#
|
1447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeauthorizeConnectionResponse AWS API Documentation
|
1448
|
+
#
|
1449
|
+
class DeauthorizeConnectionResponse < Struct.new(
|
1450
|
+
:connection_arn,
|
1451
|
+
:connection_state,
|
1452
|
+
:creation_time,
|
1453
|
+
:last_modified_time,
|
1454
|
+
:last_authorized_time)
|
1455
|
+
SENSITIVE = []
|
1456
|
+
include Aws::Structure
|
1457
|
+
end
|
1458
|
+
|
1459
|
+
# @note When making an API call, you may pass DeleteApiDestinationRequest
|
1460
|
+
# data as a hash:
|
1461
|
+
#
|
1462
|
+
# {
|
1463
|
+
# name: "ApiDestinationName", # required
|
1464
|
+
# }
|
1465
|
+
#
|
1466
|
+
# @!attribute [rw] name
|
1467
|
+
# The name of the destination to delete.
|
1468
|
+
# @return [String]
|
1469
|
+
#
|
1470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteApiDestinationRequest AWS API Documentation
|
1471
|
+
#
|
1472
|
+
class DeleteApiDestinationRequest < Struct.new(
|
1473
|
+
:name)
|
1474
|
+
SENSITIVE = []
|
1475
|
+
include Aws::Structure
|
1476
|
+
end
|
1477
|
+
|
1478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteApiDestinationResponse AWS API Documentation
|
1479
|
+
#
|
1480
|
+
class DeleteApiDestinationResponse < Aws::EmptyStructure; end
|
1481
|
+
|
1482
|
+
# @note When making an API call, you may pass DeleteArchiveRequest
|
1483
|
+
# data as a hash:
|
1484
|
+
#
|
1485
|
+
# {
|
1486
|
+
# archive_name: "ArchiveName", # required
|
1487
|
+
# }
|
1488
|
+
#
|
1489
|
+
# @!attribute [rw] archive_name
|
1490
|
+
# The name of the archive to delete.
|
1491
|
+
# @return [String]
|
1492
|
+
#
|
1493
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteArchiveRequest AWS API Documentation
|
1494
|
+
#
|
1495
|
+
class DeleteArchiveRequest < Struct.new(
|
1496
|
+
:archive_name)
|
1497
|
+
SENSITIVE = []
|
1498
|
+
include Aws::Structure
|
1499
|
+
end
|
1500
|
+
|
1501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteArchiveResponse AWS API Documentation
|
1502
|
+
#
|
1503
|
+
class DeleteArchiveResponse < Aws::EmptyStructure; end
|
1504
|
+
|
1505
|
+
# @note When making an API call, you may pass DeleteConnectionRequest
|
1506
|
+
# data as a hash:
|
1507
|
+
#
|
1508
|
+
# {
|
1509
|
+
# name: "ConnectionName", # required
|
1510
|
+
# }
|
1511
|
+
#
|
1512
|
+
# @!attribute [rw] name
|
1513
|
+
# The name of the connection to delete.
|
1514
|
+
# @return [String]
|
1515
|
+
#
|
1516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteConnectionRequest AWS API Documentation
|
1517
|
+
#
|
1518
|
+
class DeleteConnectionRequest < Struct.new(
|
1519
|
+
:name)
|
1520
|
+
SENSITIVE = []
|
1521
|
+
include Aws::Structure
|
1522
|
+
end
|
1523
|
+
|
1524
|
+
# @!attribute [rw] connection_arn
|
1525
|
+
# The ARN of the connection that was deleted.
|
1526
|
+
# @return [String]
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] connection_state
|
1529
|
+
# The state of the connection before it was deleted.
|
1530
|
+
# @return [String]
|
1531
|
+
#
|
1532
|
+
# @!attribute [rw] creation_time
|
1533
|
+
# A time stamp for the time that the connection was created.
|
1534
|
+
# @return [Time]
|
1535
|
+
#
|
1536
|
+
# @!attribute [rw] last_modified_time
|
1537
|
+
# A time stamp for the time that the connection was last modified
|
1538
|
+
# before it was deleted.
|
1539
|
+
# @return [Time]
|
1540
|
+
#
|
1541
|
+
# @!attribute [rw] last_authorized_time
|
1542
|
+
# A time stamp for the time that the connection was last authorized
|
1543
|
+
# before it wa deleted.
|
1544
|
+
# @return [Time]
|
1545
|
+
#
|
1546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteConnectionResponse AWS API Documentation
|
1547
|
+
#
|
1548
|
+
class DeleteConnectionResponse < Struct.new(
|
1549
|
+
:connection_arn,
|
1550
|
+
:connection_state,
|
1551
|
+
:creation_time,
|
1552
|
+
:last_modified_time,
|
1553
|
+
:last_authorized_time)
|
1554
|
+
SENSITIVE = []
|
1555
|
+
include Aws::Structure
|
1556
|
+
end
|
1557
|
+
|
1558
|
+
# @note When making an API call, you may pass DeleteEventBusRequest
|
1559
|
+
# data as a hash:
|
1560
|
+
#
|
1561
|
+
# {
|
1562
|
+
# name: "EventBusName", # required
|
1563
|
+
# }
|
1564
|
+
#
|
1565
|
+
# @!attribute [rw] name
|
1566
|
+
# The name of the event bus to delete.
|
1567
|
+
# @return [String]
|
1568
|
+
#
|
1569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteEventBusRequest AWS API Documentation
|
1570
|
+
#
|
1571
|
+
class DeleteEventBusRequest < Struct.new(
|
1572
|
+
:name)
|
1573
|
+
SENSITIVE = []
|
1574
|
+
include Aws::Structure
|
1575
|
+
end
|
1576
|
+
|
1577
|
+
# @note When making an API call, you may pass DeletePartnerEventSourceRequest
|
1578
|
+
# data as a hash:
|
1579
|
+
#
|
1580
|
+
# {
|
1581
|
+
# name: "EventSourceName", # required
|
1582
|
+
# account: "AccountId", # required
|
1583
|
+
# }
|
1584
|
+
#
|
1585
|
+
# @!attribute [rw] name
|
1586
|
+
# The name of the event source to delete.
|
1587
|
+
# @return [String]
|
1588
|
+
#
|
1589
|
+
# @!attribute [rw] account
|
1590
|
+
# The AWS account ID of the AWS customer that the event source was
|
1591
|
+
# created for.
|
586
1592
|
# @return [String]
|
587
1593
|
#
|
588
1594
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
|
@@ -603,29 +1609,114 @@ module Aws::EventBridge
|
|
603
1609
|
# force: false,
|
604
1610
|
# }
|
605
1611
|
#
|
606
|
-
# @!attribute [rw] name
|
607
|
-
# The name of the rule.
|
1612
|
+
# @!attribute [rw] name
|
1613
|
+
# The name of the rule.
|
1614
|
+
# @return [String]
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] event_bus_name
|
1617
|
+
# The name or ARN of the event bus associated with the rule. If you
|
1618
|
+
# omit this, the default event bus is used.
|
1619
|
+
# @return [String]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] force
|
1622
|
+
# If this is a managed rule, created by an AWS service on your behalf,
|
1623
|
+
# you must specify `Force` as `True` to delete the rule. This
|
1624
|
+
# parameter is ignored for rules that are not managed rules. You can
|
1625
|
+
# check whether a rule is a managed rule by using `DescribeRule` or
|
1626
|
+
# `ListRules` and checking the `ManagedBy` field of the response.
|
1627
|
+
# @return [Boolean]
|
1628
|
+
#
|
1629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteRuleRequest AWS API Documentation
|
1630
|
+
#
|
1631
|
+
class DeleteRuleRequest < Struct.new(
|
1632
|
+
:name,
|
1633
|
+
:event_bus_name,
|
1634
|
+
:force)
|
1635
|
+
SENSITIVE = []
|
1636
|
+
include Aws::Structure
|
1637
|
+
end
|
1638
|
+
|
1639
|
+
# @note When making an API call, you may pass DescribeApiDestinationRequest
|
1640
|
+
# data as a hash:
|
1641
|
+
#
|
1642
|
+
# {
|
1643
|
+
# name: "ApiDestinationName", # required
|
1644
|
+
# }
|
1645
|
+
#
|
1646
|
+
# @!attribute [rw] name
|
1647
|
+
# The name of the API destination to retrieve.
|
1648
|
+
# @return [String]
|
1649
|
+
#
|
1650
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeApiDestinationRequest AWS API Documentation
|
1651
|
+
#
|
1652
|
+
class DescribeApiDestinationRequest < Struct.new(
|
1653
|
+
:name)
|
1654
|
+
SENSITIVE = []
|
1655
|
+
include Aws::Structure
|
1656
|
+
end
|
1657
|
+
|
1658
|
+
# @!attribute [rw] api_destination_arn
|
1659
|
+
# The ARN of the API destination retrieved.
|
1660
|
+
# @return [String]
|
1661
|
+
#
|
1662
|
+
# @!attribute [rw] name
|
1663
|
+
# The name of the API destination retrieved.
|
1664
|
+
# @return [String]
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] description
|
1667
|
+
# The description for the API destination retrieved.
|
1668
|
+
# @return [String]
|
1669
|
+
#
|
1670
|
+
# @!attribute [rw] api_destination_state
|
1671
|
+
# The state of the API destination retrieved.
|
608
1672
|
# @return [String]
|
609
1673
|
#
|
610
|
-
# @!attribute [rw]
|
611
|
-
# The
|
612
|
-
#
|
1674
|
+
# @!attribute [rw] connection_arn
|
1675
|
+
# The ARN of the connection specified for the API destination
|
1676
|
+
# retrieved.
|
613
1677
|
# @return [String]
|
614
1678
|
#
|
615
|
-
# @!attribute [rw]
|
616
|
-
#
|
617
|
-
#
|
618
|
-
# parameter is ignored for rules that are not managed rules. You can
|
619
|
-
# check whether a rule is a managed rule by using `DescribeRule` or
|
620
|
-
# `ListRules` and checking the `ManagedBy` field of the response.
|
621
|
-
# @return [Boolean]
|
1679
|
+
# @!attribute [rw] invocation_endpoint
|
1680
|
+
# The URL to use to connect to the HTTP endpoint.
|
1681
|
+
# @return [String]
|
622
1682
|
#
|
623
|
-
#
|
1683
|
+
# @!attribute [rw] http_method
|
1684
|
+
# The method to use to connect to the HTTP endpoint.
|
1685
|
+
# @return [String]
|
624
1686
|
#
|
625
|
-
|
1687
|
+
# @!attribute [rw] invocation_rate_limit_per_second
|
1688
|
+
# The maximum number of invocations per second to specified for the
|
1689
|
+
# API destination. Note that if you set the invocation rate maximum to
|
1690
|
+
# a value lower the rate necessary to send all events received on to
|
1691
|
+
# the destination HTTP endpoint, some events may not be delivered
|
1692
|
+
# within the 24-hour retry window. If you plan to set the rate lower
|
1693
|
+
# than the rate necessary to deliver all events, consider using a
|
1694
|
+
# dead-letter queue to catch events that are not delivered within 24
|
1695
|
+
# hours.
|
1696
|
+
# @return [Integer]
|
1697
|
+
#
|
1698
|
+
# @!attribute [rw] creation_time
|
1699
|
+
# A time stamp for the time that the API destination was created.
|
1700
|
+
# @return [Time]
|
1701
|
+
#
|
1702
|
+
# @!attribute [rw] last_modified_time
|
1703
|
+
# A time stamp for the time that the API destination was last
|
1704
|
+
# modified.
|
1705
|
+
# @return [Time]
|
1706
|
+
#
|
1707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeApiDestinationResponse AWS API Documentation
|
1708
|
+
#
|
1709
|
+
class DescribeApiDestinationResponse < Struct.new(
|
1710
|
+
:api_destination_arn,
|
626
1711
|
:name,
|
627
|
-
:
|
628
|
-
:
|
1712
|
+
:description,
|
1713
|
+
:api_destination_state,
|
1714
|
+
:connection_arn,
|
1715
|
+
:invocation_endpoint,
|
1716
|
+
:http_method,
|
1717
|
+
:invocation_rate_limit_per_second,
|
1718
|
+
:creation_time,
|
1719
|
+
:last_modified_time)
|
629
1720
|
SENSITIVE = []
|
630
1721
|
include Aws::Structure
|
631
1722
|
end
|
@@ -711,6 +1802,88 @@ module Aws::EventBridge
|
|
711
1802
|
include Aws::Structure
|
712
1803
|
end
|
713
1804
|
|
1805
|
+
# @note When making an API call, you may pass DescribeConnectionRequest
|
1806
|
+
# data as a hash:
|
1807
|
+
#
|
1808
|
+
# {
|
1809
|
+
# name: "ConnectionName", # required
|
1810
|
+
# }
|
1811
|
+
#
|
1812
|
+
# @!attribute [rw] name
|
1813
|
+
# The name of the connection to retrieve.
|
1814
|
+
# @return [String]
|
1815
|
+
#
|
1816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeConnectionRequest AWS API Documentation
|
1817
|
+
#
|
1818
|
+
class DescribeConnectionRequest < Struct.new(
|
1819
|
+
:name)
|
1820
|
+
SENSITIVE = []
|
1821
|
+
include Aws::Structure
|
1822
|
+
end
|
1823
|
+
|
1824
|
+
# @!attribute [rw] connection_arn
|
1825
|
+
# The ARN of the connection retrieved.
|
1826
|
+
# @return [String]
|
1827
|
+
#
|
1828
|
+
# @!attribute [rw] name
|
1829
|
+
# The name of the connection retrieved.
|
1830
|
+
# @return [String]
|
1831
|
+
#
|
1832
|
+
# @!attribute [rw] description
|
1833
|
+
# The description for the connection retrieved.
|
1834
|
+
# @return [String]
|
1835
|
+
#
|
1836
|
+
# @!attribute [rw] connection_state
|
1837
|
+
# The state of the connection retrieved.
|
1838
|
+
# @return [String]
|
1839
|
+
#
|
1840
|
+
# @!attribute [rw] state_reason
|
1841
|
+
# The reason that the connection is in the current connection state.
|
1842
|
+
# @return [String]
|
1843
|
+
#
|
1844
|
+
# @!attribute [rw] authorization_type
|
1845
|
+
# The type of authorization specified for the connection.
|
1846
|
+
# @return [String]
|
1847
|
+
#
|
1848
|
+
# @!attribute [rw] secret_arn
|
1849
|
+
# The ARN of the secret created from the authorization parameters
|
1850
|
+
# specified for the connection.
|
1851
|
+
# @return [String]
|
1852
|
+
#
|
1853
|
+
# @!attribute [rw] auth_parameters
|
1854
|
+
# The parameters to use for authorization for the connection.
|
1855
|
+
# @return [Types::ConnectionAuthResponseParameters]
|
1856
|
+
#
|
1857
|
+
# @!attribute [rw] creation_time
|
1858
|
+
# A time stamp for the time that the connection was created.
|
1859
|
+
# @return [Time]
|
1860
|
+
#
|
1861
|
+
# @!attribute [rw] last_modified_time
|
1862
|
+
# A time stamp for the time that the connection was last modified.
|
1863
|
+
# @return [Time]
|
1864
|
+
#
|
1865
|
+
# @!attribute [rw] last_authorized_time
|
1866
|
+
# A time stamp for the time that the connection was last authorized.
|
1867
|
+
# @return [Time]
|
1868
|
+
#
|
1869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeConnectionResponse AWS API Documentation
|
1870
|
+
#
|
1871
|
+
class DescribeConnectionResponse < Struct.new(
|
1872
|
+
:connection_arn,
|
1873
|
+
:name,
|
1874
|
+
:description,
|
1875
|
+
:connection_state,
|
1876
|
+
:state_reason,
|
1877
|
+
:authorization_type,
|
1878
|
+
:secret_arn,
|
1879
|
+
:auth_parameters,
|
1880
|
+
:creation_time,
|
1881
|
+
:last_modified_time,
|
1882
|
+
:last_authorized_time)
|
1883
|
+
SENSITIVE = []
|
1884
|
+
include Aws::Structure
|
1885
|
+
end
|
1886
|
+
|
714
1887
|
# @note When making an API call, you may pass DescribeEventBusRequest
|
715
1888
|
# data as a hash:
|
716
1889
|
#
|
@@ -1083,6 +2256,35 @@ module Aws::EventBridge
|
|
1083
2256
|
# },
|
1084
2257
|
# platform_version: "String",
|
1085
2258
|
# group: "String",
|
2259
|
+
# capacity_provider_strategy: [
|
2260
|
+
# {
|
2261
|
+
# capacity_provider: "CapacityProvider", # required
|
2262
|
+
# weight: 1,
|
2263
|
+
# base: 1,
|
2264
|
+
# },
|
2265
|
+
# ],
|
2266
|
+
# enable_ecs_managed_tags: false,
|
2267
|
+
# enable_execute_command: false,
|
2268
|
+
# placement_constraints: [
|
2269
|
+
# {
|
2270
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
2271
|
+
# expression: "PlacementConstraintExpression",
|
2272
|
+
# },
|
2273
|
+
# ],
|
2274
|
+
# placement_strategy: [
|
2275
|
+
# {
|
2276
|
+
# type: "random", # accepts random, spread, binpack
|
2277
|
+
# field: "PlacementStrategyField",
|
2278
|
+
# },
|
2279
|
+
# ],
|
2280
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
|
2281
|
+
# reference_id: "ReferenceId",
|
2282
|
+
# tags: [
|
2283
|
+
# {
|
2284
|
+
# key: "TagKey", # required
|
2285
|
+
# value: "TagValue", # required
|
2286
|
+
# },
|
2287
|
+
# ],
|
1086
2288
|
# }
|
1087
2289
|
#
|
1088
2290
|
# @!attribute [rw] task_definition_arn
|
@@ -1138,6 +2340,64 @@ module Aws::EventBridge
|
|
1138
2340
|
# characters.
|
1139
2341
|
# @return [String]
|
1140
2342
|
#
|
2343
|
+
# @!attribute [rw] capacity_provider_strategy
|
2344
|
+
# The capacity provider strategy to use for the task.
|
2345
|
+
#
|
2346
|
+
# If a `capacityProviderStrategy` is specified, the `launchType`
|
2347
|
+
# parameter must be omitted. If no `capacityProviderStrategy` or
|
2348
|
+
# launchType is specified, the `defaultCapacityProviderStrategy` for
|
2349
|
+
# the cluster is used.
|
2350
|
+
# @return [Array<Types::CapacityProviderStrategyItem>]
|
2351
|
+
#
|
2352
|
+
# @!attribute [rw] enable_ecs_managed_tags
|
2353
|
+
# Specifies whether to enable Amazon ECS managed tags for the task.
|
2354
|
+
# For more information, see [Tagging Your Amazon ECS Resources][1] in
|
2355
|
+
# the Amazon Elastic Container Service Developer Guide.
|
2356
|
+
#
|
2357
|
+
#
|
2358
|
+
#
|
2359
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
2360
|
+
# @return [Boolean]
|
2361
|
+
#
|
2362
|
+
# @!attribute [rw] enable_execute_command
|
2363
|
+
# Whether or not to enable the execute command functionality for the
|
2364
|
+
# containers in this task. If true, this enables execute command
|
2365
|
+
# functionality on all containers in the task.
|
2366
|
+
# @return [Boolean]
|
2367
|
+
#
|
2368
|
+
# @!attribute [rw] placement_constraints
|
2369
|
+
# An array of placement constraint objects to use for the task. You
|
2370
|
+
# can specify up to 10 constraints per task (including constraints in
|
2371
|
+
# the task definition and those specified at runtime).
|
2372
|
+
# @return [Array<Types::PlacementConstraint>]
|
2373
|
+
#
|
2374
|
+
# @!attribute [rw] placement_strategy
|
2375
|
+
# The placement strategy objects to use for the task. You can specify
|
2376
|
+
# a maximum of five strategy rules per task.
|
2377
|
+
# @return [Array<Types::PlacementStrategy>]
|
2378
|
+
#
|
2379
|
+
# @!attribute [rw] propagate_tags
|
2380
|
+
# Specifies whether to propagate the tags from the task definition to
|
2381
|
+
# the task. If no value is specified, the tags are not propagated.
|
2382
|
+
# Tags can only be propagated to the task during task creation. To add
|
2383
|
+
# tags to a task after task creation, use the TagResource API action.
|
2384
|
+
# @return [String]
|
2385
|
+
#
|
2386
|
+
# @!attribute [rw] reference_id
|
2387
|
+
# The reference ID to use for the task.
|
2388
|
+
# @return [String]
|
2389
|
+
#
|
2390
|
+
# @!attribute [rw] tags
|
2391
|
+
# The metadata that you apply to the task to help you categorize and
|
2392
|
+
# organize them. Each tag consists of a key and an optional value,
|
2393
|
+
# both of which you define. To learn more, see [RunTask][1] in the
|
2394
|
+
# Amazon ECS API Reference.
|
2395
|
+
#
|
2396
|
+
#
|
2397
|
+
#
|
2398
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags
|
2399
|
+
# @return [Array<Types::Tag>]
|
2400
|
+
#
|
1141
2401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EcsParameters AWS API Documentation
|
1142
2402
|
#
|
1143
2403
|
class EcsParameters < Struct.new(
|
@@ -1146,7 +2406,15 @@ module Aws::EventBridge
|
|
1146
2406
|
:launch_type,
|
1147
2407
|
:network_configuration,
|
1148
2408
|
:platform_version,
|
1149
|
-
:group
|
2409
|
+
:group,
|
2410
|
+
:capacity_provider_strategy,
|
2411
|
+
:enable_ecs_managed_tags,
|
2412
|
+
:enable_execute_command,
|
2413
|
+
:placement_constraints,
|
2414
|
+
:placement_strategy,
|
2415
|
+
:propagate_tags,
|
2416
|
+
:reference_id,
|
2417
|
+
:tags)
|
1150
2418
|
SENSITIVE = []
|
1151
2419
|
include Aws::Structure
|
1152
2420
|
end
|
@@ -1179,11 +2447,10 @@ module Aws::EventBridge
|
|
1179
2447
|
|
1180
2448
|
# An event bus receives events from a source and routes them to rules
|
1181
2449
|
# associated with that event bus. Your account's default event bus
|
1182
|
-
# receives
|
1183
|
-
# from
|
1184
|
-
#
|
1185
|
-
#
|
1186
|
-
# applications.
|
2450
|
+
# receives events from AWS services. A custom event bus can receive
|
2451
|
+
# events from your custom applications and services. A partner event bus
|
2452
|
+
# receives events from an event source created by an SaaS partner. These
|
2453
|
+
# events come from the partners services or applications.
|
1187
2454
|
#
|
1188
2455
|
# @!attribute [rw] name
|
1189
2456
|
# The name of the event bus.
|
@@ -1257,7 +2524,9 @@ module Aws::EventBridge
|
|
1257
2524
|
end
|
1258
2525
|
|
1259
2526
|
# These are custom parameter to be used when the target is an API
|
1260
|
-
# Gateway REST APIs.
|
2527
|
+
# Gateway REST APIs or EventBridge ApiDestinations. In the latter case,
|
2528
|
+
# these are merged with any InvocationParameters specified on the
|
2529
|
+
# Connection, with any values from the Connection taking precedence.
|
1261
2530
|
#
|
1262
2531
|
# @note When making an API call, you may pass HttpParameters
|
1263
2532
|
# data as a hash:
|
@@ -1274,17 +2543,17 @@ module Aws::EventBridge
|
|
1274
2543
|
#
|
1275
2544
|
# @!attribute [rw] path_parameter_values
|
1276
2545
|
# The path parameter values to be used to populate API Gateway REST
|
1277
|
-
# API path wildcards ("*").
|
2546
|
+
# API or EventBridge ApiDestination path wildcards ("*").
|
1278
2547
|
# @return [Array<String>]
|
1279
2548
|
#
|
1280
2549
|
# @!attribute [rw] header_parameters
|
1281
2550
|
# The headers that need to be sent as part of request invoking the API
|
1282
|
-
# Gateway REST API.
|
2551
|
+
# Gateway REST API or EventBridge ApiDestination.
|
1283
2552
|
# @return [Hash<String,String>]
|
1284
2553
|
#
|
1285
2554
|
# @!attribute [rw] query_string_parameters
|
1286
2555
|
# The query string keys/values that need to be sent as part of request
|
1287
|
-
# invoking the API Gateway REST API.
|
2556
|
+
# invoking the API Gateway REST API or EventBridge ApiDestination.
|
1288
2557
|
# @return [Hash<String,String>]
|
1289
2558
|
#
|
1290
2559
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/HttpParameters AWS API Documentation
|
@@ -1323,7 +2592,7 @@ module Aws::EventBridge
|
|
1323
2592
|
# output you want to be sent to the target.
|
1324
2593
|
#
|
1325
2594
|
# `InputPathsMap` is an array key-value pairs, where each value is a
|
1326
|
-
# valid JSON path. You can have as many as
|
2595
|
+
# valid JSON path. You can have as many as 100 key-value pairs. You
|
1327
2596
|
# must use JSON dot notation, not bracket notation.
|
1328
2597
|
#
|
1329
2598
|
# The keys cannot start with "AWS."
|
@@ -1340,7 +2609,7 @@ module Aws::EventBridge
|
|
1340
2609
|
#
|
1341
2610
|
# * The placeholder cannot be used as an object key.
|
1342
2611
|
#
|
1343
|
-
#
|
2612
|
+
# ^
|
1344
2613
|
#
|
1345
2614
|
# The following example shows the syntax for using `InputPathsMap` and
|
1346
2615
|
# `InputTemplate`.
|
@@ -1370,6 +2639,21 @@ module Aws::EventBridge
|
|
1370
2639
|
# `"InputTemplate": "<instance> is in state "<status>""`
|
1371
2640
|
#
|
1372
2641
|
# `\}`
|
2642
|
+
#
|
2643
|
+
# The `InputTemplate` can also be valid JSON with varibles in quotes
|
2644
|
+
# or out, as in the following example:
|
2645
|
+
#
|
2646
|
+
# ` "InputTransformer":`
|
2647
|
+
#
|
2648
|
+
# `\{`
|
2649
|
+
#
|
2650
|
+
# `"InputPathsMap": \{"instance": "$.detail.instance","status":
|
2651
|
+
# "$.detail.status"\},`
|
2652
|
+
#
|
2653
|
+
# `"InputTemplate": '\{"myInstance": <instance>,"myStatus":
|
2654
|
+
# "<instance> is in state "<status>""\}'`
|
2655
|
+
#
|
2656
|
+
# `\}`
|
1373
2657
|
# @return [String]
|
1374
2658
|
#
|
1375
2659
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/InputTransformer AWS API Documentation
|
@@ -1437,6 +2721,64 @@ module Aws::EventBridge
|
|
1437
2721
|
#
|
1438
2722
|
class LimitExceededException < Aws::EmptyStructure; end
|
1439
2723
|
|
2724
|
+
# @note When making an API call, you may pass ListApiDestinationsRequest
|
2725
|
+
# data as a hash:
|
2726
|
+
#
|
2727
|
+
# {
|
2728
|
+
# name_prefix: "ApiDestinationName",
|
2729
|
+
# connection_arn: "ConnectionArn",
|
2730
|
+
# next_token: "NextToken",
|
2731
|
+
# limit: 1,
|
2732
|
+
# }
|
2733
|
+
#
|
2734
|
+
# @!attribute [rw] name_prefix
|
2735
|
+
# A name prefix to filter results returned. Only API destinations with
|
2736
|
+
# a name that starts with the prefix are returned.
|
2737
|
+
# @return [String]
|
2738
|
+
#
|
2739
|
+
# @!attribute [rw] connection_arn
|
2740
|
+
# The ARN of the connection specified for the API destination.
|
2741
|
+
# @return [String]
|
2742
|
+
#
|
2743
|
+
# @!attribute [rw] next_token
|
2744
|
+
# The token returned by a previous call to retrieve the next set of
|
2745
|
+
# results.
|
2746
|
+
# @return [String]
|
2747
|
+
#
|
2748
|
+
# @!attribute [rw] limit
|
2749
|
+
# The maximum number of API destinations to include in the response.
|
2750
|
+
# @return [Integer]
|
2751
|
+
#
|
2752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListApiDestinationsRequest AWS API Documentation
|
2753
|
+
#
|
2754
|
+
class ListApiDestinationsRequest < Struct.new(
|
2755
|
+
:name_prefix,
|
2756
|
+
:connection_arn,
|
2757
|
+
:next_token,
|
2758
|
+
:limit)
|
2759
|
+
SENSITIVE = []
|
2760
|
+
include Aws::Structure
|
2761
|
+
end
|
2762
|
+
|
2763
|
+
# @!attribute [rw] api_destinations
|
2764
|
+
# An array of `ApiDestination` objects that include information about
|
2765
|
+
# an API destination.
|
2766
|
+
# @return [Array<Types::ApiDestination>]
|
2767
|
+
#
|
2768
|
+
# @!attribute [rw] next_token
|
2769
|
+
# A token you can use in a subsequent request to retrieve the next set
|
2770
|
+
# of results.
|
2771
|
+
# @return [String]
|
2772
|
+
#
|
2773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListApiDestinationsResponse AWS API Documentation
|
2774
|
+
#
|
2775
|
+
class ListApiDestinationsResponse < Struct.new(
|
2776
|
+
:api_destinations,
|
2777
|
+
:next_token)
|
2778
|
+
SENSITIVE = []
|
2779
|
+
include Aws::Structure
|
2780
|
+
end
|
2781
|
+
|
1440
2782
|
# @note When making an API call, you may pass ListArchivesRequest
|
1441
2783
|
# data as a hash:
|
1442
2784
|
#
|
@@ -1500,6 +2842,64 @@ module Aws::EventBridge
|
|
1500
2842
|
include Aws::Structure
|
1501
2843
|
end
|
1502
2844
|
|
2845
|
+
# @note When making an API call, you may pass ListConnectionsRequest
|
2846
|
+
# data as a hash:
|
2847
|
+
#
|
2848
|
+
# {
|
2849
|
+
# name_prefix: "ConnectionName",
|
2850
|
+
# connection_state: "CREATING", # accepts CREATING, UPDATING, DELETING, AUTHORIZED, DEAUTHORIZED, AUTHORIZING, DEAUTHORIZING
|
2851
|
+
# next_token: "NextToken",
|
2852
|
+
# limit: 1,
|
2853
|
+
# }
|
2854
|
+
#
|
2855
|
+
# @!attribute [rw] name_prefix
|
2856
|
+
# A name prefix to filter results returned. Only connections with a
|
2857
|
+
# name that starts with the prefix are returned.
|
2858
|
+
# @return [String]
|
2859
|
+
#
|
2860
|
+
# @!attribute [rw] connection_state
|
2861
|
+
# The state of the connection.
|
2862
|
+
# @return [String]
|
2863
|
+
#
|
2864
|
+
# @!attribute [rw] next_token
|
2865
|
+
# The token returned by a previous call to retrieve the next set of
|
2866
|
+
# results.
|
2867
|
+
# @return [String]
|
2868
|
+
#
|
2869
|
+
# @!attribute [rw] limit
|
2870
|
+
# The maximum number of connections to return.
|
2871
|
+
# @return [Integer]
|
2872
|
+
#
|
2873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListConnectionsRequest AWS API Documentation
|
2874
|
+
#
|
2875
|
+
class ListConnectionsRequest < Struct.new(
|
2876
|
+
:name_prefix,
|
2877
|
+
:connection_state,
|
2878
|
+
:next_token,
|
2879
|
+
:limit)
|
2880
|
+
SENSITIVE = []
|
2881
|
+
include Aws::Structure
|
2882
|
+
end
|
2883
|
+
|
2884
|
+
# @!attribute [rw] connections
|
2885
|
+
# An array of connections objects that include details about the
|
2886
|
+
# connections.
|
2887
|
+
# @return [Array<Types::Connection>]
|
2888
|
+
#
|
2889
|
+
# @!attribute [rw] next_token
|
2890
|
+
# A token you can use in a subsequent request to retrieve the next set
|
2891
|
+
# of results.
|
2892
|
+
# @return [String]
|
2893
|
+
#
|
2894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListConnectionsResponse AWS API Documentation
|
2895
|
+
#
|
2896
|
+
class ListConnectionsResponse < Struct.new(
|
2897
|
+
:connections,
|
2898
|
+
:next_token)
|
2899
|
+
SENSITIVE = []
|
2900
|
+
include Aws::Structure
|
2901
|
+
end
|
2902
|
+
|
1503
2903
|
# @note When making an API call, you may pass ListEventBusesRequest
|
1504
2904
|
# data as a hash:
|
1505
2905
|
#
|
@@ -2082,6 +3482,95 @@ module Aws::EventBridge
|
|
2082
3482
|
include Aws::Structure
|
2083
3483
|
end
|
2084
3484
|
|
3485
|
+
# An object representing a constraint on task placement. To learn more,
|
3486
|
+
# see [Task Placement Constraints][1] in the Amazon Elastic Container
|
3487
|
+
# Service Developer Guide.
|
3488
|
+
#
|
3489
|
+
#
|
3490
|
+
#
|
3491
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html
|
3492
|
+
#
|
3493
|
+
# @note When making an API call, you may pass PlacementConstraint
|
3494
|
+
# data as a hash:
|
3495
|
+
#
|
3496
|
+
# {
|
3497
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
3498
|
+
# expression: "PlacementConstraintExpression",
|
3499
|
+
# }
|
3500
|
+
#
|
3501
|
+
# @!attribute [rw] type
|
3502
|
+
# The type of constraint. Use distinctInstance to ensure that each
|
3503
|
+
# task in a particular group is running on a different container
|
3504
|
+
# instance. Use memberOf to restrict the selection to a group of valid
|
3505
|
+
# candidates.
|
3506
|
+
# @return [String]
|
3507
|
+
#
|
3508
|
+
# @!attribute [rw] expression
|
3509
|
+
# A cluster query language expression to apply to the constraint. You
|
3510
|
+
# cannot specify an expression if the constraint type is
|
3511
|
+
# `distinctInstance`. To learn more, see [Cluster Query Language][1]
|
3512
|
+
# in the Amazon Elastic Container Service Developer Guide.
|
3513
|
+
#
|
3514
|
+
#
|
3515
|
+
#
|
3516
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html
|
3517
|
+
# @return [String]
|
3518
|
+
#
|
3519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PlacementConstraint AWS API Documentation
|
3520
|
+
#
|
3521
|
+
class PlacementConstraint < Struct.new(
|
3522
|
+
:type,
|
3523
|
+
:expression)
|
3524
|
+
SENSITIVE = []
|
3525
|
+
include Aws::Structure
|
3526
|
+
end
|
3527
|
+
|
3528
|
+
# The task placement strategy for a task or service. To learn more, see
|
3529
|
+
# [Task Placement Strategies][1] in the Amazon Elastic Container Service
|
3530
|
+
# Developer Guide.
|
3531
|
+
#
|
3532
|
+
#
|
3533
|
+
#
|
3534
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html
|
3535
|
+
#
|
3536
|
+
# @note When making an API call, you may pass PlacementStrategy
|
3537
|
+
# data as a hash:
|
3538
|
+
#
|
3539
|
+
# {
|
3540
|
+
# type: "random", # accepts random, spread, binpack
|
3541
|
+
# field: "PlacementStrategyField",
|
3542
|
+
# }
|
3543
|
+
#
|
3544
|
+
# @!attribute [rw] type
|
3545
|
+
# The type of placement strategy. The random placement strategy
|
3546
|
+
# randomly places tasks on available candidates. The spread placement
|
3547
|
+
# strategy spreads placement across available candidates evenly based
|
3548
|
+
# on the field parameter. The binpack strategy places tasks on
|
3549
|
+
# available candidates that have the least available amount of the
|
3550
|
+
# resource that is specified with the field parameter. For example, if
|
3551
|
+
# you binpack on memory, a task is placed on the instance with the
|
3552
|
+
# least amount of remaining memory (but still enough to run the task).
|
3553
|
+
# @return [String]
|
3554
|
+
#
|
3555
|
+
# @!attribute [rw] field
|
3556
|
+
# The field to apply the placement strategy against. For the spread
|
3557
|
+
# placement strategy, valid values are instanceId (or host, which has
|
3558
|
+
# the same effect), or any platform or custom attribute that is
|
3559
|
+
# applied to a container instance, such as
|
3560
|
+
# attribute:ecs.availability-zone. For the binpack placement strategy,
|
3561
|
+
# valid values are cpu and memory. For the random placement strategy,
|
3562
|
+
# this field is not used.
|
3563
|
+
# @return [String]
|
3564
|
+
#
|
3565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PlacementStrategy AWS API Documentation
|
3566
|
+
#
|
3567
|
+
class PlacementStrategy < Struct.new(
|
3568
|
+
:type,
|
3569
|
+
:field)
|
3570
|
+
SENSITIVE = []
|
3571
|
+
include Aws::Structure
|
3572
|
+
end
|
3573
|
+
|
2085
3574
|
# The event bus policy is too long. For more information, see the
|
2086
3575
|
# limits.
|
2087
3576
|
#
|
@@ -2572,6 +4061,35 @@ module Aws::EventBridge
|
|
2572
4061
|
# },
|
2573
4062
|
# platform_version: "String",
|
2574
4063
|
# group: "String",
|
4064
|
+
# capacity_provider_strategy: [
|
4065
|
+
# {
|
4066
|
+
# capacity_provider: "CapacityProvider", # required
|
4067
|
+
# weight: 1,
|
4068
|
+
# base: 1,
|
4069
|
+
# },
|
4070
|
+
# ],
|
4071
|
+
# enable_ecs_managed_tags: false,
|
4072
|
+
# enable_execute_command: false,
|
4073
|
+
# placement_constraints: [
|
4074
|
+
# {
|
4075
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
4076
|
+
# expression: "PlacementConstraintExpression",
|
4077
|
+
# },
|
4078
|
+
# ],
|
4079
|
+
# placement_strategy: [
|
4080
|
+
# {
|
4081
|
+
# type: "random", # accepts random, spread, binpack
|
4082
|
+
# field: "PlacementStrategyField",
|
4083
|
+
# },
|
4084
|
+
# ],
|
4085
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
|
4086
|
+
# reference_id: "ReferenceId",
|
4087
|
+
# tags: [
|
4088
|
+
# {
|
4089
|
+
# key: "TagKey", # required
|
4090
|
+
# value: "TagValue", # required
|
4091
|
+
# },
|
4092
|
+
# ],
|
2575
4093
|
# },
|
2576
4094
|
# batch_parameters: {
|
2577
4095
|
# job_definition: "String", # required
|
@@ -2603,6 +4121,14 @@ module Aws::EventBridge
|
|
2603
4121
|
# statement_name: "StatementName",
|
2604
4122
|
# with_event: false,
|
2605
4123
|
# },
|
4124
|
+
# sage_maker_pipeline_parameters: {
|
4125
|
+
# pipeline_parameter_list: [
|
4126
|
+
# {
|
4127
|
+
# name: "SageMakerPipelineParameterName", # required
|
4128
|
+
# value: "SageMakerPipelineParameterValue", # required
|
4129
|
+
# },
|
4130
|
+
# ],
|
4131
|
+
# },
|
2606
4132
|
# dead_letter_config: {
|
2607
4133
|
# arn: "ResourceArn",
|
2608
4134
|
# },
|
@@ -3111,6 +4637,64 @@ module Aws::EventBridge
|
|
3111
4637
|
include Aws::Structure
|
3112
4638
|
end
|
3113
4639
|
|
4640
|
+
# Name/Value pair of a parameter to start execution of a SageMaker Model
|
4641
|
+
# Building Pipeline.
|
4642
|
+
#
|
4643
|
+
# @note When making an API call, you may pass SageMakerPipelineParameter
|
4644
|
+
# data as a hash:
|
4645
|
+
#
|
4646
|
+
# {
|
4647
|
+
# name: "SageMakerPipelineParameterName", # required
|
4648
|
+
# value: "SageMakerPipelineParameterValue", # required
|
4649
|
+
# }
|
4650
|
+
#
|
4651
|
+
# @!attribute [rw] name
|
4652
|
+
# Name of parameter to start execution of a SageMaker Model Building
|
4653
|
+
# Pipeline.
|
4654
|
+
# @return [String]
|
4655
|
+
#
|
4656
|
+
# @!attribute [rw] value
|
4657
|
+
# Value of parameter to start execution of a SageMaker Model Building
|
4658
|
+
# Pipeline.
|
4659
|
+
# @return [String]
|
4660
|
+
#
|
4661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/SageMakerPipelineParameter AWS API Documentation
|
4662
|
+
#
|
4663
|
+
class SageMakerPipelineParameter < Struct.new(
|
4664
|
+
:name,
|
4665
|
+
:value)
|
4666
|
+
SENSITIVE = []
|
4667
|
+
include Aws::Structure
|
4668
|
+
end
|
4669
|
+
|
4670
|
+
# These are custom parameters to use when the target is a SageMaker
|
4671
|
+
# Model Building Pipeline that starts based on EventBridge events.
|
4672
|
+
#
|
4673
|
+
# @note When making an API call, you may pass SageMakerPipelineParameters
|
4674
|
+
# data as a hash:
|
4675
|
+
#
|
4676
|
+
# {
|
4677
|
+
# pipeline_parameter_list: [
|
4678
|
+
# {
|
4679
|
+
# name: "SageMakerPipelineParameterName", # required
|
4680
|
+
# value: "SageMakerPipelineParameterValue", # required
|
4681
|
+
# },
|
4682
|
+
# ],
|
4683
|
+
# }
|
4684
|
+
#
|
4685
|
+
# @!attribute [rw] pipeline_parameter_list
|
4686
|
+
# List of Parameter names and values for SageMaker Model Building
|
4687
|
+
# Pipeline execution.
|
4688
|
+
# @return [Array<Types::SageMakerPipelineParameter>]
|
4689
|
+
#
|
4690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/SageMakerPipelineParameters AWS API Documentation
|
4691
|
+
#
|
4692
|
+
class SageMakerPipelineParameters < Struct.new(
|
4693
|
+
:pipeline_parameter_list)
|
4694
|
+
SENSITIVE = []
|
4695
|
+
include Aws::Structure
|
4696
|
+
end
|
4697
|
+
|
3114
4698
|
# This structure includes the custom parameter to be used when the
|
3115
4699
|
# target is an SQS FIFO queue.
|
3116
4700
|
#
|
@@ -3334,6 +4918,35 @@ module Aws::EventBridge
|
|
3334
4918
|
# },
|
3335
4919
|
# platform_version: "String",
|
3336
4920
|
# group: "String",
|
4921
|
+
# capacity_provider_strategy: [
|
4922
|
+
# {
|
4923
|
+
# capacity_provider: "CapacityProvider", # required
|
4924
|
+
# weight: 1,
|
4925
|
+
# base: 1,
|
4926
|
+
# },
|
4927
|
+
# ],
|
4928
|
+
# enable_ecs_managed_tags: false,
|
4929
|
+
# enable_execute_command: false,
|
4930
|
+
# placement_constraints: [
|
4931
|
+
# {
|
4932
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
4933
|
+
# expression: "PlacementConstraintExpression",
|
4934
|
+
# },
|
4935
|
+
# ],
|
4936
|
+
# placement_strategy: [
|
4937
|
+
# {
|
4938
|
+
# type: "random", # accepts random, spread, binpack
|
4939
|
+
# field: "PlacementStrategyField",
|
4940
|
+
# },
|
4941
|
+
# ],
|
4942
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
|
4943
|
+
# reference_id: "ReferenceId",
|
4944
|
+
# tags: [
|
4945
|
+
# {
|
4946
|
+
# key: "TagKey", # required
|
4947
|
+
# value: "TagValue", # required
|
4948
|
+
# },
|
4949
|
+
# ],
|
3337
4950
|
# },
|
3338
4951
|
# batch_parameters: {
|
3339
4952
|
# job_definition: "String", # required
|
@@ -3365,6 +4978,14 @@ module Aws::EventBridge
|
|
3365
4978
|
# statement_name: "StatementName",
|
3366
4979
|
# with_event: false,
|
3367
4980
|
# },
|
4981
|
+
# sage_maker_pipeline_parameters: {
|
4982
|
+
# pipeline_parameter_list: [
|
4983
|
+
# {
|
4984
|
+
# name: "SageMakerPipelineParameterName", # required
|
4985
|
+
# value: "SageMakerPipelineParameterValue", # required
|
4986
|
+
# },
|
4987
|
+
# ],
|
4988
|
+
# },
|
3368
4989
|
# dead_letter_config: {
|
3369
4990
|
# arn: "ResourceArn",
|
3370
4991
|
# },
|
@@ -3458,11 +5079,15 @@ module Aws::EventBridge
|
|
3458
5079
|
#
|
3459
5080
|
# @!attribute [rw] http_parameters
|
3460
5081
|
# 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
|
5082
|
+
# REST endpoint or EventBridge ApiDestination.
|
5083
|
+
#
|
5084
|
+
# If you specify an API Gateway REST API or EventBridge ApiDestination
|
5085
|
+
# as a target, you can use this parameter to specify headers, path
|
5086
|
+
# parameters, and query string keys/values as part of your target
|
5087
|
+
# invoking request. If you're using ApiDestinations, the
|
5088
|
+
# corresponding Connection can also have these values configured. In
|
5089
|
+
# case of any conflicting keys, values from the Connection take
|
5090
|
+
# precedence.
|
3466
5091
|
# @return [Types::HttpParameters]
|
3467
5092
|
#
|
3468
5093
|
# @!attribute [rw] redshift_data_parameters
|
@@ -3474,6 +5099,15 @@ module Aws::EventBridge
|
|
3474
5099
|
# based on EventBridge events.
|
3475
5100
|
# @return [Types::RedshiftDataParameters]
|
3476
5101
|
#
|
5102
|
+
# @!attribute [rw] sage_maker_pipeline_parameters
|
5103
|
+
# Contains the SageMaker Model Building Pipeline parameters to start
|
5104
|
+
# execution of a SageMaker Model Building Pipeline.
|
5105
|
+
#
|
5106
|
+
# If you specify a SageMaker Model Building Pipeline as a target, you
|
5107
|
+
# can use this to specify parameters to start a pipeline execution
|
5108
|
+
# based on EventBridge events.
|
5109
|
+
# @return [Types::SageMakerPipelineParameters]
|
5110
|
+
#
|
3477
5111
|
# @!attribute [rw] dead_letter_config
|
3478
5112
|
# The `DeadLetterConfig` that defines the target queue to send
|
3479
5113
|
# dead-letter queue events to.
|
@@ -3500,6 +5134,7 @@ module Aws::EventBridge
|
|
3500
5134
|
:sqs_parameters,
|
3501
5135
|
:http_parameters,
|
3502
5136
|
:redshift_data_parameters,
|
5137
|
+
:sage_maker_pipeline_parameters,
|
3503
5138
|
:dead_letter_config,
|
3504
5139
|
:retry_policy)
|
3505
5140
|
SENSITIVE = []
|
@@ -3598,6 +5233,84 @@ module Aws::EventBridge
|
|
3598
5233
|
#
|
3599
5234
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
3600
5235
|
|
5236
|
+
# @note When making an API call, you may pass UpdateApiDestinationRequest
|
5237
|
+
# data as a hash:
|
5238
|
+
#
|
5239
|
+
# {
|
5240
|
+
# name: "ApiDestinationName", # required
|
5241
|
+
# description: "ApiDestinationDescription",
|
5242
|
+
# connection_arn: "ConnectionArn",
|
5243
|
+
# invocation_endpoint: "HttpsEndpoint",
|
5244
|
+
# http_method: "POST", # accepts POST, GET, HEAD, OPTIONS, PUT, PATCH, DELETE
|
5245
|
+
# invocation_rate_limit_per_second: 1,
|
5246
|
+
# }
|
5247
|
+
#
|
5248
|
+
# @!attribute [rw] name
|
5249
|
+
# The name of the API destination to update.
|
5250
|
+
# @return [String]
|
5251
|
+
#
|
5252
|
+
# @!attribute [rw] description
|
5253
|
+
# The name of the API destination to update.
|
5254
|
+
# @return [String]
|
5255
|
+
#
|
5256
|
+
# @!attribute [rw] connection_arn
|
5257
|
+
# The ARN of the connection to use for the API destination.
|
5258
|
+
# @return [String]
|
5259
|
+
#
|
5260
|
+
# @!attribute [rw] invocation_endpoint
|
5261
|
+
# The URL to the endpoint to use for the API destination.
|
5262
|
+
# @return [String]
|
5263
|
+
#
|
5264
|
+
# @!attribute [rw] http_method
|
5265
|
+
# The method to use for the API destination.
|
5266
|
+
# @return [String]
|
5267
|
+
#
|
5268
|
+
# @!attribute [rw] invocation_rate_limit_per_second
|
5269
|
+
# The maximum number of invocations per second to send to the API
|
5270
|
+
# destination.
|
5271
|
+
# @return [Integer]
|
5272
|
+
#
|
5273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateApiDestinationRequest AWS API Documentation
|
5274
|
+
#
|
5275
|
+
class UpdateApiDestinationRequest < Struct.new(
|
5276
|
+
:name,
|
5277
|
+
:description,
|
5278
|
+
:connection_arn,
|
5279
|
+
:invocation_endpoint,
|
5280
|
+
:http_method,
|
5281
|
+
:invocation_rate_limit_per_second)
|
5282
|
+
SENSITIVE = []
|
5283
|
+
include Aws::Structure
|
5284
|
+
end
|
5285
|
+
|
5286
|
+
# @!attribute [rw] api_destination_arn
|
5287
|
+
# The ARN of the API destination that was updated.
|
5288
|
+
# @return [String]
|
5289
|
+
#
|
5290
|
+
# @!attribute [rw] api_destination_state
|
5291
|
+
# The state of the API destination that was updated.
|
5292
|
+
# @return [String]
|
5293
|
+
#
|
5294
|
+
# @!attribute [rw] creation_time
|
5295
|
+
# A time stamp for the time that the API destination was created.
|
5296
|
+
# @return [Time]
|
5297
|
+
#
|
5298
|
+
# @!attribute [rw] last_modified_time
|
5299
|
+
# A time stamp for the time that the API destination was last
|
5300
|
+
# modified.
|
5301
|
+
# @return [Time]
|
5302
|
+
#
|
5303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateApiDestinationResponse AWS API Documentation
|
5304
|
+
#
|
5305
|
+
class UpdateApiDestinationResponse < Struct.new(
|
5306
|
+
:api_destination_arn,
|
5307
|
+
:api_destination_state,
|
5308
|
+
:creation_time,
|
5309
|
+
:last_modified_time)
|
5310
|
+
SENSITIVE = []
|
5311
|
+
include Aws::Structure
|
5312
|
+
end
|
5313
|
+
|
3601
5314
|
# @note When making an API call, you may pass UpdateArchiveRequest
|
3602
5315
|
# data as a hash:
|
3603
5316
|
#
|
@@ -3662,5 +5375,390 @@ module Aws::EventBridge
|
|
3662
5375
|
include Aws::Structure
|
3663
5376
|
end
|
3664
5377
|
|
5378
|
+
# Contains the API key authorization parameters to use to update the
|
5379
|
+
# connection.
|
5380
|
+
#
|
5381
|
+
# @note When making an API call, you may pass UpdateConnectionApiKeyAuthRequestParameters
|
5382
|
+
# data as a hash:
|
5383
|
+
#
|
5384
|
+
# {
|
5385
|
+
# api_key_name: "AuthHeaderParameters",
|
5386
|
+
# api_key_value: "AuthHeaderParameters",
|
5387
|
+
# }
|
5388
|
+
#
|
5389
|
+
# @!attribute [rw] api_key_name
|
5390
|
+
# The name of the API key to use for authorization.
|
5391
|
+
# @return [String]
|
5392
|
+
#
|
5393
|
+
# @!attribute [rw] api_key_value
|
5394
|
+
# The value associated with teh API key to use for authorization.
|
5395
|
+
# @return [String]
|
5396
|
+
#
|
5397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionApiKeyAuthRequestParameters AWS API Documentation
|
5398
|
+
#
|
5399
|
+
class UpdateConnectionApiKeyAuthRequestParameters < Struct.new(
|
5400
|
+
:api_key_name,
|
5401
|
+
:api_key_value)
|
5402
|
+
SENSITIVE = []
|
5403
|
+
include Aws::Structure
|
5404
|
+
end
|
5405
|
+
|
5406
|
+
# Contains the additional parameters to use for the connection.
|
5407
|
+
#
|
5408
|
+
# @note When making an API call, you may pass UpdateConnectionAuthRequestParameters
|
5409
|
+
# data as a hash:
|
5410
|
+
#
|
5411
|
+
# {
|
5412
|
+
# basic_auth_parameters: {
|
5413
|
+
# username: "AuthHeaderParameters",
|
5414
|
+
# password: "AuthHeaderParameters",
|
5415
|
+
# },
|
5416
|
+
# o_auth_parameters: {
|
5417
|
+
# client_parameters: {
|
5418
|
+
# client_id: "AuthHeaderParameters",
|
5419
|
+
# client_secret: "AuthHeaderParameters",
|
5420
|
+
# },
|
5421
|
+
# authorization_endpoint: "HttpsEndpoint",
|
5422
|
+
# http_method: "GET", # accepts GET, POST, PUT
|
5423
|
+
# o_auth_http_parameters: {
|
5424
|
+
# header_parameters: [
|
5425
|
+
# {
|
5426
|
+
# key: "HeaderKey",
|
5427
|
+
# value: "HeaderValue",
|
5428
|
+
# is_value_secret: false,
|
5429
|
+
# },
|
5430
|
+
# ],
|
5431
|
+
# query_string_parameters: [
|
5432
|
+
# {
|
5433
|
+
# key: "QueryStringKey",
|
5434
|
+
# value: "QueryStringValue",
|
5435
|
+
# is_value_secret: false,
|
5436
|
+
# },
|
5437
|
+
# ],
|
5438
|
+
# body_parameters: [
|
5439
|
+
# {
|
5440
|
+
# key: "String",
|
5441
|
+
# value: "String",
|
5442
|
+
# is_value_secret: false,
|
5443
|
+
# },
|
5444
|
+
# ],
|
5445
|
+
# },
|
5446
|
+
# },
|
5447
|
+
# api_key_auth_parameters: {
|
5448
|
+
# api_key_name: "AuthHeaderParameters",
|
5449
|
+
# api_key_value: "AuthHeaderParameters",
|
5450
|
+
# },
|
5451
|
+
# invocation_http_parameters: {
|
5452
|
+
# header_parameters: [
|
5453
|
+
# {
|
5454
|
+
# key: "HeaderKey",
|
5455
|
+
# value: "HeaderValue",
|
5456
|
+
# is_value_secret: false,
|
5457
|
+
# },
|
5458
|
+
# ],
|
5459
|
+
# query_string_parameters: [
|
5460
|
+
# {
|
5461
|
+
# key: "QueryStringKey",
|
5462
|
+
# value: "QueryStringValue",
|
5463
|
+
# is_value_secret: false,
|
5464
|
+
# },
|
5465
|
+
# ],
|
5466
|
+
# body_parameters: [
|
5467
|
+
# {
|
5468
|
+
# key: "String",
|
5469
|
+
# value: "String",
|
5470
|
+
# is_value_secret: false,
|
5471
|
+
# },
|
5472
|
+
# ],
|
5473
|
+
# },
|
5474
|
+
# }
|
5475
|
+
#
|
5476
|
+
# @!attribute [rw] basic_auth_parameters
|
5477
|
+
# A `UpdateConnectionBasicAuthRequestParameters` object that contains
|
5478
|
+
# the authorization parameters for Basic authorization.
|
5479
|
+
# @return [Types::UpdateConnectionBasicAuthRequestParameters]
|
5480
|
+
#
|
5481
|
+
# @!attribute [rw] o_auth_parameters
|
5482
|
+
# A `UpdateConnectionOAuthRequestParameters` object that contains the
|
5483
|
+
# authorization parameters for OAuth authorization.
|
5484
|
+
# @return [Types::UpdateConnectionOAuthRequestParameters]
|
5485
|
+
#
|
5486
|
+
# @!attribute [rw] api_key_auth_parameters
|
5487
|
+
# A `UpdateConnectionApiKeyAuthRequestParameters` object that contains
|
5488
|
+
# the authorization parameters for API key authorization.
|
5489
|
+
# @return [Types::UpdateConnectionApiKeyAuthRequestParameters]
|
5490
|
+
#
|
5491
|
+
# @!attribute [rw] invocation_http_parameters
|
5492
|
+
# A `ConnectionHttpParameters` object that contains the additional
|
5493
|
+
# parameters to use for the connection.
|
5494
|
+
# @return [Types::ConnectionHttpParameters]
|
5495
|
+
#
|
5496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionAuthRequestParameters AWS API Documentation
|
5497
|
+
#
|
5498
|
+
class UpdateConnectionAuthRequestParameters < Struct.new(
|
5499
|
+
:basic_auth_parameters,
|
5500
|
+
:o_auth_parameters,
|
5501
|
+
:api_key_auth_parameters,
|
5502
|
+
:invocation_http_parameters)
|
5503
|
+
SENSITIVE = []
|
5504
|
+
include Aws::Structure
|
5505
|
+
end
|
5506
|
+
|
5507
|
+
# Contains the Basic authorization parameters for the connection.
|
5508
|
+
#
|
5509
|
+
# @note When making an API call, you may pass UpdateConnectionBasicAuthRequestParameters
|
5510
|
+
# data as a hash:
|
5511
|
+
#
|
5512
|
+
# {
|
5513
|
+
# username: "AuthHeaderParameters",
|
5514
|
+
# password: "AuthHeaderParameters",
|
5515
|
+
# }
|
5516
|
+
#
|
5517
|
+
# @!attribute [rw] username
|
5518
|
+
# The user name to use for Basic authorization.
|
5519
|
+
# @return [String]
|
5520
|
+
#
|
5521
|
+
# @!attribute [rw] password
|
5522
|
+
# The password associated with the user name to use for Basic
|
5523
|
+
# authorization.
|
5524
|
+
# @return [String]
|
5525
|
+
#
|
5526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionBasicAuthRequestParameters AWS API Documentation
|
5527
|
+
#
|
5528
|
+
class UpdateConnectionBasicAuthRequestParameters < Struct.new(
|
5529
|
+
:username,
|
5530
|
+
:password)
|
5531
|
+
SENSITIVE = []
|
5532
|
+
include Aws::Structure
|
5533
|
+
end
|
5534
|
+
|
5535
|
+
# Contains the OAuth authorization parameters to use for the connection.
|
5536
|
+
#
|
5537
|
+
# @note When making an API call, you may pass UpdateConnectionOAuthClientRequestParameters
|
5538
|
+
# data as a hash:
|
5539
|
+
#
|
5540
|
+
# {
|
5541
|
+
# client_id: "AuthHeaderParameters",
|
5542
|
+
# client_secret: "AuthHeaderParameters",
|
5543
|
+
# }
|
5544
|
+
#
|
5545
|
+
# @!attribute [rw] client_id
|
5546
|
+
# The client ID to use for OAuth authorization.
|
5547
|
+
# @return [String]
|
5548
|
+
#
|
5549
|
+
# @!attribute [rw] client_secret
|
5550
|
+
# The client secret assciated with the client ID to use for OAuth
|
5551
|
+
# authorization.
|
5552
|
+
# @return [String]
|
5553
|
+
#
|
5554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionOAuthClientRequestParameters AWS API Documentation
|
5555
|
+
#
|
5556
|
+
class UpdateConnectionOAuthClientRequestParameters < Struct.new(
|
5557
|
+
:client_id,
|
5558
|
+
:client_secret)
|
5559
|
+
SENSITIVE = []
|
5560
|
+
include Aws::Structure
|
5561
|
+
end
|
5562
|
+
|
5563
|
+
# Contains the OAuth request parameters to use for the connection.
|
5564
|
+
#
|
5565
|
+
# @note When making an API call, you may pass UpdateConnectionOAuthRequestParameters
|
5566
|
+
# data as a hash:
|
5567
|
+
#
|
5568
|
+
# {
|
5569
|
+
# client_parameters: {
|
5570
|
+
# client_id: "AuthHeaderParameters",
|
5571
|
+
# client_secret: "AuthHeaderParameters",
|
5572
|
+
# },
|
5573
|
+
# authorization_endpoint: "HttpsEndpoint",
|
5574
|
+
# http_method: "GET", # accepts GET, POST, PUT
|
5575
|
+
# o_auth_http_parameters: {
|
5576
|
+
# header_parameters: [
|
5577
|
+
# {
|
5578
|
+
# key: "HeaderKey",
|
5579
|
+
# value: "HeaderValue",
|
5580
|
+
# is_value_secret: false,
|
5581
|
+
# },
|
5582
|
+
# ],
|
5583
|
+
# query_string_parameters: [
|
5584
|
+
# {
|
5585
|
+
# key: "QueryStringKey",
|
5586
|
+
# value: "QueryStringValue",
|
5587
|
+
# is_value_secret: false,
|
5588
|
+
# },
|
5589
|
+
# ],
|
5590
|
+
# body_parameters: [
|
5591
|
+
# {
|
5592
|
+
# key: "String",
|
5593
|
+
# value: "String",
|
5594
|
+
# is_value_secret: false,
|
5595
|
+
# },
|
5596
|
+
# ],
|
5597
|
+
# },
|
5598
|
+
# }
|
5599
|
+
#
|
5600
|
+
# @!attribute [rw] client_parameters
|
5601
|
+
# A `UpdateConnectionOAuthClientRequestParameters` object that
|
5602
|
+
# contains the client parameters to use for the connection when OAuth
|
5603
|
+
# is specified as the authorization type.
|
5604
|
+
# @return [Types::UpdateConnectionOAuthClientRequestParameters]
|
5605
|
+
#
|
5606
|
+
# @!attribute [rw] authorization_endpoint
|
5607
|
+
# The URL to the authorization endpoint when OAuth is specified as the
|
5608
|
+
# authorization type.
|
5609
|
+
# @return [String]
|
5610
|
+
#
|
5611
|
+
# @!attribute [rw] http_method
|
5612
|
+
# The method used to connect to the HTTP endpoint.
|
5613
|
+
# @return [String]
|
5614
|
+
#
|
5615
|
+
# @!attribute [rw] o_auth_http_parameters
|
5616
|
+
# The additional HTTP parameters used for the OAuth authorization
|
5617
|
+
# request.
|
5618
|
+
# @return [Types::ConnectionHttpParameters]
|
5619
|
+
#
|
5620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionOAuthRequestParameters AWS API Documentation
|
5621
|
+
#
|
5622
|
+
class UpdateConnectionOAuthRequestParameters < Struct.new(
|
5623
|
+
:client_parameters,
|
5624
|
+
:authorization_endpoint,
|
5625
|
+
:http_method,
|
5626
|
+
:o_auth_http_parameters)
|
5627
|
+
SENSITIVE = []
|
5628
|
+
include Aws::Structure
|
5629
|
+
end
|
5630
|
+
|
5631
|
+
# @note When making an API call, you may pass UpdateConnectionRequest
|
5632
|
+
# data as a hash:
|
5633
|
+
#
|
5634
|
+
# {
|
5635
|
+
# name: "ConnectionName", # required
|
5636
|
+
# description: "ConnectionDescription",
|
5637
|
+
# authorization_type: "BASIC", # accepts BASIC, OAUTH_CLIENT_CREDENTIALS, API_KEY
|
5638
|
+
# auth_parameters: {
|
5639
|
+
# basic_auth_parameters: {
|
5640
|
+
# username: "AuthHeaderParameters",
|
5641
|
+
# password: "AuthHeaderParameters",
|
5642
|
+
# },
|
5643
|
+
# o_auth_parameters: {
|
5644
|
+
# client_parameters: {
|
5645
|
+
# client_id: "AuthHeaderParameters",
|
5646
|
+
# client_secret: "AuthHeaderParameters",
|
5647
|
+
# },
|
5648
|
+
# authorization_endpoint: "HttpsEndpoint",
|
5649
|
+
# http_method: "GET", # accepts GET, POST, PUT
|
5650
|
+
# o_auth_http_parameters: {
|
5651
|
+
# header_parameters: [
|
5652
|
+
# {
|
5653
|
+
# key: "HeaderKey",
|
5654
|
+
# value: "HeaderValue",
|
5655
|
+
# is_value_secret: false,
|
5656
|
+
# },
|
5657
|
+
# ],
|
5658
|
+
# query_string_parameters: [
|
5659
|
+
# {
|
5660
|
+
# key: "QueryStringKey",
|
5661
|
+
# value: "QueryStringValue",
|
5662
|
+
# is_value_secret: false,
|
5663
|
+
# },
|
5664
|
+
# ],
|
5665
|
+
# body_parameters: [
|
5666
|
+
# {
|
5667
|
+
# key: "String",
|
5668
|
+
# value: "String",
|
5669
|
+
# is_value_secret: false,
|
5670
|
+
# },
|
5671
|
+
# ],
|
5672
|
+
# },
|
5673
|
+
# },
|
5674
|
+
# api_key_auth_parameters: {
|
5675
|
+
# api_key_name: "AuthHeaderParameters",
|
5676
|
+
# api_key_value: "AuthHeaderParameters",
|
5677
|
+
# },
|
5678
|
+
# invocation_http_parameters: {
|
5679
|
+
# header_parameters: [
|
5680
|
+
# {
|
5681
|
+
# key: "HeaderKey",
|
5682
|
+
# value: "HeaderValue",
|
5683
|
+
# is_value_secret: false,
|
5684
|
+
# },
|
5685
|
+
# ],
|
5686
|
+
# query_string_parameters: [
|
5687
|
+
# {
|
5688
|
+
# key: "QueryStringKey",
|
5689
|
+
# value: "QueryStringValue",
|
5690
|
+
# is_value_secret: false,
|
5691
|
+
# },
|
5692
|
+
# ],
|
5693
|
+
# body_parameters: [
|
5694
|
+
# {
|
5695
|
+
# key: "String",
|
5696
|
+
# value: "String",
|
5697
|
+
# is_value_secret: false,
|
5698
|
+
# },
|
5699
|
+
# ],
|
5700
|
+
# },
|
5701
|
+
# },
|
5702
|
+
# }
|
5703
|
+
#
|
5704
|
+
# @!attribute [rw] name
|
5705
|
+
# The name of the connection to update.
|
5706
|
+
# @return [String]
|
5707
|
+
#
|
5708
|
+
# @!attribute [rw] description
|
5709
|
+
# A description for the connection.
|
5710
|
+
# @return [String]
|
5711
|
+
#
|
5712
|
+
# @!attribute [rw] authorization_type
|
5713
|
+
# The type of authorization to use for the connection.
|
5714
|
+
# @return [String]
|
5715
|
+
#
|
5716
|
+
# @!attribute [rw] auth_parameters
|
5717
|
+
# The authorization parameters to use for the connection.
|
5718
|
+
# @return [Types::UpdateConnectionAuthRequestParameters]
|
5719
|
+
#
|
5720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionRequest AWS API Documentation
|
5721
|
+
#
|
5722
|
+
class UpdateConnectionRequest < Struct.new(
|
5723
|
+
:name,
|
5724
|
+
:description,
|
5725
|
+
:authorization_type,
|
5726
|
+
:auth_parameters)
|
5727
|
+
SENSITIVE = []
|
5728
|
+
include Aws::Structure
|
5729
|
+
end
|
5730
|
+
|
5731
|
+
# @!attribute [rw] connection_arn
|
5732
|
+
# The ARN of the connection that was updated.
|
5733
|
+
# @return [String]
|
5734
|
+
#
|
5735
|
+
# @!attribute [rw] connection_state
|
5736
|
+
# The state of the connection that was updated.
|
5737
|
+
# @return [String]
|
5738
|
+
#
|
5739
|
+
# @!attribute [rw] creation_time
|
5740
|
+
# A time stamp for the time that the connection was created.
|
5741
|
+
# @return [Time]
|
5742
|
+
#
|
5743
|
+
# @!attribute [rw] last_modified_time
|
5744
|
+
# A time stamp for the time that the connection was last modified.
|
5745
|
+
# @return [Time]
|
5746
|
+
#
|
5747
|
+
# @!attribute [rw] last_authorized_time
|
5748
|
+
# A time stamp for the time that the connection was last authorized.
|
5749
|
+
# @return [Time]
|
5750
|
+
#
|
5751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateConnectionResponse AWS API Documentation
|
5752
|
+
#
|
5753
|
+
class UpdateConnectionResponse < Struct.new(
|
5754
|
+
:connection_arn,
|
5755
|
+
:connection_state,
|
5756
|
+
:creation_time,
|
5757
|
+
:last_modified_time,
|
5758
|
+
:last_authorized_time)
|
5759
|
+
SENSITIVE = []
|
5760
|
+
include Aws::Structure
|
5761
|
+
end
|
5762
|
+
|
3665
5763
|
end
|
3666
5764
|
end
|