aws-sdk-cloudwatchevents 1.33.0 → 1.64.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -27,7 +27,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
- require 'aws-sdk-core/plugins/signature_v4.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/request_compression.rb'
32
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
33
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
34
+ require 'aws-sdk-core/plugins/sign.rb'
31
35
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
32
36
 
33
37
  Aws::Plugins::GlobalConfiguration.add_identifier(:cloudwatchevents)
@@ -73,8 +77,13 @@ module Aws::CloudWatchEvents
73
77
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
78
  add_plugin(Aws::Plugins::TransferEncoding)
75
79
  add_plugin(Aws::Plugins::HttpChecksum)
76
- add_plugin(Aws::Plugins::SignatureV4)
80
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
81
+ add_plugin(Aws::Plugins::RequestCompression)
82
+ add_plugin(Aws::Plugins::DefaultsMode)
83
+ add_plugin(Aws::Plugins::RecursionDetection)
84
+ add_plugin(Aws::Plugins::Sign)
77
85
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
86
+ add_plugin(Aws::CloudWatchEvents::Plugins::Endpoints)
78
87
 
79
88
  # @overload initialize(options)
80
89
  # @param [Hash] options
@@ -85,13 +94,28 @@ module Aws::CloudWatchEvents
85
94
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
95
  # credentials.
87
96
  #
97
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
98
+ # shared file, such as `~/.aws/config`.
99
+ #
100
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
101
+ #
102
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
103
+ # assume a role after providing credentials via the web.
104
+ #
105
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
106
+ # access token generated from `aws login`.
107
+ #
108
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
109
+ # process that outputs to stdout.
110
+ #
88
111
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
112
  # from an EC2 IMDS on an EC2 instance.
90
113
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
114
+ # * `Aws::ECSCredentials` - Used for loading credentials from
115
+ # instances running in ECS.
93
116
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
117
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
118
+ # from the Cognito Identity service.
95
119
  #
96
120
  # When `:credentials` are not configured directly, the following
97
121
  # locations will be searched for credentials:
@@ -101,10 +125,12 @@ module Aws::CloudWatchEvents
101
125
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
126
  # * `~/.aws/credentials`
103
127
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
128
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
129
+ # are very aggressive. Construct and pass an instance of
130
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
131
+ # enable retries and extended timeouts. Instance profile credential
132
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
133
+ # to true.
108
134
  #
109
135
  # @option options [required, String] :region
110
136
  # The AWS region to connect to. The configured `:region` is
@@ -158,10 +184,18 @@ module Aws::CloudWatchEvents
158
184
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
159
185
  # a clock skew correction and retry requests with skewed client clocks.
160
186
  #
187
+ # @option options [String] :defaults_mode ("legacy")
188
+ # See {Aws::DefaultsModeConfiguration} for a list of the
189
+ # accepted modes and the configuration defaults that are included.
190
+ #
161
191
  # @option options [Boolean] :disable_host_prefix_injection (false)
162
192
  # Set to true to disable SDK automatically adding host prefix
163
193
  # to default service endpoint when available.
164
194
  #
195
+ # @option options [Boolean] :disable_request_compression (false)
196
+ # When set to 'true' the request body will not be compressed
197
+ # for supported operations.
198
+ #
165
199
  # @option options [String] :endpoint
166
200
  # The client endpoint is normally constructed from the `:region`
167
201
  # option. You should only configure an `:endpoint` when connecting
@@ -182,6 +216,10 @@ module Aws::CloudWatchEvents
182
216
  # @option options [Boolean] :endpoint_discovery (false)
183
217
  # When set to `true`, endpoint discovery will be enabled for operations when available.
184
218
  #
219
+ # @option options [Boolean] :ignore_configured_endpoint_urls
220
+ # Setting to true disables use of endpoint URLs provided via environment
221
+ # variables and the shared configuration file.
222
+ #
185
223
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
186
224
  # The log formatter.
187
225
  #
@@ -202,6 +240,11 @@ module Aws::CloudWatchEvents
202
240
  # Used when loading credentials from the shared credentials file
203
241
  # at HOME/.aws/credentials. When not specified, 'default' is used.
204
242
  #
243
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
244
+ # The minimum size in bytes that triggers compression for request
245
+ # bodies. The value must be non-negative integer value between 0
246
+ # and 10485780 bytes inclusive.
247
+ #
205
248
  # @option options [Proc] :retry_backoff
206
249
  # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
207
250
  # This option is only used in the `legacy` retry mode.
@@ -247,6 +290,11 @@ module Aws::CloudWatchEvents
247
290
  # in the future.
248
291
  #
249
292
  #
293
+ # @option options [String] :sdk_ua_app_id
294
+ # A unique and opaque application ID that is appended to the
295
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
296
+ # maximum length of 50.
297
+ #
250
298
  # @option options [String] :secret_access_key
251
299
  #
252
300
  # @option options [String] :session_token
@@ -270,10 +318,35 @@ module Aws::CloudWatchEvents
270
318
  # ** Please note ** When response stubbing is enabled, no HTTP
271
319
  # requests are made, and retries are disabled.
272
320
  #
321
+ # @option options [Aws::TokenProvider] :token_provider
322
+ # A Bearer Token Provider. This can be an instance of any one of the
323
+ # following classes:
324
+ #
325
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
326
+ # tokens.
327
+ #
328
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
329
+ # access token generated from `aws login`.
330
+ #
331
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
332
+ # will be used to search for tokens configured for your profile in shared configuration files.
333
+ #
334
+ # @option options [Boolean] :use_dualstack_endpoint
335
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
336
+ # will be used if available.
337
+ #
338
+ # @option options [Boolean] :use_fips_endpoint
339
+ # When set to `true`, fips compatible endpoints will be used if available.
340
+ # When a `fips` region is used, the region is normalized and this config
341
+ # is set to `true`.
342
+ #
273
343
  # @option options [Boolean] :validate_params (true)
274
344
  # When `true`, request parameters are validated before
275
345
  # sending the request.
276
346
  #
347
+ # @option options [Aws::CloudWatchEvents::EndpointProvider] :endpoint_provider
348
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CloudWatchEvents::EndpointParameters`
349
+ #
277
350
  # @option options [URI::HTTP,String] :http_proxy A proxy to send
278
351
  # requests through. Formatted like 'http://proxy.com:123'.
279
352
  #
@@ -281,7 +354,7 @@ module Aws::CloudWatchEvents
281
354
  # seconds to wait when opening a HTTP session before raising a
282
355
  # `Timeout::Error`.
283
356
  #
284
- # @option options [Integer] :http_read_timeout (60) The default
357
+ # @option options [Float] :http_read_timeout (60) The default
285
358
  # number of seconds to wait for response data. This value can
286
359
  # safely be set per-request on the session.
287
360
  #
@@ -297,6 +370,9 @@ module Aws::CloudWatchEvents
297
370
  # disables this behaviour. This value can safely be set per
298
371
  # request on the session.
299
372
  #
373
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
374
+ # in seconds.
375
+ #
300
376
  # @option options [Boolean] :http_wire_trace (false) When `true`,
301
377
  # HTTP debug output will be sent to the `:logger`.
302
378
  #
@@ -346,6 +422,264 @@ module Aws::CloudWatchEvents
346
422
  req.send_request(options)
347
423
  end
348
424
 
425
+ # Cancels the specified replay.
426
+ #
427
+ # @option params [required, String] :replay_name
428
+ # The name of the replay to cancel.
429
+ #
430
+ # @return [Types::CancelReplayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
431
+ #
432
+ # * {Types::CancelReplayResponse#replay_arn #replay_arn} => String
433
+ # * {Types::CancelReplayResponse#state #state} => String
434
+ # * {Types::CancelReplayResponse#state_reason #state_reason} => String
435
+ #
436
+ # @example Request syntax with placeholder values
437
+ #
438
+ # resp = client.cancel_replay({
439
+ # replay_name: "ReplayName", # required
440
+ # })
441
+ #
442
+ # @example Response structure
443
+ #
444
+ # resp.replay_arn #=> String
445
+ # resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
446
+ # resp.state_reason #=> String
447
+ #
448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CancelReplay AWS API Documentation
449
+ #
450
+ # @overload cancel_replay(params = {})
451
+ # @param [Hash] params ({})
452
+ def cancel_replay(params = {}, options = {})
453
+ req = build_request(:cancel_replay, params)
454
+ req.send_request(options)
455
+ end
456
+
457
+ # Creates an API destination, which is an HTTP invocation endpoint
458
+ # configured as a target for events.
459
+ #
460
+ # @option params [required, String] :name
461
+ # The name for the API destination to create.
462
+ #
463
+ # @option params [String] :description
464
+ # A description for the API destination to create.
465
+ #
466
+ # @option params [required, String] :connection_arn
467
+ # The ARN of the connection to use for the API destination. The
468
+ # destination endpoint must support the authorization type specified for
469
+ # the connection.
470
+ #
471
+ # @option params [required, String] :invocation_endpoint
472
+ # The URL to the HTTP invocation endpoint for the API destination.
473
+ #
474
+ # @option params [required, String] :http_method
475
+ # The method to use for the request to the HTTP invocation endpoint.
476
+ #
477
+ # @option params [Integer] :invocation_rate_limit_per_second
478
+ # The maximum number of requests per second to send to the HTTP
479
+ # invocation endpoint.
480
+ #
481
+ # @return [Types::CreateApiDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
482
+ #
483
+ # * {Types::CreateApiDestinationResponse#api_destination_arn #api_destination_arn} => String
484
+ # * {Types::CreateApiDestinationResponse#api_destination_state #api_destination_state} => String
485
+ # * {Types::CreateApiDestinationResponse#creation_time #creation_time} => Time
486
+ # * {Types::CreateApiDestinationResponse#last_modified_time #last_modified_time} => Time
487
+ #
488
+ # @example Request syntax with placeholder values
489
+ #
490
+ # resp = client.create_api_destination({
491
+ # name: "ApiDestinationName", # required
492
+ # description: "ApiDestinationDescription",
493
+ # connection_arn: "ConnectionArn", # required
494
+ # invocation_endpoint: "HttpsEndpoint", # required
495
+ # http_method: "POST", # required, accepts POST, GET, HEAD, OPTIONS, PUT, PATCH, DELETE
496
+ # invocation_rate_limit_per_second: 1,
497
+ # })
498
+ #
499
+ # @example Response structure
500
+ #
501
+ # resp.api_destination_arn #=> String
502
+ # resp.api_destination_state #=> String, one of "ACTIVE", "INACTIVE"
503
+ # resp.creation_time #=> Time
504
+ # resp.last_modified_time #=> Time
505
+ #
506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateApiDestination AWS API Documentation
507
+ #
508
+ # @overload create_api_destination(params = {})
509
+ # @param [Hash] params ({})
510
+ def create_api_destination(params = {}, options = {})
511
+ req = build_request(:create_api_destination, params)
512
+ req.send_request(options)
513
+ end
514
+
515
+ # Creates an archive of events with the specified settings. When you
516
+ # create an archive, incoming events might not immediately start being
517
+ # sent to the archive. Allow a short period of time for changes to take
518
+ # effect. If you do not specify a pattern to filter events sent to the
519
+ # archive, all events are sent to the archive except replayed events.
520
+ # Replayed events are not sent to an archive.
521
+ #
522
+ # @option params [required, String] :archive_name
523
+ # The name for the archive to create.
524
+ #
525
+ # @option params [required, String] :event_source_arn
526
+ # The ARN of the event bus that sends events to the archive.
527
+ #
528
+ # @option params [String] :description
529
+ # A description for the archive.
530
+ #
531
+ # @option params [String] :event_pattern
532
+ # An event pattern to use to filter events sent to the archive.
533
+ #
534
+ # @option params [Integer] :retention_days
535
+ # The number of days to retain events for. Default value is 0. If set to
536
+ # 0, events are retained indefinitely
537
+ #
538
+ # @return [Types::CreateArchiveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
539
+ #
540
+ # * {Types::CreateArchiveResponse#archive_arn #archive_arn} => String
541
+ # * {Types::CreateArchiveResponse#state #state} => String
542
+ # * {Types::CreateArchiveResponse#state_reason #state_reason} => String
543
+ # * {Types::CreateArchiveResponse#creation_time #creation_time} => Time
544
+ #
545
+ # @example Request syntax with placeholder values
546
+ #
547
+ # resp = client.create_archive({
548
+ # archive_name: "ArchiveName", # required
549
+ # event_source_arn: "Arn", # required
550
+ # description: "ArchiveDescription",
551
+ # event_pattern: "EventPattern",
552
+ # retention_days: 1,
553
+ # })
554
+ #
555
+ # @example Response structure
556
+ #
557
+ # resp.archive_arn #=> String
558
+ # resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
559
+ # resp.state_reason #=> String
560
+ # resp.creation_time #=> Time
561
+ #
562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateArchive AWS API Documentation
563
+ #
564
+ # @overload create_archive(params = {})
565
+ # @param [Hash] params ({})
566
+ def create_archive(params = {}, options = {})
567
+ req = build_request(:create_archive, params)
568
+ req.send_request(options)
569
+ end
570
+
571
+ # Creates a connection. A connection defines the authorization type and
572
+ # credentials to use for authorization with an API destination HTTP
573
+ # endpoint.
574
+ #
575
+ # @option params [required, String] :name
576
+ # The name for the connection to create.
577
+ #
578
+ # @option params [String] :description
579
+ # A description for the connection to create.
580
+ #
581
+ # @option params [required, String] :authorization_type
582
+ # The type of authorization to use for the connection.
583
+ #
584
+ # @option params [required, Types::CreateConnectionAuthRequestParameters] :auth_parameters
585
+ # A `CreateConnectionAuthRequestParameters` object that contains the
586
+ # authorization parameters to use to authorize with the endpoint.
587
+ #
588
+ # @return [Types::CreateConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
589
+ #
590
+ # * {Types::CreateConnectionResponse#connection_arn #connection_arn} => String
591
+ # * {Types::CreateConnectionResponse#connection_state #connection_state} => String
592
+ # * {Types::CreateConnectionResponse#creation_time #creation_time} => Time
593
+ # * {Types::CreateConnectionResponse#last_modified_time #last_modified_time} => Time
594
+ #
595
+ # @example Request syntax with placeholder values
596
+ #
597
+ # resp = client.create_connection({
598
+ # name: "ConnectionName", # required
599
+ # description: "ConnectionDescription",
600
+ # authorization_type: "BASIC", # required, accepts BASIC, OAUTH_CLIENT_CREDENTIALS, API_KEY
601
+ # auth_parameters: { # required
602
+ # basic_auth_parameters: {
603
+ # username: "AuthHeaderParameters", # required
604
+ # password: "AuthHeaderParameters", # required
605
+ # },
606
+ # o_auth_parameters: {
607
+ # client_parameters: { # required
608
+ # client_id: "AuthHeaderParameters", # required
609
+ # client_secret: "AuthHeaderParameters", # required
610
+ # },
611
+ # authorization_endpoint: "HttpsEndpoint", # required
612
+ # http_method: "GET", # required, accepts GET, POST, PUT
613
+ # o_auth_http_parameters: {
614
+ # header_parameters: [
615
+ # {
616
+ # key: "HeaderKey",
617
+ # value: "HeaderValue",
618
+ # is_value_secret: false,
619
+ # },
620
+ # ],
621
+ # query_string_parameters: [
622
+ # {
623
+ # key: "QueryStringKey",
624
+ # value: "QueryStringValue",
625
+ # is_value_secret: false,
626
+ # },
627
+ # ],
628
+ # body_parameters: [
629
+ # {
630
+ # key: "String",
631
+ # value: "String",
632
+ # is_value_secret: false,
633
+ # },
634
+ # ],
635
+ # },
636
+ # },
637
+ # api_key_auth_parameters: {
638
+ # api_key_name: "AuthHeaderParameters", # required
639
+ # api_key_value: "AuthHeaderParameters", # required
640
+ # },
641
+ # invocation_http_parameters: {
642
+ # header_parameters: [
643
+ # {
644
+ # key: "HeaderKey",
645
+ # value: "HeaderValue",
646
+ # is_value_secret: false,
647
+ # },
648
+ # ],
649
+ # query_string_parameters: [
650
+ # {
651
+ # key: "QueryStringKey",
652
+ # value: "QueryStringValue",
653
+ # is_value_secret: false,
654
+ # },
655
+ # ],
656
+ # body_parameters: [
657
+ # {
658
+ # key: "String",
659
+ # value: "String",
660
+ # is_value_secret: false,
661
+ # },
662
+ # ],
663
+ # },
664
+ # },
665
+ # })
666
+ #
667
+ # @example Response structure
668
+ #
669
+ # resp.connection_arn #=> String
670
+ # resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
671
+ # resp.creation_time #=> Time
672
+ # resp.last_modified_time #=> Time
673
+ #
674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateConnection AWS API Documentation
675
+ #
676
+ # @overload create_connection(params = {})
677
+ # @param [Hash] params ({})
678
+ def create_connection(params = {}, options = {})
679
+ req = build_request(:create_connection, params)
680
+ req.send_request(options)
681
+ end
682
+
349
683
  # Creates a new event bus within your account. This can be a custom
350
684
  # event bus which you can use to receive events from your custom
351
685
  # applications and services, or it can be a partner event bus which can
@@ -399,43 +733,45 @@ module Aws::CloudWatchEvents
399
733
  end
400
734
 
401
735
  # Called by an SaaS partner to create a partner event source. This
402
- # operation is not used by AWS customers.
736
+ # operation is not used by Amazon Web Services customers.
403
737
  #
404
- # Each partner event source can be used by one AWS account to create a
405
- # matching partner event bus in that AWS account. A SaaS partner must
406
- # create one partner event source for each AWS account that wants to
407
- # receive those event types.
738
+ # Each partner event source can be used by one Amazon Web Services
739
+ # account to create a matching partner event bus in that Amazon Web
740
+ # Services account. A SaaS partner must create one partner event source
741
+ # for each Amazon Web Services account that wants to receive those event
742
+ # types.
408
743
  #
409
744
  # A partner event source creates events based on resources within the
410
745
  # SaaS partner's service or application.
411
746
  #
412
- # An AWS account that creates a partner event bus that matches the
413
- # partner event source can use that event bus to receive events from the
414
- # partner, and then process them using AWS Events rules and targets.
747
+ # An Amazon Web Services account that creates a partner event bus that
748
+ # matches the partner event source can use that event bus to receive
749
+ # events from the partner, and then process them using Amazon Web
750
+ # Services Events rules and targets.
415
751
  #
416
752
  # Partner event source names follow this format:
417
753
  #
418
754
  # ` partner_name/event_namespace/event_name `
419
755
  #
420
756
  # *partner\_name* is determined during partner registration and
421
- # identifies the partner to AWS customers. *event\_namespace* is
422
- # determined by the partner and is a way for the partner to categorize
423
- # their events. *event\_name* is determined by the partner, and should
424
- # uniquely identify an event-generating resource within the partner
425
- # system. The combination of *event\_namespace* and *event\_name* should
426
- # help AWS customers decide whether to create an event bus to receive
427
- # these events.
757
+ # identifies the partner to Amazon Web Services customers.
758
+ # *event\_namespace* is determined by the partner and is a way for the
759
+ # partner to categorize their events. *event\_name* is determined by the
760
+ # partner, and should uniquely identify an event-generating resource
761
+ # within the partner system. The combination of *event\_namespace* and
762
+ # *event\_name* should help Amazon Web Services customers decide whether
763
+ # to create an event bus to receive these events.
428
764
  #
429
765
  # @option params [required, String] :name
430
766
  # The name of the partner event source. This name must be unique and
431
767
  # must be in the format ` partner_name/event_namespace/event_name `. The
432
- # AWS account that wants to use this partner event source must create a
433
- # partner event bus with a name that matches the name of the partner
434
- # event source.
768
+ # Amazon Web Services account that wants to use this partner event
769
+ # source must create a partner event bus with a name that matches the
770
+ # name of the partner event source.
435
771
  #
436
772
  # @option params [required, String] :account
437
- # The AWS account ID that is permitted to create a matching partner
438
- # event bus for this partner event source.
773
+ # The Amazon Web Services account ID that is permitted to create a
774
+ # matching partner event bus for this partner event source.
439
775
  #
440
776
  # @return [Types::CreatePartnerEventSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
441
777
  #
@@ -470,7 +806,11 @@ module Aws::CloudWatchEvents
470
806
  # it is deleted.
471
807
  #
472
808
  # To activate a deactivated partner event source, use
473
- # ActivateEventSource.
809
+ # [ActivateEventSource][1].
810
+ #
811
+ #
812
+ #
813
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html
474
814
  #
475
815
  # @option params [required, String] :name
476
816
  # The name of the partner event source to deactivate.
@@ -492,6 +832,124 @@ module Aws::CloudWatchEvents
492
832
  req.send_request(options)
493
833
  end
494
834
 
835
+ # Removes all authorization parameters from the connection. This lets
836
+ # you remove the secret from the connection so you can reuse it without
837
+ # having to create a new connection.
838
+ #
839
+ # @option params [required, String] :name
840
+ # The name of the connection to remove authorization from.
841
+ #
842
+ # @return [Types::DeauthorizeConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
843
+ #
844
+ # * {Types::DeauthorizeConnectionResponse#connection_arn #connection_arn} => String
845
+ # * {Types::DeauthorizeConnectionResponse#connection_state #connection_state} => String
846
+ # * {Types::DeauthorizeConnectionResponse#creation_time #creation_time} => Time
847
+ # * {Types::DeauthorizeConnectionResponse#last_modified_time #last_modified_time} => Time
848
+ # * {Types::DeauthorizeConnectionResponse#last_authorized_time #last_authorized_time} => Time
849
+ #
850
+ # @example Request syntax with placeholder values
851
+ #
852
+ # resp = client.deauthorize_connection({
853
+ # name: "ConnectionName", # required
854
+ # })
855
+ #
856
+ # @example Response structure
857
+ #
858
+ # resp.connection_arn #=> String
859
+ # resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
860
+ # resp.creation_time #=> Time
861
+ # resp.last_modified_time #=> Time
862
+ # resp.last_authorized_time #=> Time
863
+ #
864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeauthorizeConnection AWS API Documentation
865
+ #
866
+ # @overload deauthorize_connection(params = {})
867
+ # @param [Hash] params ({})
868
+ def deauthorize_connection(params = {}, options = {})
869
+ req = build_request(:deauthorize_connection, params)
870
+ req.send_request(options)
871
+ end
872
+
873
+ # Deletes the specified API destination.
874
+ #
875
+ # @option params [required, String] :name
876
+ # The name of the destination to delete.
877
+ #
878
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
879
+ #
880
+ # @example Request syntax with placeholder values
881
+ #
882
+ # resp = client.delete_api_destination({
883
+ # name: "ApiDestinationName", # required
884
+ # })
885
+ #
886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteApiDestination AWS API Documentation
887
+ #
888
+ # @overload delete_api_destination(params = {})
889
+ # @param [Hash] params ({})
890
+ def delete_api_destination(params = {}, options = {})
891
+ req = build_request(:delete_api_destination, params)
892
+ req.send_request(options)
893
+ end
894
+
895
+ # Deletes the specified archive.
896
+ #
897
+ # @option params [required, String] :archive_name
898
+ # The name of the archive to delete.
899
+ #
900
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
901
+ #
902
+ # @example Request syntax with placeholder values
903
+ #
904
+ # resp = client.delete_archive({
905
+ # archive_name: "ArchiveName", # required
906
+ # })
907
+ #
908
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteArchive AWS API Documentation
909
+ #
910
+ # @overload delete_archive(params = {})
911
+ # @param [Hash] params ({})
912
+ def delete_archive(params = {}, options = {})
913
+ req = build_request(:delete_archive, params)
914
+ req.send_request(options)
915
+ end
916
+
917
+ # Deletes a connection.
918
+ #
919
+ # @option params [required, String] :name
920
+ # The name of the connection to delete.
921
+ #
922
+ # @return [Types::DeleteConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
923
+ #
924
+ # * {Types::DeleteConnectionResponse#connection_arn #connection_arn} => String
925
+ # * {Types::DeleteConnectionResponse#connection_state #connection_state} => String
926
+ # * {Types::DeleteConnectionResponse#creation_time #creation_time} => Time
927
+ # * {Types::DeleteConnectionResponse#last_modified_time #last_modified_time} => Time
928
+ # * {Types::DeleteConnectionResponse#last_authorized_time #last_authorized_time} => Time
929
+ #
930
+ # @example Request syntax with placeholder values
931
+ #
932
+ # resp = client.delete_connection({
933
+ # name: "ConnectionName", # required
934
+ # })
935
+ #
936
+ # @example Response structure
937
+ #
938
+ # resp.connection_arn #=> String
939
+ # resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
940
+ # resp.creation_time #=> Time
941
+ # resp.last_modified_time #=> Time
942
+ # resp.last_authorized_time #=> Time
943
+ #
944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteConnection AWS API Documentation
945
+ #
946
+ # @overload delete_connection(params = {})
947
+ # @param [Hash] params ({})
948
+ def delete_connection(params = {}, options = {})
949
+ req = build_request(:delete_connection, params)
950
+ req.send_request(options)
951
+ end
952
+
495
953
  # Deletes the specified custom event bus or partner event bus. All rules
496
954
  # associated with this event bus need to be deleted. You can't delete
497
955
  # your account's default event bus.
@@ -517,17 +975,18 @@ module Aws::CloudWatchEvents
517
975
  end
518
976
 
519
977
  # This operation is used by SaaS partners to delete a partner event
520
- # source. This operation is not used by AWS customers.
978
+ # source. This operation is not used by Amazon Web Services customers.
521
979
  #
522
980
  # When you delete an event source, the status of the corresponding
523
- # partner event bus in the AWS customer account becomes DELETED.
981
+ # partner event bus in the Amazon Web Services customer account becomes
982
+ # DELETED.
524
983
  #
525
984
  # @option params [required, String] :name
526
985
  # The name of the event source to delete.
527
986
  #
528
987
  # @option params [required, String] :account
529
- # The AWS account ID of the AWS customer that the event source was
530
- # created for.
988
+ # The Amazon Web Services account ID of the Amazon Web Services customer
989
+ # that the event source was created for.
531
990
  #
532
991
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
533
992
  #
@@ -550,30 +1009,39 @@ module Aws::CloudWatchEvents
550
1009
  # Deletes the specified rule.
551
1010
  #
552
1011
  # Before you can delete the rule, you must remove all targets, using
553
- # RemoveTargets.
1012
+ # [RemoveTargets][1].
554
1013
  #
555
1014
  # When you delete a rule, incoming events might continue to match to the
556
1015
  # deleted rule. Allow a short period of time for changes to take effect.
557
1016
  #
558
- # Managed rules are rules created and managed by another AWS service on
559
- # your behalf. These rules are created by those other AWS services to
560
- # support functionality in those services. You can delete these rules
561
- # using the `Force` option, but you should do so only if you are sure
562
- # the other service is not still using that rule.
1017
+ # If you call delete rule multiple times for the same rule, all calls
1018
+ # will succeed. When you call delete rule for a non-existent custom
1019
+ # eventbus, `ResourceNotFoundException` is returned.
1020
+ #
1021
+ # Managed rules are rules created and managed by another Amazon Web
1022
+ # Services service on your behalf. These rules are created by those
1023
+ # other Amazon Web Services services to support functionality in those
1024
+ # services. You can delete these rules using the `Force` option, but you
1025
+ # should do so only if you are sure the other service is not still using
1026
+ # that rule.
1027
+ #
1028
+ #
1029
+ #
1030
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html
563
1031
  #
564
1032
  # @option params [required, String] :name
565
1033
  # The name of the rule.
566
1034
  #
567
1035
  # @option params [String] :event_bus_name
568
- # The event bus associated with the rule. If you omit this, the default
569
- # event bus is used.
1036
+ # The name or ARN of the event bus associated with the rule. If you omit
1037
+ # this, the default event bus is used.
570
1038
  #
571
1039
  # @option params [Boolean] :force
572
- # If this is a managed rule, created by an AWS service on your behalf,
573
- # you must specify `Force` as `True` to delete the rule. This parameter
574
- # is ignored for rules that are not managed rules. You can check whether
575
- # a rule is a managed rule by using `DescribeRule` or `ListRules` and
576
- # checking the `ManagedBy` field of the response.
1040
+ # If this is a managed rule, created by an Amazon Web Services service
1041
+ # on your behalf, you must specify `Force` as `True` to delete the rule.
1042
+ # This parameter is ignored for rules that are not managed rules. You
1043
+ # can check whether a rule is a managed rule by using `DescribeRule` or
1044
+ # `ListRules` and checking the `ManagedBy` field of the response.
577
1045
  #
578
1046
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
579
1047
  #
@@ -581,7 +1049,7 @@ module Aws::CloudWatchEvents
581
1049
  #
582
1050
  # resp = client.delete_rule({
583
1051
  # name: "RuleName", # required
584
- # event_bus_name: "EventBusName",
1052
+ # event_bus_name: "EventBusNameOrArn",
585
1053
  # force: false,
586
1054
  # })
587
1055
  #
@@ -594,20 +1062,196 @@ module Aws::CloudWatchEvents
594
1062
  req.send_request(options)
595
1063
  end
596
1064
 
1065
+ # Retrieves details about an API destination.
1066
+ #
1067
+ # @option params [required, String] :name
1068
+ # The name of the API destination to retrieve.
1069
+ #
1070
+ # @return [Types::DescribeApiDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1071
+ #
1072
+ # * {Types::DescribeApiDestinationResponse#api_destination_arn #api_destination_arn} => String
1073
+ # * {Types::DescribeApiDestinationResponse#name #name} => String
1074
+ # * {Types::DescribeApiDestinationResponse#description #description} => String
1075
+ # * {Types::DescribeApiDestinationResponse#api_destination_state #api_destination_state} => String
1076
+ # * {Types::DescribeApiDestinationResponse#connection_arn #connection_arn} => String
1077
+ # * {Types::DescribeApiDestinationResponse#invocation_endpoint #invocation_endpoint} => String
1078
+ # * {Types::DescribeApiDestinationResponse#http_method #http_method} => String
1079
+ # * {Types::DescribeApiDestinationResponse#invocation_rate_limit_per_second #invocation_rate_limit_per_second} => Integer
1080
+ # * {Types::DescribeApiDestinationResponse#creation_time #creation_time} => Time
1081
+ # * {Types::DescribeApiDestinationResponse#last_modified_time #last_modified_time} => Time
1082
+ #
1083
+ # @example Request syntax with placeholder values
1084
+ #
1085
+ # resp = client.describe_api_destination({
1086
+ # name: "ApiDestinationName", # required
1087
+ # })
1088
+ #
1089
+ # @example Response structure
1090
+ #
1091
+ # resp.api_destination_arn #=> String
1092
+ # resp.name #=> String
1093
+ # resp.description #=> String
1094
+ # resp.api_destination_state #=> String, one of "ACTIVE", "INACTIVE"
1095
+ # resp.connection_arn #=> String
1096
+ # resp.invocation_endpoint #=> String
1097
+ # resp.http_method #=> String, one of "POST", "GET", "HEAD", "OPTIONS", "PUT", "PATCH", "DELETE"
1098
+ # resp.invocation_rate_limit_per_second #=> Integer
1099
+ # resp.creation_time #=> Time
1100
+ # resp.last_modified_time #=> Time
1101
+ #
1102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeApiDestination AWS API Documentation
1103
+ #
1104
+ # @overload describe_api_destination(params = {})
1105
+ # @param [Hash] params ({})
1106
+ def describe_api_destination(params = {}, options = {})
1107
+ req = build_request(:describe_api_destination, params)
1108
+ req.send_request(options)
1109
+ end
1110
+
1111
+ # Retrieves details about an archive.
1112
+ #
1113
+ # @option params [required, String] :archive_name
1114
+ # The name of the archive to retrieve.
1115
+ #
1116
+ # @return [Types::DescribeArchiveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1117
+ #
1118
+ # * {Types::DescribeArchiveResponse#archive_arn #archive_arn} => String
1119
+ # * {Types::DescribeArchiveResponse#archive_name #archive_name} => String
1120
+ # * {Types::DescribeArchiveResponse#event_source_arn #event_source_arn} => String
1121
+ # * {Types::DescribeArchiveResponse#description #description} => String
1122
+ # * {Types::DescribeArchiveResponse#event_pattern #event_pattern} => String
1123
+ # * {Types::DescribeArchiveResponse#state #state} => String
1124
+ # * {Types::DescribeArchiveResponse#state_reason #state_reason} => String
1125
+ # * {Types::DescribeArchiveResponse#retention_days #retention_days} => Integer
1126
+ # * {Types::DescribeArchiveResponse#size_bytes #size_bytes} => Integer
1127
+ # * {Types::DescribeArchiveResponse#event_count #event_count} => Integer
1128
+ # * {Types::DescribeArchiveResponse#creation_time #creation_time} => Time
1129
+ #
1130
+ # @example Request syntax with placeholder values
1131
+ #
1132
+ # resp = client.describe_archive({
1133
+ # archive_name: "ArchiveName", # required
1134
+ # })
1135
+ #
1136
+ # @example Response structure
1137
+ #
1138
+ # resp.archive_arn #=> String
1139
+ # resp.archive_name #=> String
1140
+ # resp.event_source_arn #=> String
1141
+ # resp.description #=> String
1142
+ # resp.event_pattern #=> String
1143
+ # resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
1144
+ # resp.state_reason #=> String
1145
+ # resp.retention_days #=> Integer
1146
+ # resp.size_bytes #=> Integer
1147
+ # resp.event_count #=> Integer
1148
+ # resp.creation_time #=> Time
1149
+ #
1150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeArchive AWS API Documentation
1151
+ #
1152
+ # @overload describe_archive(params = {})
1153
+ # @param [Hash] params ({})
1154
+ def describe_archive(params = {}, options = {})
1155
+ req = build_request(:describe_archive, params)
1156
+ req.send_request(options)
1157
+ end
1158
+
1159
+ # Retrieves details about a connection.
1160
+ #
1161
+ # @option params [required, String] :name
1162
+ # The name of the connection to retrieve.
1163
+ #
1164
+ # @return [Types::DescribeConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1165
+ #
1166
+ # * {Types::DescribeConnectionResponse#connection_arn #connection_arn} => String
1167
+ # * {Types::DescribeConnectionResponse#name #name} => String
1168
+ # * {Types::DescribeConnectionResponse#description #description} => String
1169
+ # * {Types::DescribeConnectionResponse#connection_state #connection_state} => String
1170
+ # * {Types::DescribeConnectionResponse#state_reason #state_reason} => String
1171
+ # * {Types::DescribeConnectionResponse#authorization_type #authorization_type} => String
1172
+ # * {Types::DescribeConnectionResponse#secret_arn #secret_arn} => String
1173
+ # * {Types::DescribeConnectionResponse#auth_parameters #auth_parameters} => Types::ConnectionAuthResponseParameters
1174
+ # * {Types::DescribeConnectionResponse#creation_time #creation_time} => Time
1175
+ # * {Types::DescribeConnectionResponse#last_modified_time #last_modified_time} => Time
1176
+ # * {Types::DescribeConnectionResponse#last_authorized_time #last_authorized_time} => Time
1177
+ #
1178
+ # @example Request syntax with placeholder values
1179
+ #
1180
+ # resp = client.describe_connection({
1181
+ # name: "ConnectionName", # required
1182
+ # })
1183
+ #
1184
+ # @example Response structure
1185
+ #
1186
+ # resp.connection_arn #=> String
1187
+ # resp.name #=> String
1188
+ # resp.description #=> String
1189
+ # resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
1190
+ # resp.state_reason #=> String
1191
+ # resp.authorization_type #=> String, one of "BASIC", "OAUTH_CLIENT_CREDENTIALS", "API_KEY"
1192
+ # resp.secret_arn #=> String
1193
+ # resp.auth_parameters.basic_auth_parameters.username #=> String
1194
+ # resp.auth_parameters.o_auth_parameters.client_parameters.client_id #=> String
1195
+ # resp.auth_parameters.o_auth_parameters.authorization_endpoint #=> String
1196
+ # resp.auth_parameters.o_auth_parameters.http_method #=> String, one of "GET", "POST", "PUT"
1197
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters #=> Array
1198
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[0].key #=> String
1199
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[0].value #=> String
1200
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[0].is_value_secret #=> Boolean
1201
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters #=> Array
1202
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[0].key #=> String
1203
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[0].value #=> String
1204
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[0].is_value_secret #=> Boolean
1205
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters #=> Array
1206
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[0].key #=> String
1207
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[0].value #=> String
1208
+ # resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[0].is_value_secret #=> Boolean
1209
+ # resp.auth_parameters.api_key_auth_parameters.api_key_name #=> String
1210
+ # resp.auth_parameters.invocation_http_parameters.header_parameters #=> Array
1211
+ # resp.auth_parameters.invocation_http_parameters.header_parameters[0].key #=> String
1212
+ # resp.auth_parameters.invocation_http_parameters.header_parameters[0].value #=> String
1213
+ # resp.auth_parameters.invocation_http_parameters.header_parameters[0].is_value_secret #=> Boolean
1214
+ # resp.auth_parameters.invocation_http_parameters.query_string_parameters #=> Array
1215
+ # resp.auth_parameters.invocation_http_parameters.query_string_parameters[0].key #=> String
1216
+ # resp.auth_parameters.invocation_http_parameters.query_string_parameters[0].value #=> String
1217
+ # resp.auth_parameters.invocation_http_parameters.query_string_parameters[0].is_value_secret #=> Boolean
1218
+ # resp.auth_parameters.invocation_http_parameters.body_parameters #=> Array
1219
+ # resp.auth_parameters.invocation_http_parameters.body_parameters[0].key #=> String
1220
+ # resp.auth_parameters.invocation_http_parameters.body_parameters[0].value #=> String
1221
+ # resp.auth_parameters.invocation_http_parameters.body_parameters[0].is_value_secret #=> Boolean
1222
+ # resp.creation_time #=> Time
1223
+ # resp.last_modified_time #=> Time
1224
+ # resp.last_authorized_time #=> Time
1225
+ #
1226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeConnection AWS API Documentation
1227
+ #
1228
+ # @overload describe_connection(params = {})
1229
+ # @param [Hash] params ({})
1230
+ def describe_connection(params = {}, options = {})
1231
+ req = build_request(:describe_connection, params)
1232
+ req.send_request(options)
1233
+ end
1234
+
597
1235
  # Displays details about an event bus in your account. This can include
598
- # the external AWS accounts that are permitted to write events to your
599
- # default event bus, and the associated policy. For custom event buses
600
- # and partner event buses, it displays the name, ARN, policy, state, and
601
- # creation time.
1236
+ # the external Amazon Web Services accounts that are permitted to write
1237
+ # events to your default event bus, and the associated policy. For
1238
+ # custom event buses and partner event buses, it displays the name, ARN,
1239
+ # policy, state, and creation time.
602
1240
  #
603
1241
  # To enable your account to receive events from other accounts on its
604
- # default event bus, use PutPermission.
1242
+ # default event bus, use [PutPermission][1].
1243
+ #
1244
+ # For more information about partner event buses, see
1245
+ # [CreateEventBus][2].
1246
+ #
605
1247
  #
606
- # For more information about partner event buses, see CreateEventBus.
1248
+ #
1249
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html
1250
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html
607
1251
  #
608
1252
  # @option params [String] :name
609
- # The name of the event bus to show details for. If you omit this, the
610
- # default event bus is displayed.
1253
+ # The name or ARN of the event bus to show details for. If you omit
1254
+ # this, the default event bus is displayed.
611
1255
  #
612
1256
  # @return [Types::DescribeEventBusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
613
1257
  #
@@ -618,7 +1262,7 @@ module Aws::CloudWatchEvents
618
1262
  # @example Request syntax with placeholder values
619
1263
  #
620
1264
  # resp = client.describe_event_bus({
621
- # name: "EventBusName",
1265
+ # name: "EventBusNameOrArn",
622
1266
  # })
623
1267
  #
624
1268
  # @example Response structure
@@ -676,9 +1320,14 @@ module Aws::CloudWatchEvents
676
1320
  end
677
1321
 
678
1322
  # An SaaS partner can use this operation to list details about a partner
679
- # event source that they have created. AWS customers do not use this
680
- # operation. Instead, AWS customers can use DescribeEventSource to see
681
- # details about a partner event source that is shared with them.
1323
+ # event source that they have created. Amazon Web Services customers do
1324
+ # not use this operation. Instead, Amazon Web Services customers can use
1325
+ # [DescribeEventSource][1] to see details about a partner event source
1326
+ # that is shared with them.
1327
+ #
1328
+ #
1329
+ #
1330
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html
682
1331
  #
683
1332
  # @option params [required, String] :name
684
1333
  # The name of the event source to display.
@@ -708,17 +1357,82 @@ module Aws::CloudWatchEvents
708
1357
  req.send_request(options)
709
1358
  end
710
1359
 
1360
+ # Retrieves details about a replay. Use `DescribeReplay` to determine
1361
+ # the progress of a running replay. A replay processes events to replay
1362
+ # based on the time in the event, and replays them using 1 minute
1363
+ # intervals. If you use `StartReplay` and specify an `EventStartTime`
1364
+ # and an `EventEndTime` that covers a 20 minute time range, the events
1365
+ # are replayed from the first minute of that 20 minute range first. Then
1366
+ # the events from the second minute are replayed. You can use
1367
+ # `DescribeReplay` to determine the progress of a replay. The value
1368
+ # returned for `EventLastReplayedTime` indicates the time within the
1369
+ # specified time range associated with the last event replayed.
1370
+ #
1371
+ # @option params [required, String] :replay_name
1372
+ # The name of the replay to retrieve.
1373
+ #
1374
+ # @return [Types::DescribeReplayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1375
+ #
1376
+ # * {Types::DescribeReplayResponse#replay_name #replay_name} => String
1377
+ # * {Types::DescribeReplayResponse#replay_arn #replay_arn} => String
1378
+ # * {Types::DescribeReplayResponse#description #description} => String
1379
+ # * {Types::DescribeReplayResponse#state #state} => String
1380
+ # * {Types::DescribeReplayResponse#state_reason #state_reason} => String
1381
+ # * {Types::DescribeReplayResponse#event_source_arn #event_source_arn} => String
1382
+ # * {Types::DescribeReplayResponse#destination #destination} => Types::ReplayDestination
1383
+ # * {Types::DescribeReplayResponse#event_start_time #event_start_time} => Time
1384
+ # * {Types::DescribeReplayResponse#event_end_time #event_end_time} => Time
1385
+ # * {Types::DescribeReplayResponse#event_last_replayed_time #event_last_replayed_time} => Time
1386
+ # * {Types::DescribeReplayResponse#replay_start_time #replay_start_time} => Time
1387
+ # * {Types::DescribeReplayResponse#replay_end_time #replay_end_time} => Time
1388
+ #
1389
+ # @example Request syntax with placeholder values
1390
+ #
1391
+ # resp = client.describe_replay({
1392
+ # replay_name: "ReplayName", # required
1393
+ # })
1394
+ #
1395
+ # @example Response structure
1396
+ #
1397
+ # resp.replay_name #=> String
1398
+ # resp.replay_arn #=> String
1399
+ # resp.description #=> String
1400
+ # resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
1401
+ # resp.state_reason #=> String
1402
+ # resp.event_source_arn #=> String
1403
+ # resp.destination.arn #=> String
1404
+ # resp.destination.filter_arns #=> Array
1405
+ # resp.destination.filter_arns[0] #=> String
1406
+ # resp.event_start_time #=> Time
1407
+ # resp.event_end_time #=> Time
1408
+ # resp.event_last_replayed_time #=> Time
1409
+ # resp.replay_start_time #=> Time
1410
+ # resp.replay_end_time #=> Time
1411
+ #
1412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeReplay AWS API Documentation
1413
+ #
1414
+ # @overload describe_replay(params = {})
1415
+ # @param [Hash] params ({})
1416
+ def describe_replay(params = {}, options = {})
1417
+ req = build_request(:describe_replay, params)
1418
+ req.send_request(options)
1419
+ end
1420
+
711
1421
  # Describes the specified rule.
712
1422
  #
713
1423
  # DescribeRule does not list the targets of a rule. To see the targets
714
- # associated with a rule, use ListTargetsByRule.
1424
+ # associated with a rule, use [ListTargetsByRule][1].
1425
+ #
1426
+ #
1427
+ #
1428
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html
715
1429
  #
716
1430
  # @option params [required, String] :name
717
1431
  # The name of the rule.
718
1432
  #
719
1433
  # @option params [String] :event_bus_name
720
- # The event bus associated with the rule. If you omit this, the default
721
- # event bus is used.
1434
+ # The name or ARN of the event bus associated with the rule. If you omit
1435
+ # this, the default event bus is used.
722
1436
  #
723
1437
  # @return [Types::DescribeRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
724
1438
  #
@@ -731,12 +1445,13 @@ module Aws::CloudWatchEvents
731
1445
  # * {Types::DescribeRuleResponse#role_arn #role_arn} => String
732
1446
  # * {Types::DescribeRuleResponse#managed_by #managed_by} => String
733
1447
  # * {Types::DescribeRuleResponse#event_bus_name #event_bus_name} => String
1448
+ # * {Types::DescribeRuleResponse#created_by #created_by} => String
734
1449
  #
735
1450
  # @example Request syntax with placeholder values
736
1451
  #
737
1452
  # resp = client.describe_rule({
738
1453
  # name: "RuleName", # required
739
- # event_bus_name: "EventBusName",
1454
+ # event_bus_name: "EventBusNameOrArn",
740
1455
  # })
741
1456
  #
742
1457
  # @example Response structure
@@ -750,6 +1465,7 @@ module Aws::CloudWatchEvents
750
1465
  # resp.role_arn #=> String
751
1466
  # resp.managed_by #=> String
752
1467
  # resp.event_bus_name #=> String
1468
+ # resp.created_by #=> String
753
1469
  #
754
1470
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRule AWS API Documentation
755
1471
  #
@@ -763,64 +1479,228 @@ module Aws::CloudWatchEvents
763
1479
  # Disables the specified rule. A disabled rule won't match any events,
764
1480
  # and won't self-trigger if it has a schedule expression.
765
1481
  #
766
- # When you disable a rule, incoming events might continue to match to
767
- # the disabled rule. Allow a short period of time for changes to take
768
- # effect.
1482
+ # When you disable a rule, incoming events might continue to match to
1483
+ # the disabled rule. Allow a short period of time for changes to take
1484
+ # effect.
1485
+ #
1486
+ # @option params [required, String] :name
1487
+ # The name of the rule.
1488
+ #
1489
+ # @option params [String] :event_bus_name
1490
+ # The name or ARN of the event bus associated with the rule. If you omit
1491
+ # this, the default event bus is used.
1492
+ #
1493
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1494
+ #
1495
+ # @example Request syntax with placeholder values
1496
+ #
1497
+ # resp = client.disable_rule({
1498
+ # name: "RuleName", # required
1499
+ # event_bus_name: "EventBusNameOrArn",
1500
+ # })
1501
+ #
1502
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRule AWS API Documentation
1503
+ #
1504
+ # @overload disable_rule(params = {})
1505
+ # @param [Hash] params ({})
1506
+ def disable_rule(params = {}, options = {})
1507
+ req = build_request(:disable_rule, params)
1508
+ req.send_request(options)
1509
+ end
1510
+
1511
+ # Enables the specified rule. If the rule does not exist, the operation
1512
+ # fails.
1513
+ #
1514
+ # When you enable a rule, incoming events might not immediately start
1515
+ # matching to a newly enabled rule. Allow a short period of time for
1516
+ # changes to take effect.
1517
+ #
1518
+ # @option params [required, String] :name
1519
+ # The name of the rule.
1520
+ #
1521
+ # @option params [String] :event_bus_name
1522
+ # The name or ARN of the event bus associated with the rule. If you omit
1523
+ # this, the default event bus is used.
1524
+ #
1525
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1526
+ #
1527
+ # @example Request syntax with placeholder values
1528
+ #
1529
+ # resp = client.enable_rule({
1530
+ # name: "RuleName", # required
1531
+ # event_bus_name: "EventBusNameOrArn",
1532
+ # })
1533
+ #
1534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRule AWS API Documentation
1535
+ #
1536
+ # @overload enable_rule(params = {})
1537
+ # @param [Hash] params ({})
1538
+ def enable_rule(params = {}, options = {})
1539
+ req = build_request(:enable_rule, params)
1540
+ req.send_request(options)
1541
+ end
1542
+
1543
+ # Retrieves a list of API destination in the account in the current
1544
+ # Region.
1545
+ #
1546
+ # @option params [String] :name_prefix
1547
+ # A name prefix to filter results returned. Only API destinations with a
1548
+ # name that starts with the prefix are returned.
1549
+ #
1550
+ # @option params [String] :connection_arn
1551
+ # The ARN of the connection specified for the API destination.
1552
+ #
1553
+ # @option params [String] :next_token
1554
+ # The token returned by a previous call to retrieve the next set of
1555
+ # results.
1556
+ #
1557
+ # @option params [Integer] :limit
1558
+ # The maximum number of API destinations to include in the response.
1559
+ #
1560
+ # @return [Types::ListApiDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1561
+ #
1562
+ # * {Types::ListApiDestinationsResponse#api_destinations #api_destinations} => Array&lt;Types::ApiDestination&gt;
1563
+ # * {Types::ListApiDestinationsResponse#next_token #next_token} => String
1564
+ #
1565
+ # @example Request syntax with placeholder values
1566
+ #
1567
+ # resp = client.list_api_destinations({
1568
+ # name_prefix: "ApiDestinationName",
1569
+ # connection_arn: "ConnectionArn",
1570
+ # next_token: "NextToken",
1571
+ # limit: 1,
1572
+ # })
1573
+ #
1574
+ # @example Response structure
1575
+ #
1576
+ # resp.api_destinations #=> Array
1577
+ # resp.api_destinations[0].api_destination_arn #=> String
1578
+ # resp.api_destinations[0].name #=> String
1579
+ # resp.api_destinations[0].api_destination_state #=> String, one of "ACTIVE", "INACTIVE"
1580
+ # resp.api_destinations[0].connection_arn #=> String
1581
+ # resp.api_destinations[0].invocation_endpoint #=> String
1582
+ # resp.api_destinations[0].http_method #=> String, one of "POST", "GET", "HEAD", "OPTIONS", "PUT", "PATCH", "DELETE"
1583
+ # resp.api_destinations[0].invocation_rate_limit_per_second #=> Integer
1584
+ # resp.api_destinations[0].creation_time #=> Time
1585
+ # resp.api_destinations[0].last_modified_time #=> Time
1586
+ # resp.next_token #=> String
1587
+ #
1588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListApiDestinations AWS API Documentation
1589
+ #
1590
+ # @overload list_api_destinations(params = {})
1591
+ # @param [Hash] params ({})
1592
+ def list_api_destinations(params = {}, options = {})
1593
+ req = build_request(:list_api_destinations, params)
1594
+ req.send_request(options)
1595
+ end
1596
+
1597
+ # Lists your archives. You can either list all the archives or you can
1598
+ # provide a prefix to match to the archive names. Filter parameters are
1599
+ # exclusive.
1600
+ #
1601
+ # @option params [String] :name_prefix
1602
+ # A name prefix to filter the archives returned. Only archives with name
1603
+ # that match the prefix are returned.
1604
+ #
1605
+ # @option params [String] :event_source_arn
1606
+ # The ARN of the event source associated with the archive.
1607
+ #
1608
+ # @option params [String] :state
1609
+ # The state of the archive.
1610
+ #
1611
+ # @option params [String] :next_token
1612
+ # The token returned by a previous call to retrieve the next set of
1613
+ # results.
769
1614
  #
770
- # @option params [required, String] :name
771
- # The name of the rule.
1615
+ # @option params [Integer] :limit
1616
+ # The maximum number of results to return.
772
1617
  #
773
- # @option params [String] :event_bus_name
774
- # The event bus associated with the rule. If you omit this, the default
775
- # event bus is used.
1618
+ # @return [Types::ListArchivesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
776
1619
  #
777
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1620
+ # * {Types::ListArchivesResponse#archives #archives} => Array&lt;Types::Archive&gt;
1621
+ # * {Types::ListArchivesResponse#next_token #next_token} => String
778
1622
  #
779
1623
  # @example Request syntax with placeholder values
780
1624
  #
781
- # resp = client.disable_rule({
782
- # name: "RuleName", # required
783
- # event_bus_name: "EventBusName",
1625
+ # resp = client.list_archives({
1626
+ # name_prefix: "ArchiveName",
1627
+ # event_source_arn: "Arn",
1628
+ # state: "ENABLED", # accepts ENABLED, DISABLED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED
1629
+ # next_token: "NextToken",
1630
+ # limit: 1,
784
1631
  # })
785
1632
  #
786
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRule AWS API Documentation
1633
+ # @example Response structure
787
1634
  #
788
- # @overload disable_rule(params = {})
1635
+ # resp.archives #=> Array
1636
+ # resp.archives[0].archive_name #=> String
1637
+ # resp.archives[0].event_source_arn #=> String
1638
+ # resp.archives[0].state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
1639
+ # resp.archives[0].state_reason #=> String
1640
+ # resp.archives[0].retention_days #=> Integer
1641
+ # resp.archives[0].size_bytes #=> Integer
1642
+ # resp.archives[0].event_count #=> Integer
1643
+ # resp.archives[0].creation_time #=> Time
1644
+ # resp.next_token #=> String
1645
+ #
1646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListArchives AWS API Documentation
1647
+ #
1648
+ # @overload list_archives(params = {})
789
1649
  # @param [Hash] params ({})
790
- def disable_rule(params = {}, options = {})
791
- req = build_request(:disable_rule, params)
1650
+ def list_archives(params = {}, options = {})
1651
+ req = build_request(:list_archives, params)
792
1652
  req.send_request(options)
793
1653
  end
794
1654
 
795
- # Enables the specified rule. If the rule does not exist, the operation
796
- # fails.
1655
+ # Retrieves a list of connections from the account.
797
1656
  #
798
- # When you enable a rule, incoming events might not immediately start
799
- # matching to a newly enabled rule. Allow a short period of time for
800
- # changes to take effect.
1657
+ # @option params [String] :name_prefix
1658
+ # A name prefix to filter results returned. Only connections with a name
1659
+ # that starts with the prefix are returned.
801
1660
  #
802
- # @option params [required, String] :name
803
- # The name of the rule.
1661
+ # @option params [String] :connection_state
1662
+ # The state of the connection.
804
1663
  #
805
- # @option params [String] :event_bus_name
806
- # The event bus associated with the rule. If you omit this, the default
807
- # event bus is used.
1664
+ # @option params [String] :next_token
1665
+ # The token returned by a previous call to retrieve the next set of
1666
+ # results.
808
1667
  #
809
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1668
+ # @option params [Integer] :limit
1669
+ # The maximum number of connections to return.
1670
+ #
1671
+ # @return [Types::ListConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1672
+ #
1673
+ # * {Types::ListConnectionsResponse#connections #connections} => Array&lt;Types::Connection&gt;
1674
+ # * {Types::ListConnectionsResponse#next_token #next_token} => String
810
1675
  #
811
1676
  # @example Request syntax with placeholder values
812
1677
  #
813
- # resp = client.enable_rule({
814
- # name: "RuleName", # required
815
- # event_bus_name: "EventBusName",
1678
+ # resp = client.list_connections({
1679
+ # name_prefix: "ConnectionName",
1680
+ # connection_state: "CREATING", # accepts CREATING, UPDATING, DELETING, AUTHORIZED, DEAUTHORIZED, AUTHORIZING, DEAUTHORIZING
1681
+ # next_token: "NextToken",
1682
+ # limit: 1,
816
1683
  # })
817
1684
  #
818
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRule AWS API Documentation
1685
+ # @example Response structure
819
1686
  #
820
- # @overload enable_rule(params = {})
1687
+ # resp.connections #=> Array
1688
+ # resp.connections[0].connection_arn #=> String
1689
+ # resp.connections[0].name #=> String
1690
+ # resp.connections[0].connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
1691
+ # resp.connections[0].state_reason #=> String
1692
+ # resp.connections[0].authorization_type #=> String, one of "BASIC", "OAUTH_CLIENT_CREDENTIALS", "API_KEY"
1693
+ # resp.connections[0].creation_time #=> Time
1694
+ # resp.connections[0].last_modified_time #=> Time
1695
+ # resp.connections[0].last_authorized_time #=> Time
1696
+ # resp.next_token #=> String
1697
+ #
1698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListConnections AWS API Documentation
1699
+ #
1700
+ # @overload list_connections(params = {})
821
1701
  # @param [Hash] params ({})
822
- def enable_rule(params = {}, options = {})
823
- req = build_request(:enable_rule, params)
1702
+ def list_connections(params = {}, options = {})
1703
+ req = build_request(:list_connections, params)
824
1704
  req.send_request(options)
825
1705
  end
826
1706
 
@@ -871,8 +1751,12 @@ module Aws::CloudWatchEvents
871
1751
  end
872
1752
 
873
1753
  # You can use this to see all the partner event sources that have been
874
- # shared with your AWS account. For more information about partner event
875
- # sources, see CreateEventBus.
1754
+ # shared with your Amazon Web Services account. For more information
1755
+ # about partner event sources, see [CreateEventBus][1].
1756
+ #
1757
+ #
1758
+ #
1759
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html
876
1760
  #
877
1761
  # @option params [String] :name_prefix
878
1762
  # Specifying this limits the results to only those partner event sources
@@ -920,9 +1804,10 @@ module Aws::CloudWatchEvents
920
1804
  req.send_request(options)
921
1805
  end
922
1806
 
923
- # An SaaS partner can use this operation to display the AWS account ID
924
- # that a particular partner event source name is associated with. This
925
- # operation is not used by AWS customers.
1807
+ # An SaaS partner can use this operation to display the Amazon Web
1808
+ # Services account ID that a particular partner event source name is
1809
+ # associated with. This operation is not used by Amazon Web Services
1810
+ # customers.
926
1811
  #
927
1812
  # @option params [required, String] :event_source_name
928
1813
  # The name of the partner event source to display account information
@@ -969,8 +1854,8 @@ module Aws::CloudWatchEvents
969
1854
  end
970
1855
 
971
1856
  # An SaaS partner can use this operation to list all the partner event
972
- # source names that they have created. This operation is not used by AWS
973
- # customers.
1857
+ # source names that they have created. This operation is not used by
1858
+ # Amazon Web Services customers.
974
1859
  #
975
1860
  # @option params [required, String] :name_prefix
976
1861
  # If you specify this, the results are limited to only those partner
@@ -1014,6 +1899,65 @@ module Aws::CloudWatchEvents
1014
1899
  req.send_request(options)
1015
1900
  end
1016
1901
 
1902
+ # Lists your replays. You can either list all the replays or you can
1903
+ # provide a prefix to match to the replay names. Filter parameters are
1904
+ # exclusive.
1905
+ #
1906
+ # @option params [String] :name_prefix
1907
+ # A name prefix to filter the replays returned. Only replays with name
1908
+ # that match the prefix are returned.
1909
+ #
1910
+ # @option params [String] :state
1911
+ # The state of the replay.
1912
+ #
1913
+ # @option params [String] :event_source_arn
1914
+ # The ARN of the archive from which the events are replayed.
1915
+ #
1916
+ # @option params [String] :next_token
1917
+ # The token returned by a previous call to retrieve the next set of
1918
+ # results.
1919
+ #
1920
+ # @option params [Integer] :limit
1921
+ # The maximum number of replays to retrieve.
1922
+ #
1923
+ # @return [Types::ListReplaysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1924
+ #
1925
+ # * {Types::ListReplaysResponse#replays #replays} => Array&lt;Types::Replay&gt;
1926
+ # * {Types::ListReplaysResponse#next_token #next_token} => String
1927
+ #
1928
+ # @example Request syntax with placeholder values
1929
+ #
1930
+ # resp = client.list_replays({
1931
+ # name_prefix: "ReplayName",
1932
+ # state: "STARTING", # accepts STARTING, RUNNING, CANCELLING, COMPLETED, CANCELLED, FAILED
1933
+ # event_source_arn: "Arn",
1934
+ # next_token: "NextToken",
1935
+ # limit: 1,
1936
+ # })
1937
+ #
1938
+ # @example Response structure
1939
+ #
1940
+ # resp.replays #=> Array
1941
+ # resp.replays[0].replay_name #=> String
1942
+ # resp.replays[0].event_source_arn #=> String
1943
+ # resp.replays[0].state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
1944
+ # resp.replays[0].state_reason #=> String
1945
+ # resp.replays[0].event_start_time #=> Time
1946
+ # resp.replays[0].event_end_time #=> Time
1947
+ # resp.replays[0].event_last_replayed_time #=> Time
1948
+ # resp.replays[0].replay_start_time #=> Time
1949
+ # resp.replays[0].replay_end_time #=> Time
1950
+ # resp.next_token #=> String
1951
+ #
1952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListReplays AWS API Documentation
1953
+ #
1954
+ # @overload list_replays(params = {})
1955
+ # @param [Hash] params ({})
1956
+ def list_replays(params = {}, options = {})
1957
+ req = build_request(:list_replays, params)
1958
+ req.send_request(options)
1959
+ end
1960
+
1017
1961
  # Lists the rules for the specified target. You can see which of the
1018
1962
  # rules in Amazon EventBridge can invoke a specific target in your
1019
1963
  # account.
@@ -1022,8 +1966,8 @@ module Aws::CloudWatchEvents
1022
1966
  # The Amazon Resource Name (ARN) of the target resource.
1023
1967
  #
1024
1968
  # @option params [String] :event_bus_name
1025
- # Limits the results to show only the rules associated with the
1026
- # specified event bus.
1969
+ # The name or ARN of the event bus to list rules for. If you omit this,
1970
+ # the default event bus is used.
1027
1971
  #
1028
1972
  # @option params [String] :next_token
1029
1973
  # The token returned by a previous call to retrieve the next set of
@@ -1041,7 +1985,7 @@ module Aws::CloudWatchEvents
1041
1985
  #
1042
1986
  # resp = client.list_rule_names_by_target({
1043
1987
  # target_arn: "TargetArn", # required
1044
- # event_bus_name: "EventBusName",
1988
+ # event_bus_name: "EventBusNameOrArn",
1045
1989
  # next_token: "NextToken",
1046
1990
  # limit: 1,
1047
1991
  # })
@@ -1065,14 +2009,18 @@ module Aws::CloudWatchEvents
1065
2009
  # or you can provide a prefix to match to the rule names.
1066
2010
  #
1067
2011
  # ListRules does not list the targets of a rule. To see the targets
1068
- # associated with a rule, use ListTargetsByRule.
2012
+ # associated with a rule, use [ListTargetsByRule][1].
2013
+ #
2014
+ #
2015
+ #
2016
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html
1069
2017
  #
1070
2018
  # @option params [String] :name_prefix
1071
2019
  # The prefix matching the rule name.
1072
2020
  #
1073
2021
  # @option params [String] :event_bus_name
1074
- # Limits the results to show only the rules associated with the
1075
- # specified event bus.
2022
+ # The name or ARN of the event bus to list the rules for. If you omit
2023
+ # this, the default event bus is used.
1076
2024
  #
1077
2025
  # @option params [String] :next_token
1078
2026
  # The token returned by a previous call to retrieve the next set of
@@ -1090,7 +2038,7 @@ module Aws::CloudWatchEvents
1090
2038
  #
1091
2039
  # resp = client.list_rules({
1092
2040
  # name_prefix: "RuleName",
1093
- # event_bus_name: "EventBusName",
2041
+ # event_bus_name: "EventBusNameOrArn",
1094
2042
  # next_token: "NextToken",
1095
2043
  # limit: 1,
1096
2044
  # })
@@ -1155,8 +2103,8 @@ module Aws::CloudWatchEvents
1155
2103
  # The name of the rule.
1156
2104
  #
1157
2105
  # @option params [String] :event_bus_name
1158
- # The event bus associated with the rule. If you omit this, the default
1159
- # event bus is used.
2106
+ # The name or ARN of the event bus associated with the rule. If you omit
2107
+ # this, the default event bus is used.
1160
2108
  #
1161
2109
  # @option params [String] :next_token
1162
2110
  # The token returned by a previous call to retrieve the next set of
@@ -1174,7 +2122,7 @@ module Aws::CloudWatchEvents
1174
2122
  #
1175
2123
  # resp = client.list_targets_by_rule({
1176
2124
  # rule: "RuleName", # required
1177
- # event_bus_name: "EventBusName",
2125
+ # event_bus_name: "EventBusNameOrArn",
1178
2126
  # next_token: "NextToken",
1179
2127
  # limit: 1,
1180
2128
  # })
@@ -1197,7 +2145,7 @@ module Aws::CloudWatchEvents
1197
2145
  # resp.targets[0].run_command_parameters.run_command_targets[0].values[0] #=> String
1198
2146
  # resp.targets[0].ecs_parameters.task_definition_arn #=> String
1199
2147
  # resp.targets[0].ecs_parameters.task_count #=> Integer
1200
- # resp.targets[0].ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE"
2148
+ # resp.targets[0].ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
1201
2149
  # resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets #=> Array
1202
2150
  # resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets[0] #=> String
1203
2151
  # resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.security_groups #=> Array
@@ -1205,6 +2153,23 @@ module Aws::CloudWatchEvents
1205
2153
  # resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
1206
2154
  # resp.targets[0].ecs_parameters.platform_version #=> String
1207
2155
  # resp.targets[0].ecs_parameters.group #=> String
2156
+ # resp.targets[0].ecs_parameters.capacity_provider_strategy #=> Array
2157
+ # resp.targets[0].ecs_parameters.capacity_provider_strategy[0].capacity_provider #=> String
2158
+ # resp.targets[0].ecs_parameters.capacity_provider_strategy[0].weight #=> Integer
2159
+ # resp.targets[0].ecs_parameters.capacity_provider_strategy[0].base #=> Integer
2160
+ # resp.targets[0].ecs_parameters.enable_ecs_managed_tags #=> Boolean
2161
+ # resp.targets[0].ecs_parameters.enable_execute_command #=> Boolean
2162
+ # resp.targets[0].ecs_parameters.placement_constraints #=> Array
2163
+ # resp.targets[0].ecs_parameters.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
2164
+ # resp.targets[0].ecs_parameters.placement_constraints[0].expression #=> String
2165
+ # resp.targets[0].ecs_parameters.placement_strategy #=> Array
2166
+ # resp.targets[0].ecs_parameters.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
2167
+ # resp.targets[0].ecs_parameters.placement_strategy[0].field #=> String
2168
+ # resp.targets[0].ecs_parameters.propagate_tags #=> String, one of "TASK_DEFINITION"
2169
+ # resp.targets[0].ecs_parameters.reference_id #=> String
2170
+ # resp.targets[0].ecs_parameters.tags #=> Array
2171
+ # resp.targets[0].ecs_parameters.tags[0].key #=> String
2172
+ # resp.targets[0].ecs_parameters.tags[0].value #=> String
1208
2173
  # resp.targets[0].batch_parameters.job_definition #=> String
1209
2174
  # resp.targets[0].batch_parameters.job_name #=> String
1210
2175
  # resp.targets[0].batch_parameters.array_properties.size #=> Integer
@@ -1216,6 +2181,18 @@ module Aws::CloudWatchEvents
1216
2181
  # resp.targets[0].http_parameters.header_parameters["HeaderKey"] #=> String
1217
2182
  # resp.targets[0].http_parameters.query_string_parameters #=> Hash
1218
2183
  # resp.targets[0].http_parameters.query_string_parameters["QueryStringKey"] #=> String
2184
+ # resp.targets[0].redshift_data_parameters.secret_manager_arn #=> String
2185
+ # resp.targets[0].redshift_data_parameters.database #=> String
2186
+ # resp.targets[0].redshift_data_parameters.db_user #=> String
2187
+ # resp.targets[0].redshift_data_parameters.sql #=> String
2188
+ # resp.targets[0].redshift_data_parameters.statement_name #=> String
2189
+ # resp.targets[0].redshift_data_parameters.with_event #=> Boolean
2190
+ # resp.targets[0].sage_maker_pipeline_parameters.pipeline_parameter_list #=> Array
2191
+ # resp.targets[0].sage_maker_pipeline_parameters.pipeline_parameter_list[0].name #=> String
2192
+ # resp.targets[0].sage_maker_pipeline_parameters.pipeline_parameter_list[0].value #=> String
2193
+ # resp.targets[0].dead_letter_config.arn #=> String
2194
+ # resp.targets[0].retry_policy.maximum_retry_attempts #=> Integer
2195
+ # resp.targets[0].retry_policy.maximum_event_age_in_seconds #=> Integer
1219
2196
  # resp.next_token #=> String
1220
2197
  #
1221
2198
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTargetsByRule AWS API Documentation
@@ -1238,7 +2215,7 @@ module Aws::CloudWatchEvents
1238
2215
  # @return [Types::PutEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1239
2216
  #
1240
2217
  # * {Types::PutEventsResponse#failed_entry_count #failed_entry_count} => Integer
1241
- # * {Types::PutEventsResponse#entries #entries} => Array&lt;Types::PutEventsResultEntry&gt;
2218
+ # * {Types::PutEventsResponse#entries #data.entries} => Array&lt;Types::PutEventsResultEntry&gt; (This method conflicts with a method on Response, call it through the data member)
1242
2219
  #
1243
2220
  # @example Request syntax with placeholder values
1244
2221
  #
@@ -1250,7 +2227,8 @@ module Aws::CloudWatchEvents
1250
2227
  # resources: ["EventResource"],
1251
2228
  # detail_type: "String",
1252
2229
  # detail: "String",
1253
- # event_bus_name: "NonPartnerEventBusName",
2230
+ # event_bus_name: "NonPartnerEventBusNameOrArn",
2231
+ # trace_header: "TraceHeader",
1254
2232
  # },
1255
2233
  # ],
1256
2234
  # })
@@ -1258,10 +2236,10 @@ module Aws::CloudWatchEvents
1258
2236
  # @example Response structure
1259
2237
  #
1260
2238
  # resp.failed_entry_count #=> Integer
1261
- # resp.entries #=> Array
1262
- # resp.entries[0].event_id #=> String
1263
- # resp.entries[0].error_code #=> String
1264
- # resp.entries[0].error_message #=> String
2239
+ # resp.data.entries #=> Array
2240
+ # resp.data.entries[0].event_id #=> String
2241
+ # resp.data.entries[0].error_code #=> String
2242
+ # resp.data.entries[0].error_message #=> String
1265
2243
  #
1266
2244
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutEvents AWS API Documentation
1267
2245
  #
@@ -1273,7 +2251,7 @@ module Aws::CloudWatchEvents
1273
2251
  end
1274
2252
 
1275
2253
  # This is used by SaaS partners to write events to a customer's partner
1276
- # event bus. AWS customers do not use this operation.
2254
+ # event bus. Amazon Web Services customers do not use this operation.
1277
2255
  #
1278
2256
  # @option params [required, Array<Types::PutPartnerEventsRequestEntry>] :entries
1279
2257
  # The list of events to write to the event bus.
@@ -1281,7 +2259,7 @@ module Aws::CloudWatchEvents
1281
2259
  # @return [Types::PutPartnerEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1282
2260
  #
1283
2261
  # * {Types::PutPartnerEventsResponse#failed_entry_count #failed_entry_count} => Integer
1284
- # * {Types::PutPartnerEventsResponse#entries #entries} => Array&lt;Types::PutPartnerEventsResultEntry&gt;
2262
+ # * {Types::PutPartnerEventsResponse#entries #data.entries} => Array&lt;Types::PutPartnerEventsResultEntry&gt; (This method conflicts with a method on Response, call it through the data member)
1285
2263
  #
1286
2264
  # @example Request syntax with placeholder values
1287
2265
  #
@@ -1300,10 +2278,10 @@ module Aws::CloudWatchEvents
1300
2278
  # @example Response structure
1301
2279
  #
1302
2280
  # resp.failed_entry_count #=> Integer
1303
- # resp.entries #=> Array
1304
- # resp.entries[0].event_id #=> String
1305
- # resp.entries[0].error_code #=> String
1306
- # resp.entries[0].error_message #=> String
2281
+ # resp.data.entries #=> Array
2282
+ # resp.data.entries[0].event_id #=> String
2283
+ # resp.data.entries[0].error_code #=> String
2284
+ # resp.data.entries[0].error_message #=> String
1307
2285
  #
1308
2286
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPartnerEvents AWS API Documentation
1309
2287
  #
@@ -1314,47 +2292,47 @@ module Aws::CloudWatchEvents
1314
2292
  req.send_request(options)
1315
2293
  end
1316
2294
 
1317
- # Running `PutPermission` permits the specified AWS account or AWS
1318
- # organization to put events to the specified *event bus*. Amazon
1319
- # EventBridge (CloudWatch Events) rules in your account are triggered by
1320
- # these events arriving to an event bus in your account.
2295
+ # Running `PutPermission` permits the specified Amazon Web Services
2296
+ # account or Amazon Web Services organization to put events to the
2297
+ # specified *event bus*. Amazon EventBridge (CloudWatch Events) rules in
2298
+ # your account are triggered by these events arriving to an event bus in
2299
+ # your account.
1321
2300
  #
1322
2301
  # For another account to send events to your account, that external
1323
2302
  # account must have an EventBridge rule with your account's event bus
1324
2303
  # as a target.
1325
2304
  #
1326
- # To enable multiple AWS accounts to put events to your event bus, run
1327
- # `PutPermission` once for each of these accounts. Or, if all the
1328
- # accounts are members of the same AWS organization, you can run
1329
- # `PutPermission` once specifying `Principal` as "*" and specifying
1330
- # the AWS organization ID in `Condition`, to grant permissions to all
1331
- # accounts in that organization.
2305
+ # To enable multiple Amazon Web Services accounts to put events to your
2306
+ # event bus, run `PutPermission` once for each of these accounts. Or, if
2307
+ # all the accounts are members of the same Amazon Web Services
2308
+ # organization, you can run `PutPermission` once specifying `Principal`
2309
+ # as "*" and specifying the Amazon Web Services organization ID in
2310
+ # `Condition`, to grant permissions to all accounts in that
2311
+ # organization.
1332
2312
  #
1333
2313
  # If you grant permissions using an organization, then accounts in that
1334
2314
  # organization must specify a `RoleArn` with proper permissions when
1335
2315
  # they use `PutTarget` to add your account's event bus as a target. For
1336
- # more information, see [Sending and Receiving Events Between AWS
1337
- # Accounts][1] in the *Amazon EventBridge User Guide*.
2316
+ # more information, see [Sending and Receiving Events Between Amazon Web
2317
+ # Services Accounts][1] in the *Amazon EventBridge User Guide*.
1338
2318
  #
1339
- # The permission policy on the default event bus cannot exceed 10 KB in
1340
- # size.
2319
+ # The permission policy on the event bus cannot exceed 10 KB in size.
1341
2320
  #
1342
2321
  #
1343
2322
  #
1344
2323
  # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
1345
2324
  #
1346
2325
  # @option params [String] :event_bus_name
1347
- # The event bus associated with the rule. If you omit this, the default
1348
- # event bus is used.
2326
+ # The name of the event bus associated with the rule. If you omit this,
2327
+ # the default event bus is used.
1349
2328
  #
1350
- # @option params [required, String] :action
2329
+ # @option params [String] :action
1351
2330
  # The action that you are enabling the other account to perform.
1352
- # Currently, this must be `events:PutEvents`.
1353
2331
  #
1354
- # @option params [required, String] :principal
1355
- # The 12-digit AWS account ID that you are permitting to put events to
1356
- # your default event bus. Specify "*" to permit any account to put
1357
- # events to your default event bus.
2332
+ # @option params [String] :principal
2333
+ # The 12-digit Amazon Web Services account ID that you are permitting to
2334
+ # put events to your default event bus. Specify "*" to permit any
2335
+ # account to put events to your default event bus.
1358
2336
  #
1359
2337
  # If you specify "*" without specifying `Condition`, avoid creating
1360
2338
  # rules that may match undesirable events. To create more secure rules,
@@ -1363,21 +2341,27 @@ module Aws::CloudWatchEvents
1363
2341
  # with an account field do not match any events sent from other
1364
2342
  # accounts.
1365
2343
  #
1366
- # @option params [required, String] :statement_id
2344
+ # @option params [String] :statement_id
1367
2345
  # An identifier string for the external account that you are granting
1368
2346
  # permissions to. If you later want to revoke the permission for this
1369
2347
  # external account, specify this `StatementId` when you run
1370
- # RemovePermission.
2348
+ # [RemovePermission][1].
2349
+ #
2350
+ #
2351
+ #
2352
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html
1371
2353
  #
1372
2354
  # @option params [Types::Condition] :condition
1373
2355
  # This parameter enables you to limit the permission to accounts that
1374
- # fulfill a certain condition, such as being a member of a certain AWS
1375
- # organization. For more information about AWS Organizations, see [What
1376
- # Is AWS Organizations][1] in the *AWS Organizations User Guide*.
2356
+ # fulfill a certain condition, such as being a member of a certain
2357
+ # Amazon Web Services organization. For more information about Amazon
2358
+ # Web Services Organizations, see [What Is Amazon Web Services
2359
+ # Organizations][1] in the *Amazon Web Services Organizations User
2360
+ # Guide*.
1377
2361
  #
1378
- # If you specify `Condition` with an AWS organization ID, and specify
1379
- # "*" as the value for `Principal`, you grant permission to all the
1380
- # accounts in the named organization.
2362
+ # If you specify `Condition` with an Amazon Web Services organization
2363
+ # ID, and specify "*" as the value for `Principal`, you grant
2364
+ # permission to all the accounts in the named organization.
1381
2365
  #
1382
2366
  # The `Condition` is a JSON string which must contain `Type`, `Key`, and
1383
2367
  # `Value` fields.
@@ -1386,20 +2370,26 @@ module Aws::CloudWatchEvents
1386
2370
  #
1387
2371
  # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html
1388
2372
  #
2373
+ # @option params [String] :policy
2374
+ # A JSON string that describes the permission policy statement. You can
2375
+ # include a `Policy` parameter in the request instead of using the
2376
+ # `StatementId`, `Action`, `Principal`, or `Condition` parameters.
2377
+ #
1389
2378
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1390
2379
  #
1391
2380
  # @example Request syntax with placeholder values
1392
2381
  #
1393
2382
  # resp = client.put_permission({
1394
2383
  # event_bus_name: "NonPartnerEventBusName",
1395
- # action: "Action", # required
1396
- # principal: "Principal", # required
1397
- # statement_id: "StatementId", # required
2384
+ # action: "Action",
2385
+ # principal: "Principal",
2386
+ # statement_id: "StatementId",
1398
2387
  # condition: {
1399
2388
  # type: "String", # required
1400
2389
  # key: "String", # required
1401
2390
  # value: "String", # required
1402
2391
  # },
2392
+ # policy: "String",
1403
2393
  # })
1404
2394
  #
1405
2395
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPermission AWS API Documentation
@@ -1413,15 +2403,15 @@ module Aws::CloudWatchEvents
1413
2403
 
1414
2404
  # Creates or updates the specified rule. Rules are enabled by default,
1415
2405
  # or based on value of the state. You can disable a rule using
1416
- # DisableRule.
2406
+ # [DisableRule][1].
1417
2407
  #
1418
2408
  # A single rule watches for events from a single event bus. Events
1419
- # generated by AWS services go to your account's default event bus.
1420
- # Events generated by SaaS partner services or applications go to the
1421
- # matching partner event bus. If you have custom applications or
1422
- # services, you can specify whether their events go to your default
1423
- # event bus or a custom event bus that you have created. For more
1424
- # information, see CreateEventBus.
2409
+ # generated by Amazon Web Services services go to your account's
2410
+ # default event bus. Events generated by SaaS partner services or
2411
+ # applications go to the matching partner event bus. If you have custom
2412
+ # applications or services, you can specify whether their events go to
2413
+ # your default event bus or a custom event bus that you have created.
2414
+ # For more information, see [CreateEventBus][2].
1425
2415
  #
1426
2416
  # If you are updating an existing rule, the rule is replaced with what
1427
2417
  # you specify in this `PutRule` command. If you omit arguments in
@@ -1448,13 +2438,13 @@ module Aws::CloudWatchEvents
1448
2438
  #
1449
2439
  # If you are updating an existing rule, any tags you specify in the
1450
2440
  # `PutRule` operation are ignored. To update the tags of an existing
1451
- # rule, use TagResource and UntagResource.
2441
+ # rule, use [TagResource][3] and [UntagResource][4].
1452
2442
  #
1453
- # Most services in AWS treat : or / as the same character in Amazon
1454
- # Resource Names (ARNs). However, EventBridge uses an exact match in
1455
- # event patterns and rules. Be sure to use the correct ARN characters
1456
- # when creating event patterns so that they match the ARN syntax in the
1457
- # event you want to match.
2443
+ # Most services in Amazon Web Services treat : or / as the same
2444
+ # character in Amazon Resource Names (ARNs). However, EventBridge uses
2445
+ # an exact match in event patterns and rules. Be sure to use the correct
2446
+ # ARN characters when creating event patterns so that they match the ARN
2447
+ # syntax in the event you want to match.
1458
2448
  #
1459
2449
  # In EventBridge, it is possible to create rules that lead to infinite
1460
2450
  # loops, where a rule is fired repeatedly. For example, a rule might
@@ -1470,11 +2460,15 @@ module Aws::CloudWatchEvents
1470
2460
  # An infinite loop can quickly cause higher than expected charges. We
1471
2461
  # recommend that you use budgeting, which alerts you when charges exceed
1472
2462
  # your specified limit. For more information, see [Managing Your Costs
1473
- # with Budgets][1].
2463
+ # with Budgets][5].
1474
2464
  #
1475
2465
  #
1476
2466
  #
1477
- # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html
2467
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html
2468
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html
2469
+ # [3]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html
2470
+ # [4]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html
2471
+ # [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html
1478
2472
  #
1479
2473
  # @option params [required, String] :name
1480
2474
  # The name of the rule that you are creating or updating.
@@ -1501,12 +2495,18 @@ module Aws::CloudWatchEvents
1501
2495
  # The Amazon Resource Name (ARN) of the IAM role associated with the
1502
2496
  # rule.
1503
2497
  #
2498
+ # If you're setting an event bus in another account as the target and
2499
+ # that account granted permission to your account through an
2500
+ # organization instead of directly by the account ID, you must specify a
2501
+ # `RoleArn` with proper permissions in the `Target` structure, instead
2502
+ # of here in this parameter.
2503
+ #
1504
2504
  # @option params [Array<Types::Tag>] :tags
1505
2505
  # The list of key-value pairs to associate with the rule.
1506
2506
  #
1507
2507
  # @option params [String] :event_bus_name
1508
- # The event bus to associate with this rule. If you omit this, the
1509
- # default event bus is used.
2508
+ # The name or ARN of the event bus to associate with this rule. If you
2509
+ # omit this, the default event bus is used.
1510
2510
  #
1511
2511
  # @return [Types::PutRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1512
2512
  #
@@ -1527,7 +2527,7 @@ module Aws::CloudWatchEvents
1527
2527
  # value: "TagValue", # required
1528
2528
  # },
1529
2529
  # ],
1530
- # event_bus_name: "EventBusName",
2530
+ # event_bus_name: "EventBusNameOrArn",
1531
2531
  # })
1532
2532
  #
1533
2533
  # @example Response structure
@@ -1550,39 +2550,59 @@ module Aws::CloudWatchEvents
1550
2550
  #
1551
2551
  # You can configure the following as targets for Events:
1552
2552
  #
1553
- # * EC2 instances
2553
+ # * [API destination][1]
1554
2554
  #
1555
- # * SSM Run Command
2555
+ # * Amazon API Gateway REST API endpoints
1556
2556
  #
1557
- # * SSM Automation
2557
+ # * API Gateway
2558
+ #
2559
+ # * Batch job queue
2560
+ #
2561
+ # * CloudWatch Logs group
2562
+ #
2563
+ # * CodeBuild project
2564
+ #
2565
+ # * CodePipeline
1558
2566
  #
1559
- # * AWS Lambda functions
2567
+ # * Amazon EC2 `CreateSnapshot` API call
1560
2568
  #
1561
- # * Data streams in Amazon Kinesis Data Streams
2569
+ # * Amazon EC2 `RebootInstances` API call
1562
2570
  #
1563
- # * Data delivery streams in Amazon Kinesis Data Firehose
2571
+ # * Amazon EC2 `StopInstances` API call
2572
+ #
2573
+ # * Amazon EC2 `TerminateInstances` API call
1564
2574
  #
1565
2575
  # * Amazon ECS tasks
1566
2576
  #
1567
- # * AWS Step Functions state machines
2577
+ # * Event bus in a different Amazon Web Services account or Region.
2578
+ #
2579
+ # You can use an event bus in the US East (N. Virginia) us-east-1, US
2580
+ # West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a
2581
+ # target for a rule.
2582
+ #
2583
+ # * Firehose delivery stream (Kinesis Data Firehose)
2584
+ #
2585
+ # * Inspector assessment template (Amazon Inspector)
1568
2586
  #
1569
- # * AWS Batch jobs
2587
+ # * Kinesis stream (Kinesis Data Stream)
1570
2588
  #
1571
- # * AWS CodeBuild projects
2589
+ # * Lambda function
1572
2590
  #
1573
- # * Pipelines in AWS CodePipeline
2591
+ # * Redshift clusters (Data API statement execution)
1574
2592
  #
1575
- # * Amazon Inspector assessment templates
2593
+ # * Amazon SNS topic
1576
2594
  #
1577
- # * Amazon SNS topics
2595
+ # * Amazon SQS queues (includes FIFO queues
1578
2596
  #
1579
- # * Amazon SQS queues, including FIFO queues
2597
+ # * SSM Automation
2598
+ #
2599
+ # * SSM OpsItem
1580
2600
  #
1581
- # * The default event bus of another AWS account
2601
+ # * SSM Run Command
1582
2602
  #
1583
- # * Amazon API Gateway REST APIs
2603
+ # * Step Functions state machines
1584
2604
  #
1585
- # Creating rules with built-in targets is supported only in the AWS
2605
+ # Creating rules with built-in targets is supported only in the
1586
2606
  # Management Console. The built-in targets are `EC2 CreateSnapshot API
1587
2607
  # call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`,
1588
2608
  # and `EC2 TerminateInstances API call`.
@@ -1594,27 +2614,28 @@ module Aws::CloudWatchEvents
1594
2614
  # you can use the `RunCommandParameters` field.
1595
2615
  #
1596
2616
  # To be able to make API calls against the resources that you own,
1597
- # Amazon EventBridge (CloudWatch Events) needs the appropriate
1598
- # permissions. For AWS Lambda and Amazon SNS resources, EventBridge
1599
- # relies on resource-based policies. For EC2 instances, Kinesis data
1600
- # streams, AWS Step Functions state machines and API Gateway REST APIs,
1601
- # EventBridge relies on IAM roles that you specify in the `RoleARN`
1602
- # argument in `PutTargets`. For more information, see [Authentication
1603
- # and Access Control][1] in the *Amazon EventBridge User Guide*.
1604
- #
1605
- # If another AWS account is in the same region and has granted you
1606
- # permission (using `PutPermission`), you can send events to that
1607
- # account. Set that account's event bus as a target of the rules in
1608
- # your account. To send the matched events to the other account, specify
1609
- # that account's event bus as the `Arn` value when you run
2617
+ # Amazon EventBridge needs the appropriate permissions. For Lambda and
2618
+ # Amazon SNS resources, EventBridge relies on resource-based policies.
2619
+ # For EC2 instances, Kinesis Data Streams, Step Functions state machines
2620
+ # and API Gateway REST APIs, EventBridge relies on IAM roles that you
2621
+ # specify in the `RoleARN` argument in `PutTargets`. For more
2622
+ # information, see [Authentication and Access Control][2] in the *Amazon
2623
+ # EventBridge User Guide*.
2624
+ #
2625
+ # If another Amazon Web Services account is in the same region and has
2626
+ # granted you permission (using `PutPermission`), you can send events to
2627
+ # that account. Set that account's event bus as a target of the rules
2628
+ # in your account. To send the matched events to the other account,
2629
+ # specify that account's event bus as the `Arn` value when you run
1610
2630
  # `PutTargets`. If your account sends events to another account, your
1611
2631
  # account is charged for each sent event. Each event sent to another
1612
2632
  # account is charged as a custom event. The account receiving the event
1613
2633
  # is not charged. For more information, see [Amazon EventBridge
1614
- # (CloudWatch Events) Pricing][2].
2634
+ # Pricing][3].
1615
2635
  #
1616
2636
  # <note markdown="1"> `Input`, `InputPath`, and `InputTransformer` are not available with
1617
- # `PutTarget` if the target is an event bus of a different AWS account.
2637
+ # `PutTarget` if the target is an event bus of a different Amazon Web
2638
+ # Services account.
1618
2639
  #
1619
2640
  # </note>
1620
2641
  #
@@ -1622,11 +2643,11 @@ module Aws::CloudWatchEvents
1622
2643
  # that account granted permission to your account through an
1623
2644
  # organization instead of directly by the account ID, then you must
1624
2645
  # specify a `RoleArn` with proper permissions in the `Target` structure.
1625
- # For more information, see [Sending and Receiving Events Between AWS
1626
- # Accounts][3] in the *Amazon EventBridge User Guide*.
2646
+ # For more information, see [Sending and Receiving Events Between Amazon
2647
+ # Web Services Accounts][4] in the *Amazon EventBridge User Guide*.
1627
2648
  #
1628
2649
  # For more information about enabling cross-account events, see
1629
- # PutPermission.
2650
+ # [PutPermission][5].
1630
2651
  #
1631
2652
  # **Input**, **InputPath**, and **InputTransformer** are mutually
1632
2653
  # exclusive and optional parameters of a target. When a rule is
@@ -1663,16 +2684,18 @@ module Aws::CloudWatchEvents
1663
2684
  #
1664
2685
  #
1665
2686
  #
1666
- # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html
1667
- # [2]: https://aws.amazon.com/eventbridge/pricing/
1668
- # [3]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
2687
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html
2688
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html
2689
+ # [3]: http://aws.amazon.com/eventbridge/pricing/
2690
+ # [4]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
2691
+ # [5]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html
1669
2692
  #
1670
2693
  # @option params [required, String] :rule
1671
2694
  # The name of the rule.
1672
2695
  #
1673
2696
  # @option params [String] :event_bus_name
1674
- # The name of the event bus associated with the rule. If you omit this,
1675
- # the default event bus is used.
2697
+ # The name or ARN of the event bus associated with the rule. If you omit
2698
+ # this, the default event bus is used.
1676
2699
  #
1677
2700
  # @option params [required, Array<Types::Target>] :targets
1678
2701
  # The targets to update or add to the rule.
@@ -1686,7 +2709,7 @@ module Aws::CloudWatchEvents
1686
2709
  #
1687
2710
  # resp = client.put_targets({
1688
2711
  # rule: "RuleName", # required
1689
- # event_bus_name: "EventBusName",
2712
+ # event_bus_name: "EventBusNameOrArn",
1690
2713
  # targets: [ # required
1691
2714
  # {
1692
2715
  # id: "TargetId", # required
@@ -1714,7 +2737,7 @@ module Aws::CloudWatchEvents
1714
2737
  # ecs_parameters: {
1715
2738
  # task_definition_arn: "Arn", # required
1716
2739
  # task_count: 1,
1717
- # launch_type: "EC2", # accepts EC2, FARGATE
2740
+ # launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
1718
2741
  # network_configuration: {
1719
2742
  # awsvpc_configuration: {
1720
2743
  # subnets: ["String"], # required
@@ -1724,6 +2747,35 @@ module Aws::CloudWatchEvents
1724
2747
  # },
1725
2748
  # platform_version: "String",
1726
2749
  # group: "String",
2750
+ # capacity_provider_strategy: [
2751
+ # {
2752
+ # capacity_provider: "CapacityProvider", # required
2753
+ # weight: 1,
2754
+ # base: 1,
2755
+ # },
2756
+ # ],
2757
+ # enable_ecs_managed_tags: false,
2758
+ # enable_execute_command: false,
2759
+ # placement_constraints: [
2760
+ # {
2761
+ # type: "distinctInstance", # accepts distinctInstance, memberOf
2762
+ # expression: "PlacementConstraintExpression",
2763
+ # },
2764
+ # ],
2765
+ # placement_strategy: [
2766
+ # {
2767
+ # type: "random", # accepts random, spread, binpack
2768
+ # field: "PlacementStrategyField",
2769
+ # },
2770
+ # ],
2771
+ # propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
2772
+ # reference_id: "ReferenceId",
2773
+ # tags: [
2774
+ # {
2775
+ # key: "TagKey", # required
2776
+ # value: "TagValue", # required
2777
+ # },
2778
+ # ],
1727
2779
  # },
1728
2780
  # batch_parameters: {
1729
2781
  # job_definition: "String", # required
@@ -1747,6 +2799,29 @@ module Aws::CloudWatchEvents
1747
2799
  # "QueryStringKey" => "QueryStringValue",
1748
2800
  # },
1749
2801
  # },
2802
+ # redshift_data_parameters: {
2803
+ # secret_manager_arn: "RedshiftSecretManagerArn",
2804
+ # database: "Database", # required
2805
+ # db_user: "DbUser",
2806
+ # sql: "Sql", # required
2807
+ # statement_name: "StatementName",
2808
+ # with_event: false,
2809
+ # },
2810
+ # sage_maker_pipeline_parameters: {
2811
+ # pipeline_parameter_list: [
2812
+ # {
2813
+ # name: "SageMakerPipelineParameterName", # required
2814
+ # value: "SageMakerPipelineParameterValue", # required
2815
+ # },
2816
+ # ],
2817
+ # },
2818
+ # dead_letter_config: {
2819
+ # arn: "ResourceArn",
2820
+ # },
2821
+ # retry_policy: {
2822
+ # maximum_retry_attempts: 1,
2823
+ # maximum_event_age_in_seconds: 1,
2824
+ # },
1750
2825
  # },
1751
2826
  # ],
1752
2827
  # })
@@ -1768,16 +2843,23 @@ module Aws::CloudWatchEvents
1768
2843
  req.send_request(options)
1769
2844
  end
1770
2845
 
1771
- # Revokes the permission of another AWS account to be able to put events
1772
- # to the specified event bus. Specify the account to revoke by the
1773
- # `StatementId` value that you associated with the account when you
1774
- # granted it permission with `PutPermission`. You can find the
1775
- # `StatementId` by using DescribeEventBus.
2846
+ # Revokes the permission of another Amazon Web Services account to be
2847
+ # able to put events to the specified event bus. Specify the account to
2848
+ # revoke by the `StatementId` value that you associated with the account
2849
+ # when you granted it permission with `PutPermission`. You can find the
2850
+ # `StatementId` by using [DescribeEventBus][1].
1776
2851
  #
1777
- # @option params [required, String] :statement_id
2852
+ #
2853
+ #
2854
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html
2855
+ #
2856
+ # @option params [String] :statement_id
1778
2857
  # The statement ID corresponding to the account that is no longer
1779
2858
  # allowed to put events to the default event bus.
1780
2859
  #
2860
+ # @option params [Boolean] :remove_all_permissions
2861
+ # Specifies whether to remove all permissions.
2862
+ #
1781
2863
  # @option params [String] :event_bus_name
1782
2864
  # The name of the event bus to revoke permissions for. If you omit this,
1783
2865
  # the default event bus is used.
@@ -1787,7 +2869,8 @@ module Aws::CloudWatchEvents
1787
2869
  # @example Request syntax with placeholder values
1788
2870
  #
1789
2871
  # resp = client.remove_permission({
1790
- # statement_id: "StatementId", # required
2872
+ # statement_id: "StatementId",
2873
+ # remove_all_permissions: false,
1791
2874
  # event_bus_name: "NonPartnerEventBusName",
1792
2875
  # })
1793
2876
  #
@@ -1816,17 +2899,18 @@ module Aws::CloudWatchEvents
1816
2899
  # The name of the rule.
1817
2900
  #
1818
2901
  # @option params [String] :event_bus_name
1819
- # The name of the event bus associated with the rule.
2902
+ # The name or ARN of the event bus associated with the rule. If you omit
2903
+ # this, the default event bus is used.
1820
2904
  #
1821
2905
  # @option params [required, Array<String>] :ids
1822
2906
  # The IDs of the targets to remove from the rule.
1823
2907
  #
1824
2908
  # @option params [Boolean] :force
1825
- # If this is a managed rule, created by an AWS service on your behalf,
1826
- # you must specify `Force` as `True` to remove targets. This parameter
1827
- # is ignored for rules that are not managed rules. You can check whether
1828
- # a rule is a managed rule by using `DescribeRule` or `ListRules` and
1829
- # checking the `ManagedBy` field of the response.
2909
+ # If this is a managed rule, created by an Amazon Web Services service
2910
+ # on your behalf, you must specify `Force` as `True` to remove targets.
2911
+ # This parameter is ignored for rules that are not managed rules. You
2912
+ # can check whether a rule is a managed rule by using `DescribeRule` or
2913
+ # `ListRules` and checking the `ManagedBy` field of the response.
1830
2914
  #
1831
2915
  # @return [Types::RemoveTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1832
2916
  #
@@ -1837,7 +2921,7 @@ module Aws::CloudWatchEvents
1837
2921
  #
1838
2922
  # resp = client.remove_targets({
1839
2923
  # rule: "RuleName", # required
1840
- # event_bus_name: "EventBusName",
2924
+ # event_bus_name: "EventBusNameOrArn",
1841
2925
  # ids: ["TargetId"], # required
1842
2926
  # force: false,
1843
2927
  # })
@@ -1859,14 +2943,83 @@ module Aws::CloudWatchEvents
1859
2943
  req.send_request(options)
1860
2944
  end
1861
2945
 
2946
+ # Starts the specified replay. Events are not necessarily replayed in
2947
+ # the exact same order that they were added to the archive. A replay
2948
+ # processes events to replay based on the time in the event, and replays
2949
+ # them using 1 minute intervals. If you specify an `EventStartTime` and
2950
+ # an `EventEndTime` that covers a 20 minute time range, the events are
2951
+ # replayed from the first minute of that 20 minute range first. Then the
2952
+ # events from the second minute are replayed. You can use
2953
+ # `DescribeReplay` to determine the progress of a replay. The value
2954
+ # returned for `EventLastReplayedTime` indicates the time within the
2955
+ # specified time range associated with the last event replayed.
2956
+ #
2957
+ # @option params [required, String] :replay_name
2958
+ # The name of the replay to start.
2959
+ #
2960
+ # @option params [String] :description
2961
+ # A description for the replay to start.
2962
+ #
2963
+ # @option params [required, String] :event_source_arn
2964
+ # The ARN of the archive to replay events from.
2965
+ #
2966
+ # @option params [required, Time,DateTime,Date,Integer,String] :event_start_time
2967
+ # A time stamp for the time to start replaying events. Only events that
2968
+ # occurred between the `EventStartTime` and `EventEndTime` are replayed.
2969
+ #
2970
+ # @option params [required, Time,DateTime,Date,Integer,String] :event_end_time
2971
+ # A time stamp for the time to stop replaying events. Only events that
2972
+ # occurred between the `EventStartTime` and `EventEndTime` are replayed.
2973
+ #
2974
+ # @option params [required, Types::ReplayDestination] :destination
2975
+ # A `ReplayDestination` object that includes details about the
2976
+ # destination for the replay.
2977
+ #
2978
+ # @return [Types::StartReplayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2979
+ #
2980
+ # * {Types::StartReplayResponse#replay_arn #replay_arn} => String
2981
+ # * {Types::StartReplayResponse#state #state} => String
2982
+ # * {Types::StartReplayResponse#state_reason #state_reason} => String
2983
+ # * {Types::StartReplayResponse#replay_start_time #replay_start_time} => Time
2984
+ #
2985
+ # @example Request syntax with placeholder values
2986
+ #
2987
+ # resp = client.start_replay({
2988
+ # replay_name: "ReplayName", # required
2989
+ # description: "ReplayDescription",
2990
+ # event_source_arn: "Arn", # required
2991
+ # event_start_time: Time.now, # required
2992
+ # event_end_time: Time.now, # required
2993
+ # destination: { # required
2994
+ # arn: "Arn", # required
2995
+ # filter_arns: ["Arn"],
2996
+ # },
2997
+ # })
2998
+ #
2999
+ # @example Response structure
3000
+ #
3001
+ # resp.replay_arn #=> String
3002
+ # resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
3003
+ # resp.state_reason #=> String
3004
+ # resp.replay_start_time #=> Time
3005
+ #
3006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/StartReplay AWS API Documentation
3007
+ #
3008
+ # @overload start_replay(params = {})
3009
+ # @param [Hash] params ({})
3010
+ def start_replay(params = {}, options = {})
3011
+ req = build_request(:start_replay, params)
3012
+ req.send_request(options)
3013
+ end
3014
+
1862
3015
  # Assigns one or more tags (key-value pairs) to the specified
1863
3016
  # EventBridge resource. Tags can help you organize and categorize your
1864
3017
  # resources. You can also use them to scope user permissions by granting
1865
3018
  # a user permission to access or change only resources with certain tag
1866
3019
  # values. In EventBridge, rules and event buses can be tagged.
1867
3020
  #
1868
- # Tags don't have any semantic meaning to AWS and are interpreted
1869
- # strictly as strings of characters.
3021
+ # Tags don't have any semantic meaning to Amazon Web Services and are
3022
+ # interpreted strictly as strings of characters.
1870
3023
  #
1871
3024
  # You can use the `TagResource` action with a resource that already has
1872
3025
  # tags. If you specify a new tag key, this tag is appended to the list
@@ -1907,11 +3060,11 @@ module Aws::CloudWatchEvents
1907
3060
 
1908
3061
  # Tests whether the specified event pattern matches the provided event.
1909
3062
  #
1910
- # Most services in AWS treat : or / as the same character in Amazon
1911
- # Resource Names (ARNs). However, EventBridge uses an exact match in
1912
- # event patterns and rules. Be sure to use the correct ARN characters
1913
- # when creating event patterns so that they match the ARN syntax in the
1914
- # event you want to match.
3063
+ # Most services in Amazon Web Services treat : or / as the same
3064
+ # character in Amazon Resource Names (ARNs). However, EventBridge uses
3065
+ # an exact match in event patterns and rules. Be sure to use the correct
3066
+ # ARN characters when creating event patterns so that they match the ARN
3067
+ # syntax in the event you want to match.
1915
3068
  #
1916
3069
  # @option params [required, String] :event_pattern
1917
3070
  # The event pattern. For more information, see [Events and Event
@@ -1922,7 +3075,27 @@ module Aws::CloudWatchEvents
1922
3075
  # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
1923
3076
  #
1924
3077
  # @option params [required, String] :event
1925
- # The event, in JSON format, to test against the event pattern.
3078
+ # The event, in JSON format, to test against the event pattern. The JSON
3079
+ # must follow the format specified in [Amazon Web Services Events][1],
3080
+ # and the following fields are mandatory:
3081
+ #
3082
+ # * `id`
3083
+ #
3084
+ # * `account`
3085
+ #
3086
+ # * `source`
3087
+ #
3088
+ # * `time`
3089
+ #
3090
+ # * `region`
3091
+ #
3092
+ # * `resources`
3093
+ #
3094
+ # * `detail-type`
3095
+ #
3096
+ #
3097
+ #
3098
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html
1926
3099
  #
1927
3100
  # @return [Types::TestEventPatternResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1928
3101
  #
@@ -1949,7 +3122,7 @@ module Aws::CloudWatchEvents
1949
3122
  end
1950
3123
 
1951
3124
  # Removes one or more tags from the specified EventBridge resource. In
1952
- # Amazon EventBridge (CloudWatch Events, rules and event buses can be
3125
+ # Amazon EventBridge (CloudWatch Events), rules and event buses can be
1953
3126
  # tagged.
1954
3127
  #
1955
3128
  # @option params [required, String] :resource_arn
@@ -1976,6 +3149,218 @@ module Aws::CloudWatchEvents
1976
3149
  req.send_request(options)
1977
3150
  end
1978
3151
 
3152
+ # Updates an API destination.
3153
+ #
3154
+ # @option params [required, String] :name
3155
+ # The name of the API destination to update.
3156
+ #
3157
+ # @option params [String] :description
3158
+ # The name of the API destination to update.
3159
+ #
3160
+ # @option params [String] :connection_arn
3161
+ # The ARN of the connection to use for the API destination.
3162
+ #
3163
+ # @option params [String] :invocation_endpoint
3164
+ # The URL to the endpoint to use for the API destination.
3165
+ #
3166
+ # @option params [String] :http_method
3167
+ # The method to use for the API destination.
3168
+ #
3169
+ # @option params [Integer] :invocation_rate_limit_per_second
3170
+ # The maximum number of invocations per second to send to the API
3171
+ # destination.
3172
+ #
3173
+ # @return [Types::UpdateApiDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3174
+ #
3175
+ # * {Types::UpdateApiDestinationResponse#api_destination_arn #api_destination_arn} => String
3176
+ # * {Types::UpdateApiDestinationResponse#api_destination_state #api_destination_state} => String
3177
+ # * {Types::UpdateApiDestinationResponse#creation_time #creation_time} => Time
3178
+ # * {Types::UpdateApiDestinationResponse#last_modified_time #last_modified_time} => Time
3179
+ #
3180
+ # @example Request syntax with placeholder values
3181
+ #
3182
+ # resp = client.update_api_destination({
3183
+ # name: "ApiDestinationName", # required
3184
+ # description: "ApiDestinationDescription",
3185
+ # connection_arn: "ConnectionArn",
3186
+ # invocation_endpoint: "HttpsEndpoint",
3187
+ # http_method: "POST", # accepts POST, GET, HEAD, OPTIONS, PUT, PATCH, DELETE
3188
+ # invocation_rate_limit_per_second: 1,
3189
+ # })
3190
+ #
3191
+ # @example Response structure
3192
+ #
3193
+ # resp.api_destination_arn #=> String
3194
+ # resp.api_destination_state #=> String, one of "ACTIVE", "INACTIVE"
3195
+ # resp.creation_time #=> Time
3196
+ # resp.last_modified_time #=> Time
3197
+ #
3198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateApiDestination AWS API Documentation
3199
+ #
3200
+ # @overload update_api_destination(params = {})
3201
+ # @param [Hash] params ({})
3202
+ def update_api_destination(params = {}, options = {})
3203
+ req = build_request(:update_api_destination, params)
3204
+ req.send_request(options)
3205
+ end
3206
+
3207
+ # Updates the specified archive.
3208
+ #
3209
+ # @option params [required, String] :archive_name
3210
+ # The name of the archive to update.
3211
+ #
3212
+ # @option params [String] :description
3213
+ # The description for the archive.
3214
+ #
3215
+ # @option params [String] :event_pattern
3216
+ # The event pattern to use to filter events sent to the archive.
3217
+ #
3218
+ # @option params [Integer] :retention_days
3219
+ # The number of days to retain events in the archive.
3220
+ #
3221
+ # @return [Types::UpdateArchiveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3222
+ #
3223
+ # * {Types::UpdateArchiveResponse#archive_arn #archive_arn} => String
3224
+ # * {Types::UpdateArchiveResponse#state #state} => String
3225
+ # * {Types::UpdateArchiveResponse#state_reason #state_reason} => String
3226
+ # * {Types::UpdateArchiveResponse#creation_time #creation_time} => Time
3227
+ #
3228
+ # @example Request syntax with placeholder values
3229
+ #
3230
+ # resp = client.update_archive({
3231
+ # archive_name: "ArchiveName", # required
3232
+ # description: "ArchiveDescription",
3233
+ # event_pattern: "EventPattern",
3234
+ # retention_days: 1,
3235
+ # })
3236
+ #
3237
+ # @example Response structure
3238
+ #
3239
+ # resp.archive_arn #=> String
3240
+ # resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
3241
+ # resp.state_reason #=> String
3242
+ # resp.creation_time #=> Time
3243
+ #
3244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateArchive AWS API Documentation
3245
+ #
3246
+ # @overload update_archive(params = {})
3247
+ # @param [Hash] params ({})
3248
+ def update_archive(params = {}, options = {})
3249
+ req = build_request(:update_archive, params)
3250
+ req.send_request(options)
3251
+ end
3252
+
3253
+ # Updates settings for a connection.
3254
+ #
3255
+ # @option params [required, String] :name
3256
+ # The name of the connection to update.
3257
+ #
3258
+ # @option params [String] :description
3259
+ # A description for the connection.
3260
+ #
3261
+ # @option params [String] :authorization_type
3262
+ # The type of authorization to use for the connection.
3263
+ #
3264
+ # @option params [Types::UpdateConnectionAuthRequestParameters] :auth_parameters
3265
+ # The authorization parameters to use for the connection.
3266
+ #
3267
+ # @return [Types::UpdateConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3268
+ #
3269
+ # * {Types::UpdateConnectionResponse#connection_arn #connection_arn} => String
3270
+ # * {Types::UpdateConnectionResponse#connection_state #connection_state} => String
3271
+ # * {Types::UpdateConnectionResponse#creation_time #creation_time} => Time
3272
+ # * {Types::UpdateConnectionResponse#last_modified_time #last_modified_time} => Time
3273
+ # * {Types::UpdateConnectionResponse#last_authorized_time #last_authorized_time} => Time
3274
+ #
3275
+ # @example Request syntax with placeholder values
3276
+ #
3277
+ # resp = client.update_connection({
3278
+ # name: "ConnectionName", # required
3279
+ # description: "ConnectionDescription",
3280
+ # authorization_type: "BASIC", # accepts BASIC, OAUTH_CLIENT_CREDENTIALS, API_KEY
3281
+ # auth_parameters: {
3282
+ # basic_auth_parameters: {
3283
+ # username: "AuthHeaderParameters",
3284
+ # password: "AuthHeaderParameters",
3285
+ # },
3286
+ # o_auth_parameters: {
3287
+ # client_parameters: {
3288
+ # client_id: "AuthHeaderParameters",
3289
+ # client_secret: "AuthHeaderParameters",
3290
+ # },
3291
+ # authorization_endpoint: "HttpsEndpoint",
3292
+ # http_method: "GET", # accepts GET, POST, PUT
3293
+ # o_auth_http_parameters: {
3294
+ # header_parameters: [
3295
+ # {
3296
+ # key: "HeaderKey",
3297
+ # value: "HeaderValue",
3298
+ # is_value_secret: false,
3299
+ # },
3300
+ # ],
3301
+ # query_string_parameters: [
3302
+ # {
3303
+ # key: "QueryStringKey",
3304
+ # value: "QueryStringValue",
3305
+ # is_value_secret: false,
3306
+ # },
3307
+ # ],
3308
+ # body_parameters: [
3309
+ # {
3310
+ # key: "String",
3311
+ # value: "String",
3312
+ # is_value_secret: false,
3313
+ # },
3314
+ # ],
3315
+ # },
3316
+ # },
3317
+ # api_key_auth_parameters: {
3318
+ # api_key_name: "AuthHeaderParameters",
3319
+ # api_key_value: "AuthHeaderParameters",
3320
+ # },
3321
+ # invocation_http_parameters: {
3322
+ # header_parameters: [
3323
+ # {
3324
+ # key: "HeaderKey",
3325
+ # value: "HeaderValue",
3326
+ # is_value_secret: false,
3327
+ # },
3328
+ # ],
3329
+ # query_string_parameters: [
3330
+ # {
3331
+ # key: "QueryStringKey",
3332
+ # value: "QueryStringValue",
3333
+ # is_value_secret: false,
3334
+ # },
3335
+ # ],
3336
+ # body_parameters: [
3337
+ # {
3338
+ # key: "String",
3339
+ # value: "String",
3340
+ # is_value_secret: false,
3341
+ # },
3342
+ # ],
3343
+ # },
3344
+ # },
3345
+ # })
3346
+ #
3347
+ # @example Response structure
3348
+ #
3349
+ # resp.connection_arn #=> String
3350
+ # resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
3351
+ # resp.creation_time #=> Time
3352
+ # resp.last_modified_time #=> Time
3353
+ # resp.last_authorized_time #=> Time
3354
+ #
3355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnection AWS API Documentation
3356
+ #
3357
+ # @overload update_connection(params = {})
3358
+ # @param [Hash] params ({})
3359
+ def update_connection(params = {}, options = {})
3360
+ req = build_request(:update_connection, params)
3361
+ req.send_request(options)
3362
+ end
3363
+
1979
3364
  # @!endgroup
1980
3365
 
1981
3366
  # @param params ({})
@@ -1989,7 +3374,7 @@ module Aws::CloudWatchEvents
1989
3374
  params: params,
1990
3375
  config: config)
1991
3376
  context[:gem_name] = 'aws-sdk-cloudwatchevents'
1992
- context[:gem_version] = '1.33.0'
3377
+ context[:gem_version] = '1.64.0'
1993
3378
  Seahorse::Client::Request.new(handlers, context)
1994
3379
  end
1995
3380