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,20 +3,13 @@
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
 
10
10
  module Aws::CloudWatchEvents
11
11
  module Types
12
12
 
13
- # @note When making an API call, you may pass ActivateEventSourceRequest
14
- # data as a hash:
15
- #
16
- # {
17
- # name: "EventSourceName", # required
18
- # }
19
- #
20
13
  # @!attribute [rw] name
21
14
  # The name of the partner event source to activate.
22
15
  # @return [String]
@@ -29,19 +22,118 @@ module Aws::CloudWatchEvents
29
22
  include Aws::Structure
30
23
  end
31
24
 
25
+ # Contains details about an API destination.
26
+ #
27
+ # @!attribute [rw] api_destination_arn
28
+ # The ARN of the API destination.
29
+ # @return [String]
30
+ #
31
+ # @!attribute [rw] name
32
+ # The name of the API destination.
33
+ # @return [String]
34
+ #
35
+ # @!attribute [rw] api_destination_state
36
+ # The state of the API destination.
37
+ # @return [String]
38
+ #
39
+ # @!attribute [rw] connection_arn
40
+ # The ARN of the connection specified for the API destination.
41
+ # @return [String]
42
+ #
43
+ # @!attribute [rw] invocation_endpoint
44
+ # The URL to the endpoint for the API destination.
45
+ # @return [String]
46
+ #
47
+ # @!attribute [rw] http_method
48
+ # The method to use to connect to the HTTP endpoint.
49
+ # @return [String]
50
+ #
51
+ # @!attribute [rw] invocation_rate_limit_per_second
52
+ # The maximum number of invocations per second to send to the HTTP
53
+ # endpoint.
54
+ # @return [Integer]
55
+ #
56
+ # @!attribute [rw] creation_time
57
+ # A time stamp for the time that the API destination was created.
58
+ # @return [Time]
59
+ #
60
+ # @!attribute [rw] last_modified_time
61
+ # A time stamp for the time that the API destination was last
62
+ # modified.
63
+ # @return [Time]
64
+ #
65
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ApiDestination AWS API Documentation
66
+ #
67
+ class ApiDestination < Struct.new(
68
+ :api_destination_arn,
69
+ :name,
70
+ :api_destination_state,
71
+ :connection_arn,
72
+ :invocation_endpoint,
73
+ :http_method,
74
+ :invocation_rate_limit_per_second,
75
+ :creation_time,
76
+ :last_modified_time)
77
+ SENSITIVE = []
78
+ include Aws::Structure
79
+ end
80
+
81
+ # An `Archive` object that contains details about an archive.
82
+ #
83
+ # @!attribute [rw] archive_name
84
+ # The name of the archive.
85
+ # @return [String]
86
+ #
87
+ # @!attribute [rw] event_source_arn
88
+ # The ARN of the event bus associated with the archive. Only events
89
+ # from this event bus are sent to the archive.
90
+ # @return [String]
91
+ #
92
+ # @!attribute [rw] state
93
+ # The current state of the archive.
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] state_reason
97
+ # A description for the reason that the archive is in the current
98
+ # state.
99
+ # @return [String]
100
+ #
101
+ # @!attribute [rw] retention_days
102
+ # The number of days to retain events in the archive before they are
103
+ # deleted.
104
+ # @return [Integer]
105
+ #
106
+ # @!attribute [rw] size_bytes
107
+ # The size of the archive, in bytes.
108
+ # @return [Integer]
109
+ #
110
+ # @!attribute [rw] event_count
111
+ # The number of events in the archive.
112
+ # @return [Integer]
113
+ #
114
+ # @!attribute [rw] creation_time
115
+ # The time stamp for the time that the archive was created.
116
+ # @return [Time]
117
+ #
118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Archive AWS API Documentation
119
+ #
120
+ class Archive < Struct.new(
121
+ :archive_name,
122
+ :event_source_arn,
123
+ :state,
124
+ :state_reason,
125
+ :retention_days,
126
+ :size_bytes,
127
+ :event_count,
128
+ :creation_time)
129
+ SENSITIVE = []
130
+ include Aws::Structure
131
+ end
132
+
32
133
  # This structure specifies the VPC subnets and security groups for the
33
134
  # task, and whether a public IP address is to be used. This structure is
34
135
  # relevant only for ECS tasks that use the `awsvpc` network mode.
35
136
  #
36
- # @note When making an API call, you may pass AwsVpcConfiguration
37
- # data as a hash:
38
- #
39
- # {
40
- # subnets: ["String"], # required
41
- # security_groups: ["String"],
42
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
43
- # }
44
- #
45
137
  # @!attribute [rw] subnets
46
138
  # Specifies the subnets associated with the task. These subnets must
47
139
  # all be in the same VPC. You can specify as many as 16 subnets.
@@ -73,14 +165,7 @@ module Aws::CloudWatchEvents
73
165
  # The array properties for the submitted job, such as the size of the
74
166
  # array. The array size can be between 2 and 10,000. If you specify
75
167
  # array properties for a job, it becomes an array job. This parameter is
76
- # used only if the target is an AWS Batch job.
77
- #
78
- # @note When making an API call, you may pass BatchArrayProperties
79
- # data as a hash:
80
- #
81
- # {
82
- # size: 1,
83
- # }
168
+ # used only if the target is an Batch job.
84
169
  #
85
170
  # @!attribute [rw] size
86
171
  # The size of the array, if this is an array batch job. Valid values
@@ -95,45 +180,31 @@ module Aws::CloudWatchEvents
95
180
  include Aws::Structure
96
181
  end
97
182
 
98
- # The custom parameters to be used when the target is an AWS Batch job.
99
- #
100
- # @note When making an API call, you may pass BatchParameters
101
- # data as a hash:
102
- #
103
- # {
104
- # job_definition: "String", # required
105
- # job_name: "String", # required
106
- # array_properties: {
107
- # size: 1,
108
- # },
109
- # retry_strategy: {
110
- # attempts: 1,
111
- # },
112
- # }
183
+ # The custom parameters to be used when the target is an Batch job.
113
184
  #
114
185
  # @!attribute [rw] job_definition
115
186
  # The ARN or name of the job definition to use if the event target is
116
- # an AWS Batch job. This job definition must already exist.
187
+ # an Batch job. This job definition must already exist.
117
188
  # @return [String]
118
189
  #
119
190
  # @!attribute [rw] job_name
120
191
  # The name to use for this execution of the job, if the target is an
121
- # AWS Batch job.
192
+ # Batch job.
122
193
  # @return [String]
123
194
  #
124
195
  # @!attribute [rw] array_properties
125
196
  # The array properties for the submitted job, such as the size of the
126
197
  # array. The array size can be between 2 and 10,000. If you specify
127
198
  # array properties for a job, it becomes an array job. This parameter
128
- # is used only if the target is an AWS Batch job.
199
+ # is used only if the target is an Batch job.
129
200
  # @return [Types::BatchArrayProperties]
130
201
  #
131
202
  # @!attribute [rw] retry_strategy
132
- # The retry strategy to use for failed jobs, if the target is an AWS
133
- # Batch job. The retry strategy is the number of times to retry the
134
- # failed job execution. Valid values are 1–10. When you specify a
135
- # retry strategy here, it overrides the retry strategy defined in the
136
- # job definition.
203
+ # The retry strategy to use for failed jobs, if the target is an Batch
204
+ # job. The retry strategy is the number of times to retry the failed
205
+ # job execution. Valid values are 1–10. When you specify a retry
206
+ # strategy here, it overrides the retry strategy defined in the job
207
+ # definition.
137
208
  # @return [Types::BatchRetryStrategy]
138
209
  #
139
210
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/BatchParameters AWS API Documentation
@@ -147,16 +218,9 @@ module Aws::CloudWatchEvents
147
218
  include Aws::Structure
148
219
  end
149
220
 
150
- # The retry strategy to use for failed jobs, if the target is an AWS
151
- # Batch job. If you specify a retry strategy here, it overrides the
152
- # retry strategy defined in the job definition.
153
- #
154
- # @note When making an API call, you may pass BatchRetryStrategy
155
- # data as a hash:
156
- #
157
- # {
158
- # attempts: 1,
159
- # }
221
+ # The retry strategy to use for failed jobs, if the target is an Batch
222
+ # job. If you specify a retry strategy here, it overrides the retry
223
+ # strategy defined in the job definition.
160
224
  #
161
225
  # @!attribute [rw] attempts
162
226
  # The number of times to attempt to retry, if the job fails. Valid
@@ -171,7 +235,77 @@ module Aws::CloudWatchEvents
171
235
  include Aws::Structure
172
236
  end
173
237
 
174
- # There is concurrent modification on a rule or target.
238
+ # @!attribute [rw] replay_name
239
+ # The name of the replay to cancel.
240
+ # @return [String]
241
+ #
242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CancelReplayRequest AWS API Documentation
243
+ #
244
+ class CancelReplayRequest < Struct.new(
245
+ :replay_name)
246
+ SENSITIVE = []
247
+ include Aws::Structure
248
+ end
249
+
250
+ # @!attribute [rw] replay_arn
251
+ # The ARN of the replay to cancel.
252
+ # @return [String]
253
+ #
254
+ # @!attribute [rw] state
255
+ # The current state of the replay.
256
+ # @return [String]
257
+ #
258
+ # @!attribute [rw] state_reason
259
+ # The reason that the replay is in the current state.
260
+ # @return [String]
261
+ #
262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CancelReplayResponse AWS API Documentation
263
+ #
264
+ class CancelReplayResponse < Struct.new(
265
+ :replay_arn,
266
+ :state,
267
+ :state_reason)
268
+ SENSITIVE = []
269
+ include Aws::Structure
270
+ end
271
+
272
+ # The details of a capacity provider strategy. To learn more, see
273
+ # [CapacityProviderStrategyItem][1] in the Amazon ECS API Reference.
274
+ #
275
+ #
276
+ #
277
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html
278
+ #
279
+ # @!attribute [rw] capacity_provider
280
+ # The short name of the capacity provider.
281
+ # @return [String]
282
+ #
283
+ # @!attribute [rw] weight
284
+ # The weight value designates the relative percentage of the total
285
+ # number of tasks launched that should use the specified capacity
286
+ # provider. The weight value is taken into consideration after the
287
+ # base value, if defined, is satisfied.
288
+ # @return [Integer]
289
+ #
290
+ # @!attribute [rw] base
291
+ # The base value designates how many tasks, at a minimum, to run on
292
+ # the specified capacity provider. Only one capacity provider in a
293
+ # capacity provider strategy can have a base defined. If no value is
294
+ # specified, the default value of 0 is used.
295
+ # @return [Integer]
296
+ #
297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CapacityProviderStrategyItem AWS API Documentation
298
+ #
299
+ class CapacityProviderStrategyItem < Struct.new(
300
+ :capacity_provider,
301
+ :weight,
302
+ :base)
303
+ SENSITIVE = []
304
+ include Aws::Structure
305
+ end
306
+
307
+ # There is concurrent modification on a rule, target, archive, or
308
+ # replay.
175
309
  #
176
310
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConcurrentModificationException AWS API Documentation
177
311
  #
@@ -179,23 +313,14 @@ module Aws::CloudWatchEvents
179
313
 
180
314
  # A JSON string which you can use to limit the event bus permissions you
181
315
  # are granting to only accounts that fulfill the condition. Currently,
182
- # the only supported condition is membership in a certain AWS
183
- # organization. The string must contain `Type`, `Key`, and `Value`
184
- # fields. The `Value` field specifies the ID of the AWS organization.
185
- # Following is an example value for `Condition`\:
316
+ # the only supported condition is membership in a certain Amazon Web
317
+ # Services organization. The string must contain `Type`, `Key`, and
318
+ # `Value` fields. The `Value` field specifies the ID of the Amazon Web
319
+ # Services organization. Following is an example value for `Condition`:
186
320
  #
187
321
  # `'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
188
322
  # "o-1234567890"\}'`
189
323
  #
190
- # @note When making an API call, you may pass Condition
191
- # data as a hash:
192
- #
193
- # {
194
- # type: "String", # required
195
- # key: "String", # required
196
- # value: "String", # required
197
- # }
198
- #
199
324
  # @!attribute [rw] type
200
325
  # Specifies the type of condition. Currently the only supported value
201
326
  # is `StringEquals`.
@@ -221,214 +346,1093 @@ module Aws::CloudWatchEvents
221
346
  include Aws::Structure
222
347
  end
223
348
 
224
- # @note When making an API call, you may pass CreateEventBusRequest
225
- # data as a hash:
349
+ # Contains information about a connection.
226
350
  #
227
- # {
228
- # name: "EventBusName", # required
229
- # event_source_name: "EventSourceName",
230
- # tags: [
231
- # {
232
- # key: "TagKey", # required
233
- # value: "TagValue", # required
234
- # },
235
- # ],
236
- # }
351
+ # @!attribute [rw] connection_arn
352
+ # The ARN of the connection.
353
+ # @return [String]
237
354
  #
238
355
  # @!attribute [rw] name
239
- # The name of the new event bus.
356
+ # The name of the connection.
357
+ # @return [String]
240
358
  #
241
- # Event bus names cannot contain the / character. You can't use the
242
- # name `default` for a custom event bus, as this name is already used
243
- # for your account's default event bus.
359
+ # @!attribute [rw] connection_state
360
+ # The state of the connection.
361
+ # @return [String]
244
362
  #
245
- # If this is a partner event bus, the name must exactly match the name
246
- # of the partner event source that this event bus is matched to.
363
+ # @!attribute [rw] state_reason
364
+ # The reason that the connection is in the connection state.
247
365
  # @return [String]
248
366
  #
249
- # @!attribute [rw] event_source_name
250
- # If you are creating a partner event bus, this specifies the partner
251
- # event source that the new event bus will be matched with.
367
+ # @!attribute [rw] authorization_type
368
+ # The authorization type specified for the connection.
252
369
  # @return [String]
253
370
  #
254
- # @!attribute [rw] tags
255
- # Tags to associate with the event bus.
256
- # @return [Array<Types::Tag>]
371
+ # @!attribute [rw] creation_time
372
+ # A time stamp for the time that the connection was created.
373
+ # @return [Time]
257
374
  #
258
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateEventBusRequest AWS API Documentation
375
+ # @!attribute [rw] last_modified_time
376
+ # A time stamp for the time that the connection was last modified.
377
+ # @return [Time]
259
378
  #
260
- class CreateEventBusRequest < Struct.new(
379
+ # @!attribute [rw] last_authorized_time
380
+ # A time stamp for the time that the connection was last authorized.
381
+ # @return [Time]
382
+ #
383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Connection AWS API Documentation
384
+ #
385
+ class Connection < Struct.new(
386
+ :connection_arn,
261
387
  :name,
262
- :event_source_name,
263
- :tags)
388
+ :connection_state,
389
+ :state_reason,
390
+ :authorization_type,
391
+ :creation_time,
392
+ :last_modified_time,
393
+ :last_authorized_time)
264
394
  SENSITIVE = []
265
395
  include Aws::Structure
266
396
  end
267
397
 
268
- # @!attribute [rw] event_bus_arn
269
- # The ARN of the new event bus.
398
+ # Contains the authorization parameters for the connection if API Key is
399
+ # specified as the authorization type.
400
+ #
401
+ # @!attribute [rw] api_key_name
402
+ # The name of the header to use for the `APIKeyValue` used for
403
+ # authorization.
270
404
  # @return [String]
271
405
  #
272
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateEventBusResponse AWS API Documentation
406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConnectionApiKeyAuthResponseParameters AWS API Documentation
273
407
  #
274
- class CreateEventBusResponse < Struct.new(
275
- :event_bus_arn)
408
+ class ConnectionApiKeyAuthResponseParameters < Struct.new(
409
+ :api_key_name)
410
+ SENSITIVE = []
411
+ include Aws::Structure
412
+ end
413
+
414
+ # Contains the authorization parameters to use for the connection.
415
+ #
416
+ # @!attribute [rw] basic_auth_parameters
417
+ # The authorization parameters for Basic authorization.
418
+ # @return [Types::ConnectionBasicAuthResponseParameters]
419
+ #
420
+ # @!attribute [rw] o_auth_parameters
421
+ # The OAuth parameters to use for authorization.
422
+ # @return [Types::ConnectionOAuthResponseParameters]
423
+ #
424
+ # @!attribute [rw] api_key_auth_parameters
425
+ # The API Key parameters to use for authorization.
426
+ # @return [Types::ConnectionApiKeyAuthResponseParameters]
427
+ #
428
+ # @!attribute [rw] invocation_http_parameters
429
+ # Additional parameters for the connection that are passed through
430
+ # with every invocation to the HTTP endpoint.
431
+ # @return [Types::ConnectionHttpParameters]
432
+ #
433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConnectionAuthResponseParameters AWS API Documentation
434
+ #
435
+ class ConnectionAuthResponseParameters < Struct.new(
436
+ :basic_auth_parameters,
437
+ :o_auth_parameters,
438
+ :api_key_auth_parameters,
439
+ :invocation_http_parameters)
440
+ SENSITIVE = []
441
+ include Aws::Structure
442
+ end
443
+
444
+ # Contains the authorization parameters for the connection if Basic is
445
+ # specified as the authorization type.
446
+ #
447
+ # @!attribute [rw] username
448
+ # The user name to use for Basic authorization.
449
+ # @return [String]
450
+ #
451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConnectionBasicAuthResponseParameters AWS API Documentation
452
+ #
453
+ class ConnectionBasicAuthResponseParameters < Struct.new(
454
+ :username)
455
+ SENSITIVE = []
456
+ include Aws::Structure
457
+ end
458
+
459
+ # Additional parameter included in the body. You can include up to 100
460
+ # additional body parameters per request. An event payload cannot exceed
461
+ # 64 KB.
462
+ #
463
+ # @!attribute [rw] key
464
+ # The key for the parameter.
465
+ # @return [String]
466
+ #
467
+ # @!attribute [rw] value
468
+ # The value associated with the key.
469
+ # @return [String]
470
+ #
471
+ # @!attribute [rw] is_value_secret
472
+ # Specified whether the value is secret.
473
+ # @return [Boolean]
474
+ #
475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConnectionBodyParameter AWS API Documentation
476
+ #
477
+ class ConnectionBodyParameter < Struct.new(
478
+ :key,
479
+ :value,
480
+ :is_value_secret)
481
+ SENSITIVE = []
482
+ include Aws::Structure
483
+ end
484
+
485
+ # Additional parameter included in the header. You can include up to 100
486
+ # additional header parameters per request. An event payload cannot
487
+ # exceed 64 KB.
488
+ #
489
+ # @!attribute [rw] key
490
+ # The key for the parameter.
491
+ # @return [String]
492
+ #
493
+ # @!attribute [rw] value
494
+ # The value associated with the key.
495
+ # @return [String]
496
+ #
497
+ # @!attribute [rw] is_value_secret
498
+ # Specified whether the value is a secret.
499
+ # @return [Boolean]
500
+ #
501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConnectionHeaderParameter AWS API Documentation
502
+ #
503
+ class ConnectionHeaderParameter < Struct.new(
504
+ :key,
505
+ :value,
506
+ :is_value_secret)
507
+ SENSITIVE = []
508
+ include Aws::Structure
509
+ end
510
+
511
+ # Contains additional parameters for the connection.
512
+ #
513
+ # @!attribute [rw] header_parameters
514
+ # Contains additional header parameters for the connection.
515
+ # @return [Array<Types::ConnectionHeaderParameter>]
516
+ #
517
+ # @!attribute [rw] query_string_parameters
518
+ # Contains additional query string parameters for the connection.
519
+ # @return [Array<Types::ConnectionQueryStringParameter>]
520
+ #
521
+ # @!attribute [rw] body_parameters
522
+ # Contains additional body string parameters for the connection.
523
+ # @return [Array<Types::ConnectionBodyParameter>]
524
+ #
525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConnectionHttpParameters AWS API Documentation
526
+ #
527
+ class ConnectionHttpParameters < Struct.new(
528
+ :header_parameters,
529
+ :query_string_parameters,
530
+ :body_parameters)
531
+ SENSITIVE = []
532
+ include Aws::Structure
533
+ end
534
+
535
+ # Contains the client response parameters for the connection when OAuth
536
+ # is specified as the authorization type.
537
+ #
538
+ # @!attribute [rw] client_id
539
+ # The client ID associated with the response to the connection
540
+ # request.
541
+ # @return [String]
542
+ #
543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConnectionOAuthClientResponseParameters AWS API Documentation
544
+ #
545
+ class ConnectionOAuthClientResponseParameters < Struct.new(
546
+ :client_id)
547
+ SENSITIVE = []
548
+ include Aws::Structure
549
+ end
550
+
551
+ # Contains the response parameters when OAuth is specified as the
552
+ # authorization type.
553
+ #
554
+ # @!attribute [rw] client_parameters
555
+ # A `ConnectionOAuthClientResponseParameters` object that contains
556
+ # details about the client parameters returned when OAuth is specified
557
+ # as the authorization type.
558
+ # @return [Types::ConnectionOAuthClientResponseParameters]
559
+ #
560
+ # @!attribute [rw] authorization_endpoint
561
+ # The URL to the HTTP endpoint that authorized the request.
562
+ # @return [String]
563
+ #
564
+ # @!attribute [rw] http_method
565
+ # The method used to connect to the HTTP endpoint.
566
+ # @return [String]
567
+ #
568
+ # @!attribute [rw] o_auth_http_parameters
569
+ # The additional HTTP parameters used for the OAuth authorization
570
+ # request.
571
+ # @return [Types::ConnectionHttpParameters]
572
+ #
573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConnectionOAuthResponseParameters AWS API Documentation
574
+ #
575
+ class ConnectionOAuthResponseParameters < Struct.new(
576
+ :client_parameters,
577
+ :authorization_endpoint,
578
+ :http_method,
579
+ :o_auth_http_parameters)
276
580
  SENSITIVE = []
277
581
  include Aws::Structure
278
582
  end
279
583
 
280
- # @note When making an API call, you may pass CreatePartnerEventSourceRequest
281
- # data as a hash:
584
+ # Additional query string parameter for the connection. You can include
585
+ # up to 100 additional query string parameters per request. Each
586
+ # additional parameter counts towards the event payload size, which
587
+ # cannot exceed 64 KB.
588
+ #
589
+ # @!attribute [rw] key
590
+ # The key for a query string parameter.
591
+ # @return [String]
282
592
  #
283
- # {
284
- # name: "EventSourceName", # required
285
- # account: "AccountId", # required
286
- # }
593
+ # @!attribute [rw] value
594
+ # The value associated with the key for the query string parameter.
595
+ # @return [String]
596
+ #
597
+ # @!attribute [rw] is_value_secret
598
+ # Specifies whether the value is secret.
599
+ # @return [Boolean]
287
600
  #
601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ConnectionQueryStringParameter AWS API Documentation
602
+ #
603
+ class ConnectionQueryStringParameter < Struct.new(
604
+ :key,
605
+ :value,
606
+ :is_value_secret)
607
+ SENSITIVE = []
608
+ include Aws::Structure
609
+ end
610
+
288
611
  # @!attribute [rw] name
289
- # The name of the partner event source. This name must be unique and
290
- # must be in the format ` partner_name/event_namespace/event_name `.
291
- # The AWS account that wants to use this partner event source must
292
- # create a partner event bus with a name that matches the name of the
293
- # partner event source.
612
+ # The name for the API destination to create.
294
613
  # @return [String]
295
614
  #
296
- # @!attribute [rw] account
297
- # The AWS account ID that is permitted to create a matching partner
298
- # event bus for this partner event source.
615
+ # @!attribute [rw] description
616
+ # A description for the API destination to create.
299
617
  # @return [String]
300
618
  #
301
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
619
+ # @!attribute [rw] connection_arn
620
+ # The ARN of the connection to use for the API destination. The
621
+ # destination endpoint must support the authorization type specified
622
+ # for the connection.
623
+ # @return [String]
302
624
  #
303
- class CreatePartnerEventSourceRequest < Struct.new(
625
+ # @!attribute [rw] invocation_endpoint
626
+ # The URL to the HTTP invocation endpoint for the API destination.
627
+ # @return [String]
628
+ #
629
+ # @!attribute [rw] http_method
630
+ # The method to use for the request to the HTTP invocation endpoint.
631
+ # @return [String]
632
+ #
633
+ # @!attribute [rw] invocation_rate_limit_per_second
634
+ # The maximum number of requests per second to send to the HTTP
635
+ # invocation endpoint.
636
+ # @return [Integer]
637
+ #
638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateApiDestinationRequest AWS API Documentation
639
+ #
640
+ class CreateApiDestinationRequest < Struct.new(
304
641
  :name,
305
- :account)
642
+ :description,
643
+ :connection_arn,
644
+ :invocation_endpoint,
645
+ :http_method,
646
+ :invocation_rate_limit_per_second)
306
647
  SENSITIVE = []
307
648
  include Aws::Structure
308
649
  end
309
650
 
310
- # @!attribute [rw] event_source_arn
311
- # The ARN of the partner event source.
651
+ # @!attribute [rw] api_destination_arn
652
+ # The ARN of the API destination that was created by the request.
653
+ # @return [String]
654
+ #
655
+ # @!attribute [rw] api_destination_state
656
+ # The state of the API destination that was created by the request.
657
+ # @return [String]
658
+ #
659
+ # @!attribute [rw] creation_time
660
+ # A time stamp indicating the time that the API destination was
661
+ # created.
662
+ # @return [Time]
663
+ #
664
+ # @!attribute [rw] last_modified_time
665
+ # A time stamp indicating the time that the API destination was last
666
+ # modified.
667
+ # @return [Time]
668
+ #
669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateApiDestinationResponse AWS API Documentation
670
+ #
671
+ class CreateApiDestinationResponse < Struct.new(
672
+ :api_destination_arn,
673
+ :api_destination_state,
674
+ :creation_time,
675
+ :last_modified_time)
676
+ SENSITIVE = []
677
+ include Aws::Structure
678
+ end
679
+
680
+ # @!attribute [rw] archive_name
681
+ # The name for the archive to create.
682
+ # @return [String]
683
+ #
684
+ # @!attribute [rw] event_source_arn
685
+ # The ARN of the event bus that sends events to the archive.
686
+ # @return [String]
687
+ #
688
+ # @!attribute [rw] description
689
+ # A description for the archive.
690
+ # @return [String]
691
+ #
692
+ # @!attribute [rw] event_pattern
693
+ # An event pattern to use to filter events sent to the archive.
694
+ # @return [String]
695
+ #
696
+ # @!attribute [rw] retention_days
697
+ # The number of days to retain events for. Default value is 0. If set
698
+ # to 0, events are retained indefinitely
699
+ # @return [Integer]
700
+ #
701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateArchiveRequest AWS API Documentation
702
+ #
703
+ class CreateArchiveRequest < Struct.new(
704
+ :archive_name,
705
+ :event_source_arn,
706
+ :description,
707
+ :event_pattern,
708
+ :retention_days)
709
+ SENSITIVE = []
710
+ include Aws::Structure
711
+ end
712
+
713
+ # @!attribute [rw] archive_arn
714
+ # The ARN of the archive that was created.
715
+ # @return [String]
716
+ #
717
+ # @!attribute [rw] state
718
+ # The state of the archive that was created.
719
+ # @return [String]
720
+ #
721
+ # @!attribute [rw] state_reason
722
+ # The reason that the archive is in the state.
723
+ # @return [String]
724
+ #
725
+ # @!attribute [rw] creation_time
726
+ # The time at which the archive was created.
727
+ # @return [Time]
728
+ #
729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateArchiveResponse AWS API Documentation
730
+ #
731
+ class CreateArchiveResponse < Struct.new(
732
+ :archive_arn,
733
+ :state,
734
+ :state_reason,
735
+ :creation_time)
736
+ SENSITIVE = []
737
+ include Aws::Structure
738
+ end
739
+
740
+ # Contains the API key authorization parameters for the connection.
741
+ #
742
+ # @!attribute [rw] api_key_name
743
+ # The name of the API key to use for authorization.
744
+ # @return [String]
745
+ #
746
+ # @!attribute [rw] api_key_value
747
+ # The value for the API key to use for authorization.
748
+ # @return [String]
749
+ #
750
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateConnectionApiKeyAuthRequestParameters AWS API Documentation
751
+ #
752
+ class CreateConnectionApiKeyAuthRequestParameters < Struct.new(
753
+ :api_key_name,
754
+ :api_key_value)
755
+ SENSITIVE = []
756
+ include Aws::Structure
757
+ end
758
+
759
+ # Contains the authorization parameters for the connection.
760
+ #
761
+ # @!attribute [rw] basic_auth_parameters
762
+ # A `CreateConnectionBasicAuthRequestParameters` object that contains
763
+ # the Basic authorization parameters to use for the connection.
764
+ # @return [Types::CreateConnectionBasicAuthRequestParameters]
765
+ #
766
+ # @!attribute [rw] o_auth_parameters
767
+ # A `CreateConnectionOAuthRequestParameters` object that contains the
768
+ # OAuth authorization parameters to use for the connection.
769
+ # @return [Types::CreateConnectionOAuthRequestParameters]
770
+ #
771
+ # @!attribute [rw] api_key_auth_parameters
772
+ # A `CreateConnectionApiKeyAuthRequestParameters` object that contains
773
+ # the API key authorization parameters to use for the connection.
774
+ # @return [Types::CreateConnectionApiKeyAuthRequestParameters]
775
+ #
776
+ # @!attribute [rw] invocation_http_parameters
777
+ # A `ConnectionHttpParameters` object that contains the API key
778
+ # authorization parameters to use for the connection. Note that if you
779
+ # include additional parameters for the target of a rule via
780
+ # `HttpParameters`, including query strings, the parameters added for
781
+ # the connection take precedence.
782
+ # @return [Types::ConnectionHttpParameters]
783
+ #
784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateConnectionAuthRequestParameters AWS API Documentation
785
+ #
786
+ class CreateConnectionAuthRequestParameters < Struct.new(
787
+ :basic_auth_parameters,
788
+ :o_auth_parameters,
789
+ :api_key_auth_parameters,
790
+ :invocation_http_parameters)
791
+ SENSITIVE = []
792
+ include Aws::Structure
793
+ end
794
+
795
+ # Contains the Basic authorization parameters to use for the connection.
796
+ #
797
+ # @!attribute [rw] username
798
+ # The user name to use for Basic authorization.
799
+ # @return [String]
800
+ #
801
+ # @!attribute [rw] password
802
+ # The password associated with the user name to use for Basic
803
+ # authorization.
804
+ # @return [String]
805
+ #
806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateConnectionBasicAuthRequestParameters AWS API Documentation
807
+ #
808
+ class CreateConnectionBasicAuthRequestParameters < Struct.new(
809
+ :username,
810
+ :password)
811
+ SENSITIVE = []
812
+ include Aws::Structure
813
+ end
814
+
815
+ # Contains the Basic authorization parameters to use for the connection.
816
+ #
817
+ # @!attribute [rw] client_id
818
+ # The client ID to use for OAuth authorization for the connection.
819
+ # @return [String]
820
+ #
821
+ # @!attribute [rw] client_secret
822
+ # The client secret associated with the client ID to use for OAuth
823
+ # authorization for the connection.
824
+ # @return [String]
825
+ #
826
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateConnectionOAuthClientRequestParameters AWS API Documentation
827
+ #
828
+ class CreateConnectionOAuthClientRequestParameters < Struct.new(
829
+ :client_id,
830
+ :client_secret)
831
+ SENSITIVE = []
832
+ include Aws::Structure
833
+ end
834
+
835
+ # Contains the OAuth authorization parameters to use for the connection.
836
+ #
837
+ # @!attribute [rw] client_parameters
838
+ # A `CreateConnectionOAuthClientRequestParameters` object that
839
+ # contains the client parameters for OAuth authorization.
840
+ # @return [Types::CreateConnectionOAuthClientRequestParameters]
841
+ #
842
+ # @!attribute [rw] authorization_endpoint
843
+ # The URL to the authorization endpoint when OAuth is specified as the
844
+ # authorization type.
845
+ # @return [String]
846
+ #
847
+ # @!attribute [rw] http_method
848
+ # The method to use for the authorization request.
849
+ # @return [String]
850
+ #
851
+ # @!attribute [rw] o_auth_http_parameters
852
+ # A `ConnectionHttpParameters` object that contains details about the
853
+ # additional parameters to use for the connection.
854
+ # @return [Types::ConnectionHttpParameters]
855
+ #
856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateConnectionOAuthRequestParameters AWS API Documentation
857
+ #
858
+ class CreateConnectionOAuthRequestParameters < Struct.new(
859
+ :client_parameters,
860
+ :authorization_endpoint,
861
+ :http_method,
862
+ :o_auth_http_parameters)
863
+ SENSITIVE = []
864
+ include Aws::Structure
865
+ end
866
+
867
+ # @!attribute [rw] name
868
+ # The name for the connection to create.
869
+ # @return [String]
870
+ #
871
+ # @!attribute [rw] description
872
+ # A description for the connection to create.
873
+ # @return [String]
874
+ #
875
+ # @!attribute [rw] authorization_type
876
+ # The type of authorization to use for the connection.
877
+ # @return [String]
878
+ #
879
+ # @!attribute [rw] auth_parameters
880
+ # A `CreateConnectionAuthRequestParameters` object that contains the
881
+ # authorization parameters to use to authorize with the endpoint.
882
+ # @return [Types::CreateConnectionAuthRequestParameters]
883
+ #
884
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateConnectionRequest AWS API Documentation
885
+ #
886
+ class CreateConnectionRequest < Struct.new(
887
+ :name,
888
+ :description,
889
+ :authorization_type,
890
+ :auth_parameters)
891
+ SENSITIVE = []
892
+ include Aws::Structure
893
+ end
894
+
895
+ # @!attribute [rw] connection_arn
896
+ # The ARN of the connection that was created by the request.
897
+ # @return [String]
898
+ #
899
+ # @!attribute [rw] connection_state
900
+ # The state of the connection that was created by the request.
901
+ # @return [String]
902
+ #
903
+ # @!attribute [rw] creation_time
904
+ # A time stamp for the time that the connection was created.
905
+ # @return [Time]
906
+ #
907
+ # @!attribute [rw] last_modified_time
908
+ # A time stamp for the time that the connection was last updated.
909
+ # @return [Time]
910
+ #
911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateConnectionResponse AWS API Documentation
912
+ #
913
+ class CreateConnectionResponse < Struct.new(
914
+ :connection_arn,
915
+ :connection_state,
916
+ :creation_time,
917
+ :last_modified_time)
918
+ SENSITIVE = []
919
+ include Aws::Structure
920
+ end
921
+
922
+ # @!attribute [rw] name
923
+ # The name of the new event bus.
924
+ #
925
+ # Event bus names cannot contain the / character. You can't use the
926
+ # name `default` for a custom event bus, as this name is already used
927
+ # for your account's default event bus.
928
+ #
929
+ # If this is a partner event bus, the name must exactly match the name
930
+ # of the partner event source that this event bus is matched to.
931
+ # @return [String]
932
+ #
933
+ # @!attribute [rw] event_source_name
934
+ # If you are creating a partner event bus, this specifies the partner
935
+ # event source that the new event bus will be matched with.
936
+ # @return [String]
937
+ #
938
+ # @!attribute [rw] tags
939
+ # Tags to associate with the event bus.
940
+ # @return [Array<Types::Tag>]
941
+ #
942
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateEventBusRequest AWS API Documentation
943
+ #
944
+ class CreateEventBusRequest < Struct.new(
945
+ :name,
946
+ :event_source_name,
947
+ :tags)
948
+ SENSITIVE = []
949
+ include Aws::Structure
950
+ end
951
+
952
+ # @!attribute [rw] event_bus_arn
953
+ # The ARN of the new event bus.
954
+ # @return [String]
955
+ #
956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateEventBusResponse AWS API Documentation
957
+ #
958
+ class CreateEventBusResponse < Struct.new(
959
+ :event_bus_arn)
960
+ SENSITIVE = []
961
+ include Aws::Structure
962
+ end
963
+
964
+ # @!attribute [rw] name
965
+ # The name of the partner event source. This name must be unique and
966
+ # must be in the format ` partner_name/event_namespace/event_name `.
967
+ # The Amazon Web Services account that wants to use this partner event
968
+ # source must create a partner event bus with a name that matches the
969
+ # name of the partner event source.
970
+ # @return [String]
971
+ #
972
+ # @!attribute [rw] account
973
+ # The Amazon Web Services account ID that is permitted to create a
974
+ # matching partner event bus for this partner event source.
975
+ # @return [String]
976
+ #
977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
978
+ #
979
+ class CreatePartnerEventSourceRequest < Struct.new(
980
+ :name,
981
+ :account)
982
+ SENSITIVE = []
983
+ include Aws::Structure
984
+ end
985
+
986
+ # @!attribute [rw] event_source_arn
987
+ # The ARN of the partner event source.
988
+ # @return [String]
989
+ #
990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreatePartnerEventSourceResponse AWS API Documentation
991
+ #
992
+ class CreatePartnerEventSourceResponse < Struct.new(
993
+ :event_source_arn)
994
+ SENSITIVE = []
995
+ include Aws::Structure
996
+ end
997
+
998
+ # @!attribute [rw] name
999
+ # The name of the partner event source to deactivate.
1000
+ # @return [String]
1001
+ #
1002
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeactivateEventSourceRequest AWS API Documentation
1003
+ #
1004
+ class DeactivateEventSourceRequest < Struct.new(
1005
+ :name)
1006
+ SENSITIVE = []
1007
+ include Aws::Structure
1008
+ end
1009
+
1010
+ # A `DeadLetterConfig` object that contains information about a
1011
+ # dead-letter queue configuration.
1012
+ #
1013
+ # @!attribute [rw] arn
1014
+ # The ARN of the SQS queue specified as the target for the dead-letter
1015
+ # queue.
1016
+ # @return [String]
1017
+ #
1018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeadLetterConfig AWS API Documentation
1019
+ #
1020
+ class DeadLetterConfig < Struct.new(
1021
+ :arn)
1022
+ SENSITIVE = []
1023
+ include Aws::Structure
1024
+ end
1025
+
1026
+ # @!attribute [rw] name
1027
+ # The name of the connection to remove authorization from.
1028
+ # @return [String]
1029
+ #
1030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeauthorizeConnectionRequest AWS API Documentation
1031
+ #
1032
+ class DeauthorizeConnectionRequest < Struct.new(
1033
+ :name)
1034
+ SENSITIVE = []
1035
+ include Aws::Structure
1036
+ end
1037
+
1038
+ # @!attribute [rw] connection_arn
1039
+ # The ARN of the connection that authorization was removed from.
1040
+ # @return [String]
1041
+ #
1042
+ # @!attribute [rw] connection_state
1043
+ # The state of the connection.
1044
+ # @return [String]
1045
+ #
1046
+ # @!attribute [rw] creation_time
1047
+ # A time stamp for the time that the connection was created.
1048
+ # @return [Time]
1049
+ #
1050
+ # @!attribute [rw] last_modified_time
1051
+ # A time stamp for the time that the connection was last updated.
1052
+ # @return [Time]
1053
+ #
1054
+ # @!attribute [rw] last_authorized_time
1055
+ # A time stamp for the time that the connection was last authorized.
1056
+ # @return [Time]
1057
+ #
1058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeauthorizeConnectionResponse AWS API Documentation
1059
+ #
1060
+ class DeauthorizeConnectionResponse < Struct.new(
1061
+ :connection_arn,
1062
+ :connection_state,
1063
+ :creation_time,
1064
+ :last_modified_time,
1065
+ :last_authorized_time)
1066
+ SENSITIVE = []
1067
+ include Aws::Structure
1068
+ end
1069
+
1070
+ # @!attribute [rw] name
1071
+ # The name of the destination to delete.
1072
+ # @return [String]
1073
+ #
1074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteApiDestinationRequest AWS API Documentation
1075
+ #
1076
+ class DeleteApiDestinationRequest < Struct.new(
1077
+ :name)
1078
+ SENSITIVE = []
1079
+ include Aws::Structure
1080
+ end
1081
+
1082
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteApiDestinationResponse AWS API Documentation
1083
+ #
1084
+ class DeleteApiDestinationResponse < Aws::EmptyStructure; end
1085
+
1086
+ # @!attribute [rw] archive_name
1087
+ # The name of the archive to delete.
1088
+ # @return [String]
1089
+ #
1090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteArchiveRequest AWS API Documentation
1091
+ #
1092
+ class DeleteArchiveRequest < Struct.new(
1093
+ :archive_name)
1094
+ SENSITIVE = []
1095
+ include Aws::Structure
1096
+ end
1097
+
1098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteArchiveResponse AWS API Documentation
1099
+ #
1100
+ class DeleteArchiveResponse < Aws::EmptyStructure; end
1101
+
1102
+ # @!attribute [rw] name
1103
+ # The name of the connection to delete.
1104
+ # @return [String]
1105
+ #
1106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteConnectionRequest AWS API Documentation
1107
+ #
1108
+ class DeleteConnectionRequest < Struct.new(
1109
+ :name)
1110
+ SENSITIVE = []
1111
+ include Aws::Structure
1112
+ end
1113
+
1114
+ # @!attribute [rw] connection_arn
1115
+ # The ARN of the connection that was deleted.
1116
+ # @return [String]
1117
+ #
1118
+ # @!attribute [rw] connection_state
1119
+ # The state of the connection before it was deleted.
1120
+ # @return [String]
1121
+ #
1122
+ # @!attribute [rw] creation_time
1123
+ # A time stamp for the time that the connection was created.
1124
+ # @return [Time]
1125
+ #
1126
+ # @!attribute [rw] last_modified_time
1127
+ # A time stamp for the time that the connection was last modified
1128
+ # before it was deleted.
1129
+ # @return [Time]
1130
+ #
1131
+ # @!attribute [rw] last_authorized_time
1132
+ # A time stamp for the time that the connection was last authorized
1133
+ # before it wa deleted.
1134
+ # @return [Time]
1135
+ #
1136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteConnectionResponse AWS API Documentation
1137
+ #
1138
+ class DeleteConnectionResponse < Struct.new(
1139
+ :connection_arn,
1140
+ :connection_state,
1141
+ :creation_time,
1142
+ :last_modified_time,
1143
+ :last_authorized_time)
1144
+ SENSITIVE = []
1145
+ include Aws::Structure
1146
+ end
1147
+
1148
+ # @!attribute [rw] name
1149
+ # The name of the event bus to delete.
1150
+ # @return [String]
1151
+ #
1152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteEventBusRequest AWS API Documentation
1153
+ #
1154
+ class DeleteEventBusRequest < Struct.new(
1155
+ :name)
1156
+ SENSITIVE = []
1157
+ include Aws::Structure
1158
+ end
1159
+
1160
+ # @!attribute [rw] name
1161
+ # The name of the event source to delete.
1162
+ # @return [String]
1163
+ #
1164
+ # @!attribute [rw] account
1165
+ # The Amazon Web Services account ID of the Amazon Web Services
1166
+ # customer that the event source was created for.
1167
+ # @return [String]
1168
+ #
1169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
1170
+ #
1171
+ class DeletePartnerEventSourceRequest < Struct.new(
1172
+ :name,
1173
+ :account)
1174
+ SENSITIVE = []
1175
+ include Aws::Structure
1176
+ end
1177
+
1178
+ # @!attribute [rw] name
1179
+ # The name of the rule.
1180
+ # @return [String]
1181
+ #
1182
+ # @!attribute [rw] event_bus_name
1183
+ # The name or ARN of the event bus associated with the rule. If you
1184
+ # omit this, the default event bus is used.
1185
+ # @return [String]
1186
+ #
1187
+ # @!attribute [rw] force
1188
+ # If this is a managed rule, created by an Amazon Web Services service
1189
+ # on your behalf, you must specify `Force` as `True` to delete the
1190
+ # rule. This parameter is ignored for rules that are not managed
1191
+ # rules. You can check whether a rule is a managed rule by using
1192
+ # `DescribeRule` or `ListRules` and checking the `ManagedBy` field of
1193
+ # the response.
1194
+ # @return [Boolean]
1195
+ #
1196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteRuleRequest AWS API Documentation
1197
+ #
1198
+ class DeleteRuleRequest < Struct.new(
1199
+ :name,
1200
+ :event_bus_name,
1201
+ :force)
1202
+ SENSITIVE = []
1203
+ include Aws::Structure
1204
+ end
1205
+
1206
+ # @!attribute [rw] name
1207
+ # The name of the API destination to retrieve.
1208
+ # @return [String]
1209
+ #
1210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeApiDestinationRequest AWS API Documentation
1211
+ #
1212
+ class DescribeApiDestinationRequest < Struct.new(
1213
+ :name)
1214
+ SENSITIVE = []
1215
+ include Aws::Structure
1216
+ end
1217
+
1218
+ # @!attribute [rw] api_destination_arn
1219
+ # The ARN of the API destination retrieved.
1220
+ # @return [String]
1221
+ #
1222
+ # @!attribute [rw] name
1223
+ # The name of the API destination retrieved.
1224
+ # @return [String]
1225
+ #
1226
+ # @!attribute [rw] description
1227
+ # The description for the API destination retrieved.
1228
+ # @return [String]
1229
+ #
1230
+ # @!attribute [rw] api_destination_state
1231
+ # The state of the API destination retrieved.
1232
+ # @return [String]
1233
+ #
1234
+ # @!attribute [rw] connection_arn
1235
+ # The ARN of the connection specified for the API destination
1236
+ # retrieved.
1237
+ # @return [String]
1238
+ #
1239
+ # @!attribute [rw] invocation_endpoint
1240
+ # The URL to use to connect to the HTTP endpoint.
1241
+ # @return [String]
1242
+ #
1243
+ # @!attribute [rw] http_method
1244
+ # The method to use to connect to the HTTP endpoint.
1245
+ # @return [String]
1246
+ #
1247
+ # @!attribute [rw] invocation_rate_limit_per_second
1248
+ # The maximum number of invocations per second to specified for the
1249
+ # API destination. Note that if you set the invocation rate maximum to
1250
+ # a value lower the rate necessary to send all events received on to
1251
+ # the destination HTTP endpoint, some events may not be delivered
1252
+ # within the 24-hour retry window. If you plan to set the rate lower
1253
+ # than the rate necessary to deliver all events, consider using a
1254
+ # dead-letter queue to catch events that are not delivered within 24
1255
+ # hours.
1256
+ # @return [Integer]
1257
+ #
1258
+ # @!attribute [rw] creation_time
1259
+ # A time stamp for the time that the API destination was created.
1260
+ # @return [Time]
1261
+ #
1262
+ # @!attribute [rw] last_modified_time
1263
+ # A time stamp for the time that the API destination was last
1264
+ # modified.
1265
+ # @return [Time]
1266
+ #
1267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeApiDestinationResponse AWS API Documentation
1268
+ #
1269
+ class DescribeApiDestinationResponse < Struct.new(
1270
+ :api_destination_arn,
1271
+ :name,
1272
+ :description,
1273
+ :api_destination_state,
1274
+ :connection_arn,
1275
+ :invocation_endpoint,
1276
+ :http_method,
1277
+ :invocation_rate_limit_per_second,
1278
+ :creation_time,
1279
+ :last_modified_time)
1280
+ SENSITIVE = []
1281
+ include Aws::Structure
1282
+ end
1283
+
1284
+ # @!attribute [rw] archive_name
1285
+ # The name of the archive to retrieve.
1286
+ # @return [String]
1287
+ #
1288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeArchiveRequest AWS API Documentation
1289
+ #
1290
+ class DescribeArchiveRequest < Struct.new(
1291
+ :archive_name)
1292
+ SENSITIVE = []
1293
+ include Aws::Structure
1294
+ end
1295
+
1296
+ # @!attribute [rw] archive_arn
1297
+ # The ARN of the archive.
1298
+ # @return [String]
1299
+ #
1300
+ # @!attribute [rw] archive_name
1301
+ # The name of the archive.
1302
+ # @return [String]
1303
+ #
1304
+ # @!attribute [rw] event_source_arn
1305
+ # The ARN of the event source associated with the archive.
1306
+ # @return [String]
1307
+ #
1308
+ # @!attribute [rw] description
1309
+ # The description of the archive.
1310
+ # @return [String]
1311
+ #
1312
+ # @!attribute [rw] event_pattern
1313
+ # The event pattern used to filter events sent to the archive.
1314
+ # @return [String]
1315
+ #
1316
+ # @!attribute [rw] state
1317
+ # The state of the archive.
1318
+ # @return [String]
1319
+ #
1320
+ # @!attribute [rw] state_reason
1321
+ # The reason that the archive is in the state.
312
1322
  # @return [String]
313
1323
  #
314
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreatePartnerEventSourceResponse AWS API Documentation
1324
+ # @!attribute [rw] retention_days
1325
+ # The number of days to retain events for in the archive.
1326
+ # @return [Integer]
315
1327
  #
316
- class CreatePartnerEventSourceResponse < Struct.new(
317
- :event_source_arn)
318
- SENSITIVE = []
319
- include Aws::Structure
320
- end
321
-
322
- # @note When making an API call, you may pass DeactivateEventSourceRequest
323
- # data as a hash:
1328
+ # @!attribute [rw] size_bytes
1329
+ # The size of the archive in bytes.
1330
+ # @return [Integer]
324
1331
  #
325
- # {
326
- # name: "EventSourceName", # required
327
- # }
1332
+ # @!attribute [rw] event_count
1333
+ # The number of events in the archive.
1334
+ # @return [Integer]
328
1335
  #
329
- # @!attribute [rw] name
330
- # The name of the partner event source to deactivate.
331
- # @return [String]
1336
+ # @!attribute [rw] creation_time
1337
+ # The time at which the archive was created.
1338
+ # @return [Time]
332
1339
  #
333
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeactivateEventSourceRequest AWS API Documentation
1340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeArchiveResponse AWS API Documentation
334
1341
  #
335
- class DeactivateEventSourceRequest < Struct.new(
336
- :name)
1342
+ class DescribeArchiveResponse < Struct.new(
1343
+ :archive_arn,
1344
+ :archive_name,
1345
+ :event_source_arn,
1346
+ :description,
1347
+ :event_pattern,
1348
+ :state,
1349
+ :state_reason,
1350
+ :retention_days,
1351
+ :size_bytes,
1352
+ :event_count,
1353
+ :creation_time)
337
1354
  SENSITIVE = []
338
1355
  include Aws::Structure
339
1356
  end
340
1357
 
341
- # @note When making an API call, you may pass DeleteEventBusRequest
342
- # data as a hash:
343
- #
344
- # {
345
- # name: "EventBusName", # required
346
- # }
347
- #
348
1358
  # @!attribute [rw] name
349
- # The name of the event bus to delete.
1359
+ # The name of the connection to retrieve.
350
1360
  # @return [String]
351
1361
  #
352
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteEventBusRequest AWS API Documentation
1362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeConnectionRequest AWS API Documentation
353
1363
  #
354
- class DeleteEventBusRequest < Struct.new(
1364
+ class DescribeConnectionRequest < Struct.new(
355
1365
  :name)
356
1366
  SENSITIVE = []
357
1367
  include Aws::Structure
358
1368
  end
359
1369
 
360
- # @note When making an API call, you may pass DeletePartnerEventSourceRequest
361
- # data as a hash:
362
- #
363
- # {
364
- # name: "EventSourceName", # required
365
- # account: "AccountId", # required
366
- # }
1370
+ # @!attribute [rw] connection_arn
1371
+ # The ARN of the connection retrieved.
1372
+ # @return [String]
367
1373
  #
368
1374
  # @!attribute [rw] name
369
- # The name of the event source to delete.
1375
+ # The name of the connection retrieved.
370
1376
  # @return [String]
371
1377
  #
372
- # @!attribute [rw] account
373
- # The AWS account ID of the AWS customer that the event source was
374
- # created for.
1378
+ # @!attribute [rw] description
1379
+ # The description for the connection retrieved.
375
1380
  # @return [String]
376
1381
  #
377
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
378
- #
379
- class DeletePartnerEventSourceRequest < Struct.new(
380
- :name,
381
- :account)
382
- SENSITIVE = []
383
- include Aws::Structure
384
- end
385
-
386
- # @note When making an API call, you may pass DeleteRuleRequest
387
- # data as a hash:
1382
+ # @!attribute [rw] connection_state
1383
+ # The state of the connection retrieved.
1384
+ # @return [String]
388
1385
  #
389
- # {
390
- # name: "RuleName", # required
391
- # event_bus_name: "EventBusName",
392
- # force: false,
393
- # }
1386
+ # @!attribute [rw] state_reason
1387
+ # The reason that the connection is in the current connection state.
1388
+ # @return [String]
394
1389
  #
395
- # @!attribute [rw] name
396
- # The name of the rule.
1390
+ # @!attribute [rw] authorization_type
1391
+ # The type of authorization specified for the connection.
397
1392
  # @return [String]
398
1393
  #
399
- # @!attribute [rw] event_bus_name
400
- # The event bus associated with the rule. If you omit this, the
401
- # default event bus is used.
1394
+ # @!attribute [rw] secret_arn
1395
+ # The ARN of the secret created from the authorization parameters
1396
+ # specified for the connection.
402
1397
  # @return [String]
403
1398
  #
404
- # @!attribute [rw] force
405
- # If this is a managed rule, created by an AWS service on your behalf,
406
- # you must specify `Force` as `True` to delete the rule. This
407
- # parameter is ignored for rules that are not managed rules. You can
408
- # check whether a rule is a managed rule by using `DescribeRule` or
409
- # `ListRules` and checking the `ManagedBy` field of the response.
410
- # @return [Boolean]
1399
+ # @!attribute [rw] auth_parameters
1400
+ # The parameters to use for authorization for the connection.
1401
+ # @return [Types::ConnectionAuthResponseParameters]
411
1402
  #
412
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteRuleRequest AWS API Documentation
1403
+ # @!attribute [rw] creation_time
1404
+ # A time stamp for the time that the connection was created.
1405
+ # @return [Time]
413
1406
  #
414
- class DeleteRuleRequest < Struct.new(
1407
+ # @!attribute [rw] last_modified_time
1408
+ # A time stamp for the time that the connection was last modified.
1409
+ # @return [Time]
1410
+ #
1411
+ # @!attribute [rw] last_authorized_time
1412
+ # A time stamp for the time that the connection was last authorized.
1413
+ # @return [Time]
1414
+ #
1415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeConnectionResponse AWS API Documentation
1416
+ #
1417
+ class DescribeConnectionResponse < Struct.new(
1418
+ :connection_arn,
415
1419
  :name,
416
- :event_bus_name,
417
- :force)
1420
+ :description,
1421
+ :connection_state,
1422
+ :state_reason,
1423
+ :authorization_type,
1424
+ :secret_arn,
1425
+ :auth_parameters,
1426
+ :creation_time,
1427
+ :last_modified_time,
1428
+ :last_authorized_time)
418
1429
  SENSITIVE = []
419
1430
  include Aws::Structure
420
1431
  end
421
1432
 
422
- # @note When making an API call, you may pass DescribeEventBusRequest
423
- # data as a hash:
424
- #
425
- # {
426
- # name: "EventBusName",
427
- # }
428
- #
429
1433
  # @!attribute [rw] name
430
- # The name of the event bus to show details for. If you omit this, the
431
- # default event bus is displayed.
1434
+ # The name or ARN of the event bus to show details for. If you omit
1435
+ # this, the default event bus is displayed.
432
1436
  # @return [String]
433
1437
  #
434
1438
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventBusRequest AWS API Documentation
@@ -463,13 +1467,6 @@ module Aws::CloudWatchEvents
463
1467
  include Aws::Structure
464
1468
  end
465
1469
 
466
- # @note When making an API call, you may pass DescribeEventSourceRequest
467
- # data as a hash:
468
- #
469
- # {
470
- # name: "EventSourceName", # required
471
- # }
472
- #
473
1470
  # @!attribute [rw] name
474
1471
  # The name of the partner event source to display the details of.
475
1472
  # @return [String]
@@ -525,13 +1522,6 @@ module Aws::CloudWatchEvents
525
1522
  include Aws::Structure
526
1523
  end
527
1524
 
528
- # @note When making an API call, you may pass DescribePartnerEventSourceRequest
529
- # data as a hash:
530
- #
531
- # {
532
- # name: "EventSourceName", # required
533
- # }
534
- #
535
1525
  # @!attribute [rw] name
536
1526
  # The name of the event source to display.
537
1527
  # @return [String]
@@ -561,21 +1551,94 @@ module Aws::CloudWatchEvents
561
1551
  include Aws::Structure
562
1552
  end
563
1553
 
564
- # @note When making an API call, you may pass DescribeRuleRequest
565
- # data as a hash:
1554
+ # @!attribute [rw] replay_name
1555
+ # The name of the replay to retrieve.
1556
+ # @return [String]
1557
+ #
1558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeReplayRequest AWS API Documentation
1559
+ #
1560
+ class DescribeReplayRequest < Struct.new(
1561
+ :replay_name)
1562
+ SENSITIVE = []
1563
+ include Aws::Structure
1564
+ end
1565
+
1566
+ # @!attribute [rw] replay_name
1567
+ # The name of the replay.
1568
+ # @return [String]
1569
+ #
1570
+ # @!attribute [rw] replay_arn
1571
+ # The ARN of the replay.
1572
+ # @return [String]
1573
+ #
1574
+ # @!attribute [rw] description
1575
+ # The description of the replay.
1576
+ # @return [String]
1577
+ #
1578
+ # @!attribute [rw] state
1579
+ # The current state of the replay.
1580
+ # @return [String]
1581
+ #
1582
+ # @!attribute [rw] state_reason
1583
+ # The reason that the replay is in the current state.
1584
+ # @return [String]
1585
+ #
1586
+ # @!attribute [rw] event_source_arn
1587
+ # The ARN of the archive events were replayed from.
1588
+ # @return [String]
1589
+ #
1590
+ # @!attribute [rw] destination
1591
+ # A `ReplayDestination` object that contains details about the replay.
1592
+ # @return [Types::ReplayDestination]
1593
+ #
1594
+ # @!attribute [rw] event_start_time
1595
+ # The time stamp of the first event that was last replayed from the
1596
+ # archive.
1597
+ # @return [Time]
1598
+ #
1599
+ # @!attribute [rw] event_end_time
1600
+ # The time stamp for the last event that was replayed from the
1601
+ # archive.
1602
+ # @return [Time]
1603
+ #
1604
+ # @!attribute [rw] event_last_replayed_time
1605
+ # The time that the event was last replayed.
1606
+ # @return [Time]
1607
+ #
1608
+ # @!attribute [rw] replay_start_time
1609
+ # A time stamp for the time that the replay started.
1610
+ # @return [Time]
1611
+ #
1612
+ # @!attribute [rw] replay_end_time
1613
+ # A time stamp for the time that the replay stopped.
1614
+ # @return [Time]
566
1615
  #
567
- # {
568
- # name: "RuleName", # required
569
- # event_bus_name: "EventBusName",
570
- # }
1616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeReplayResponse AWS API Documentation
571
1617
  #
1618
+ class DescribeReplayResponse < Struct.new(
1619
+ :replay_name,
1620
+ :replay_arn,
1621
+ :description,
1622
+ :state,
1623
+ :state_reason,
1624
+ :event_source_arn,
1625
+ :destination,
1626
+ :event_start_time,
1627
+ :event_end_time,
1628
+ :event_last_replayed_time,
1629
+ :replay_start_time,
1630
+ :replay_end_time)
1631
+ SENSITIVE = []
1632
+ include Aws::Structure
1633
+ end
1634
+
572
1635
  # @!attribute [rw] name
573
1636
  # The name of the rule.
574
1637
  # @return [String]
575
1638
  #
576
1639
  # @!attribute [rw] event_bus_name
577
- # The event bus associated with the rule. If you omit this, the
578
- # default event bus is used.
1640
+ # The name or ARN of the event bus associated with the rule. If you
1641
+ # omit this, the default event bus is used.
579
1642
  # @return [String]
580
1643
  #
581
1644
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRuleRequest AWS API Documentation
@@ -623,13 +1686,22 @@ module Aws::CloudWatchEvents
623
1686
  # @return [String]
624
1687
  #
625
1688
  # @!attribute [rw] managed_by
626
- # If this is a managed rule, created by an AWS service on your behalf,
627
- # this field displays the principal name of the AWS service that
628
- # created the rule.
1689
+ # If this is a managed rule, created by an Amazon Web Services service
1690
+ # on your behalf, this field displays the principal name of the Amazon
1691
+ # Web Services service that created the rule.
629
1692
  # @return [String]
630
1693
  #
631
1694
  # @!attribute [rw] event_bus_name
632
- # The event bus associated with the rule.
1695
+ # The name of the event bus associated with the rule.
1696
+ # @return [String]
1697
+ #
1698
+ # @!attribute [rw] created_by
1699
+ # The account ID of the user that created the rule. If you use
1700
+ # `PutRule` to put a rule on an event bus in another account, the
1701
+ # other account is the owner of the rule, and the rule ARN includes
1702
+ # the account ID for that account. However, the value for `CreatedBy`
1703
+ # is the account ID as the account that created the rule in the other
1704
+ # account.
633
1705
  # @return [String]
634
1706
  #
635
1707
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRuleResponse AWS API Documentation
@@ -643,26 +1715,19 @@ module Aws::CloudWatchEvents
643
1715
  :description,
644
1716
  :role_arn,
645
1717
  :managed_by,
646
- :event_bus_name)
1718
+ :event_bus_name,
1719
+ :created_by)
647
1720
  SENSITIVE = []
648
1721
  include Aws::Structure
649
1722
  end
650
1723
 
651
- # @note When making an API call, you may pass DisableRuleRequest
652
- # data as a hash:
653
- #
654
- # {
655
- # name: "RuleName", # required
656
- # event_bus_name: "EventBusName",
657
- # }
658
- #
659
1724
  # @!attribute [rw] name
660
1725
  # The name of the rule.
661
1726
  # @return [String]
662
1727
  #
663
1728
  # @!attribute [rw] event_bus_name
664
- # The event bus associated with the rule. If you omit this, the
665
- # default event bus is used.
1729
+ # The name or ARN of the event bus associated with the rule. If you
1730
+ # omit this, the default event bus is used.
666
1731
  # @return [String]
667
1732
  #
668
1733
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRuleRequest AWS API Documentation
@@ -677,24 +1742,6 @@ module Aws::CloudWatchEvents
677
1742
  # The custom parameters to be used when the target is an Amazon ECS
678
1743
  # task.
679
1744
  #
680
- # @note When making an API call, you may pass EcsParameters
681
- # data as a hash:
682
- #
683
- # {
684
- # task_definition_arn: "Arn", # required
685
- # task_count: 1,
686
- # launch_type: "EC2", # accepts EC2, FARGATE
687
- # network_configuration: {
688
- # awsvpc_configuration: {
689
- # subnets: ["String"], # required
690
- # security_groups: ["String"],
691
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
692
- # },
693
- # },
694
- # platform_version: "String",
695
- # group: "String",
696
- # }
697
- #
698
1745
  # @!attribute [rw] task_definition_arn
699
1746
  # The ARN of the task definition to use if the event target is an
700
1747
  # Amazon ECS task.
@@ -709,9 +1756,9 @@ module Aws::CloudWatchEvents
709
1756
  # Specifies the launch type on which your task is running. The launch
710
1757
  # type that you specify here must match one of the launch type
711
1758
  # (compatibilities) of the target task. The `FARGATE` value is
712
- # supported only in the Regions where AWS Fargate with Amazon ECS is
713
- # supported. For more information, see [AWS Fargate on Amazon ECS][1]
714
- # in the *Amazon Elastic Container Service Developer Guide*.
1759
+ # supported only in the Regions where Fargate witt Amazon ECS is
1760
+ # supported. For more information, see [Fargate on Amazon ECS][1] in
1761
+ # the *Amazon Elastic Container Service Developer Guide*.
715
1762
  #
716
1763
  #
717
1764
  #
@@ -719,8 +1766,8 @@ module Aws::CloudWatchEvents
719
1766
  # @return [String]
720
1767
  #
721
1768
  # @!attribute [rw] network_configuration
722
- # Use this structure if the ECS task uses the `awsvpc` network mode.
723
- # This structure specifies the VPC subnets and security groups
1769
+ # Use this structure if the Amazon ECS task uses the `awsvpc` network
1770
+ # mode. This structure specifies the VPC subnets and security groups
724
1771
  # associated with the task, and whether a public IP address is to be
725
1772
  # used. This structure is required if `LaunchType` is `FARGATE`
726
1773
  # because the `awsvpc` mode is required for Fargate tasks.
@@ -734,7 +1781,7 @@ module Aws::CloudWatchEvents
734
1781
  # numeric portion of the platform version, such as `1.1.0`.
735
1782
  #
736
1783
  # This structure is used only if `LaunchType` is `FARGATE`. For more
737
- # information about valid platform versions, see [AWS Fargate Platform
1784
+ # information about valid platform versions, see [Fargate Platform
738
1785
  # Versions][1] in the *Amazon Elastic Container Service Developer
739
1786
  # Guide*.
740
1787
  #
@@ -748,6 +1795,64 @@ module Aws::CloudWatchEvents
748
1795
  # characters.
749
1796
  # @return [String]
750
1797
  #
1798
+ # @!attribute [rw] capacity_provider_strategy
1799
+ # The capacity provider strategy to use for the task.
1800
+ #
1801
+ # If a `capacityProviderStrategy` is specified, the `launchType`
1802
+ # parameter must be omitted. If no `capacityProviderStrategy` or
1803
+ # launchType is specified, the `defaultCapacityProviderStrategy` for
1804
+ # the cluster is used.
1805
+ # @return [Array<Types::CapacityProviderStrategyItem>]
1806
+ #
1807
+ # @!attribute [rw] enable_ecs_managed_tags
1808
+ # Specifies whether to enable Amazon ECS managed tags for the task.
1809
+ # For more information, see [Tagging Your Amazon ECS Resources][1] in
1810
+ # the Amazon Elastic Container Service Developer Guide.
1811
+ #
1812
+ #
1813
+ #
1814
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
1815
+ # @return [Boolean]
1816
+ #
1817
+ # @!attribute [rw] enable_execute_command
1818
+ # Whether or not to enable the execute command functionality for the
1819
+ # containers in this task. If true, this enables execute command
1820
+ # functionality on all containers in the task.
1821
+ # @return [Boolean]
1822
+ #
1823
+ # @!attribute [rw] placement_constraints
1824
+ # An array of placement constraint objects to use for the task. You
1825
+ # can specify up to 10 constraints per task (including constraints in
1826
+ # the task definition and those specified at runtime).
1827
+ # @return [Array<Types::PlacementConstraint>]
1828
+ #
1829
+ # @!attribute [rw] placement_strategy
1830
+ # The placement strategy objects to use for the task. You can specify
1831
+ # a maximum of five strategy rules per task.
1832
+ # @return [Array<Types::PlacementStrategy>]
1833
+ #
1834
+ # @!attribute [rw] propagate_tags
1835
+ # Specifies whether to propagate the tags from the task definition to
1836
+ # the task. If no value is specified, the tags are not propagated.
1837
+ # Tags can only be propagated to the task during task creation. To add
1838
+ # tags to a task after task creation, use the TagResource API action.
1839
+ # @return [String]
1840
+ #
1841
+ # @!attribute [rw] reference_id
1842
+ # The reference ID to use for the task.
1843
+ # @return [String]
1844
+ #
1845
+ # @!attribute [rw] tags
1846
+ # The metadata that you apply to the task to help you categorize and
1847
+ # organize them. Each tag consists of a key and an optional value,
1848
+ # both of which you define. To learn more, see [RunTask][1] in the
1849
+ # Amazon ECS API Reference.
1850
+ #
1851
+ #
1852
+ #
1853
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags
1854
+ # @return [Array<Types::Tag>]
1855
+ #
751
1856
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EcsParameters AWS API Documentation
752
1857
  #
753
1858
  class EcsParameters < Struct.new(
@@ -756,26 +1861,26 @@ module Aws::CloudWatchEvents
756
1861
  :launch_type,
757
1862
  :network_configuration,
758
1863
  :platform_version,
759
- :group)
1864
+ :group,
1865
+ :capacity_provider_strategy,
1866
+ :enable_ecs_managed_tags,
1867
+ :enable_execute_command,
1868
+ :placement_constraints,
1869
+ :placement_strategy,
1870
+ :propagate_tags,
1871
+ :reference_id,
1872
+ :tags)
760
1873
  SENSITIVE = []
761
1874
  include Aws::Structure
762
1875
  end
763
1876
 
764
- # @note When making an API call, you may pass EnableRuleRequest
765
- # data as a hash:
766
- #
767
- # {
768
- # name: "RuleName", # required
769
- # event_bus_name: "EventBusName",
770
- # }
771
- #
772
1877
  # @!attribute [rw] name
773
1878
  # The name of the rule.
774
1879
  # @return [String]
775
1880
  #
776
1881
  # @!attribute [rw] event_bus_name
777
- # The event bus associated with the rule. If you omit this, the
778
- # default event bus is used.
1882
+ # The name or ARN of the event bus associated with the rule. If you
1883
+ # omit this, the default event bus is used.
779
1884
  # @return [String]
780
1885
  #
781
1886
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRuleRequest AWS API Documentation
@@ -789,8 +1894,8 @@ module Aws::CloudWatchEvents
789
1894
 
790
1895
  # An event bus receives events from a source and routes them to rules
791
1896
  # associated with that event bus. Your account's default event bus
792
- # receives rules from AWS services. A custom event bus can receive rules
793
- # from AWS services as well as your custom applications and services. A
1897
+ # receives events from Amazon Web Services services. A custom event bus
1898
+ # can receive events from your custom applications and services. A
794
1899
  # partner event bus receives events from an event source created by an
795
1900
  # SaaS partner. These events come from the partners services or
796
1901
  # applications.
@@ -804,8 +1909,8 @@ module Aws::CloudWatchEvents
804
1909
  # @return [String]
805
1910
  #
806
1911
  # @!attribute [rw] policy
807
- # The permissions policy of the event bus, describing which other AWS
808
- # accounts can write events to this event bus.
1912
+ # The permissions policy of the event bus, describing which other
1913
+ # Amazon Web Services accounts can write events to this event bus.
809
1914
  # @return [String]
810
1915
  #
811
1916
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EventBus AWS API Documentation
@@ -819,9 +1924,9 @@ module Aws::CloudWatchEvents
819
1924
  end
820
1925
 
821
1926
  # A partner event source is created by an SaaS partner. If a customer
822
- # creates a partner event bus that matches this event source, that AWS
823
- # account can receive events from the partner's applications or
824
- # services.
1927
+ # creates a partner event bus that matches this event source, that
1928
+ # Amazon Web Services account can receive events from the partner's
1929
+ # applications or services.
825
1930
  #
826
1931
  # @!attribute [rw] arn
827
1932
  # The ARN of the event source.
@@ -836,8 +1941,8 @@ module Aws::CloudWatchEvents
836
1941
  # @return [Time]
837
1942
  #
838
1943
  # @!attribute [rw] expiration_time
839
- # The date and time that the event source will expire, if the AWS
840
- # account doesn't create a matching event bus for it.
1944
+ # The date and time that the event source will expire, if the Amazon
1945
+ # Web Services account doesn't create a matching event bus for it.
841
1946
  # @return [Time]
842
1947
  #
843
1948
  # @!attribute [rw] name
@@ -867,34 +1972,23 @@ module Aws::CloudWatchEvents
867
1972
  end
868
1973
 
869
1974
  # These are custom parameter to be used when the target is an API
870
- # Gateway REST APIs.
871
- #
872
- # @note When making an API call, you may pass HttpParameters
873
- # data as a hash:
874
- #
875
- # {
876
- # path_parameter_values: ["PathParameter"],
877
- # header_parameters: {
878
- # "HeaderKey" => "HeaderValue",
879
- # },
880
- # query_string_parameters: {
881
- # "QueryStringKey" => "QueryStringValue",
882
- # },
883
- # }
1975
+ # Gateway REST APIs or EventBridge ApiDestinations. In the latter case,
1976
+ # these are merged with any InvocationParameters specified on the
1977
+ # Connection, with any values from the Connection taking precedence.
884
1978
  #
885
1979
  # @!attribute [rw] path_parameter_values
886
1980
  # The path parameter values to be used to populate API Gateway REST
887
- # API path wildcards ("*").
1981
+ # API or EventBridge ApiDestination path wildcards ("*").
888
1982
  # @return [Array<String>]
889
1983
  #
890
1984
  # @!attribute [rw] header_parameters
891
1985
  # The headers that need to be sent as part of request invoking the API
892
- # Gateway REST API.
1986
+ # Gateway REST API or EventBridge ApiDestination.
893
1987
  # @return [Hash<String,String>]
894
1988
  #
895
1989
  # @!attribute [rw] query_string_parameters
896
1990
  # The query string keys/values that need to be sent as part of request
897
- # invoking the API Gateway REST API.
1991
+ # invoking the API Gateway REST API or EventBridge ApiDestination.
898
1992
  # @return [Hash<String,String>]
899
1993
  #
900
1994
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/HttpParameters AWS API Documentation
@@ -907,18 +2001,15 @@ module Aws::CloudWatchEvents
907
2001
  include Aws::Structure
908
2002
  end
909
2003
 
910
- # Contains the parameters needed for you to provide custom input to a
911
- # target based on one or more pieces of data extracted from the event.
2004
+ # An error occurred because a replay can be canceled only when the state
2005
+ # is Running or Starting.
912
2006
  #
913
- # @note When making an API call, you may pass InputTransformer
914
- # data as a hash:
2007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/IllegalStatusException AWS API Documentation
915
2008
  #
916
- # {
917
- # input_paths_map: {
918
- # "InputTransformerPathKey" => "TargetInputPath",
919
- # },
920
- # input_template: "TransformerInput", # required
921
- # }
2009
+ class IllegalStatusException < Aws::EmptyStructure; end
2010
+
2011
+ # Contains the parameters needed for you to provide custom input to a
2012
+ # target based on one or more pieces of data extracted from the event.
922
2013
  #
923
2014
  # @!attribute [rw] input_paths_map
924
2015
  # Map of JSON paths to be extracted from the event. You can then
@@ -926,10 +2017,10 @@ module Aws::CloudWatchEvents
926
2017
  # output you want to be sent to the target.
927
2018
  #
928
2019
  # `InputPathsMap` is an array key-value pairs, where each value is a
929
- # valid JSON path. You can have as many as 10 key-value pairs. You
2020
+ # valid JSON path. You can have as many as 100 key-value pairs. You
930
2021
  # must use JSON dot notation, not bracket notation.
931
2022
  #
932
- # The keys cannot start with "AWS."
2023
+ # The keys cannot start with "Amazon Web Services."
933
2024
  # @return [Hash<String,String>]
934
2025
  #
935
2026
  # @!attribute [rw] input_template
@@ -943,7 +2034,7 @@ module Aws::CloudWatchEvents
943
2034
  #
944
2035
  # * The placeholder cannot be used as an object key.
945
2036
  #
946
- # * Object values cannot include quote marks.
2037
+ # ^
947
2038
  #
948
2039
  # The following example shows the syntax for using `InputPathsMap` and
949
2040
  # `InputTemplate`.
@@ -973,82 +2064,229 @@ module Aws::CloudWatchEvents
973
2064
  # `"InputTemplate": "<instance> is in state "<status>""`
974
2065
  #
975
2066
  # `\}`
2067
+ #
2068
+ # The `InputTemplate` can also be valid JSON with varibles in quotes
2069
+ # or out, as in the following example:
2070
+ #
2071
+ # ` "InputTransformer":`
2072
+ #
2073
+ # `\{`
2074
+ #
2075
+ # `"InputPathsMap": \{"instance": "$.detail.instance","status":
2076
+ # "$.detail.status"\},`
2077
+ #
2078
+ # `"InputTemplate": '\{"myInstance": <instance>,"myStatus":
2079
+ # "<instance> is in state "<status>""\}'`
2080
+ #
2081
+ # `\}`
2082
+ # @return [String]
2083
+ #
2084
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/InputTransformer AWS API Documentation
2085
+ #
2086
+ class InputTransformer < Struct.new(
2087
+ :input_paths_map,
2088
+ :input_template)
2089
+ SENSITIVE = []
2090
+ include Aws::Structure
2091
+ end
2092
+
2093
+ # This exception occurs due to unexpected causes.
2094
+ #
2095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/InternalException AWS API Documentation
2096
+ #
2097
+ class InternalException < Aws::EmptyStructure; end
2098
+
2099
+ # The event pattern is not valid.
2100
+ #
2101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/InvalidEventPatternException AWS API Documentation
2102
+ #
2103
+ class InvalidEventPatternException < Aws::EmptyStructure; end
2104
+
2105
+ # The specified state is not a valid state for an event source.
2106
+ #
2107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/InvalidStateException AWS API Documentation
2108
+ #
2109
+ class InvalidStateException < Aws::EmptyStructure; end
2110
+
2111
+ # This object enables you to specify a JSON path to extract from the
2112
+ # event and use as the partition key for the Amazon Kinesis data stream,
2113
+ # so that you can control the shard to which the event goes. If you do
2114
+ # not include this parameter, the default is to use the `eventId` as the
2115
+ # partition key.
2116
+ #
2117
+ # @!attribute [rw] partition_key_path
2118
+ # The JSON path to be extracted from the event and used as the
2119
+ # partition key. For more information, see [Amazon Kinesis Streams Key
2120
+ # Concepts][1] in the *Amazon Kinesis Streams Developer Guide*.
2121
+ #
2122
+ #
2123
+ #
2124
+ # [1]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key
2125
+ # @return [String]
2126
+ #
2127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/KinesisParameters AWS API Documentation
2128
+ #
2129
+ class KinesisParameters < Struct.new(
2130
+ :partition_key_path)
2131
+ SENSITIVE = []
2132
+ include Aws::Structure
2133
+ end
2134
+
2135
+ # The request failed because it attempted to create resource beyond the
2136
+ # allowed service quota.
2137
+ #
2138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/LimitExceededException AWS API Documentation
2139
+ #
2140
+ class LimitExceededException < Aws::EmptyStructure; end
2141
+
2142
+ # @!attribute [rw] name_prefix
2143
+ # A name prefix to filter results returned. Only API destinations with
2144
+ # a name that starts with the prefix are returned.
2145
+ # @return [String]
2146
+ #
2147
+ # @!attribute [rw] connection_arn
2148
+ # The ARN of the connection specified for the API destination.
2149
+ # @return [String]
2150
+ #
2151
+ # @!attribute [rw] next_token
2152
+ # The token returned by a previous call to retrieve the next set of
2153
+ # results.
2154
+ # @return [String]
2155
+ #
2156
+ # @!attribute [rw] limit
2157
+ # The maximum number of API destinations to include in the response.
2158
+ # @return [Integer]
2159
+ #
2160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListApiDestinationsRequest AWS API Documentation
2161
+ #
2162
+ class ListApiDestinationsRequest < Struct.new(
2163
+ :name_prefix,
2164
+ :connection_arn,
2165
+ :next_token,
2166
+ :limit)
2167
+ SENSITIVE = []
2168
+ include Aws::Structure
2169
+ end
2170
+
2171
+ # @!attribute [rw] api_destinations
2172
+ # An array of `ApiDestination` objects that include information about
2173
+ # an API destination.
2174
+ # @return [Array<Types::ApiDestination>]
2175
+ #
2176
+ # @!attribute [rw] next_token
2177
+ # A token you can use in a subsequent request to retrieve the next set
2178
+ # of results.
2179
+ # @return [String]
2180
+ #
2181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListApiDestinationsResponse AWS API Documentation
2182
+ #
2183
+ class ListApiDestinationsResponse < Struct.new(
2184
+ :api_destinations,
2185
+ :next_token)
2186
+ SENSITIVE = []
2187
+ include Aws::Structure
2188
+ end
2189
+
2190
+ # @!attribute [rw] name_prefix
2191
+ # A name prefix to filter the archives returned. Only archives with
2192
+ # name that match the prefix are returned.
2193
+ # @return [String]
2194
+ #
2195
+ # @!attribute [rw] event_source_arn
2196
+ # The ARN of the event source associated with the archive.
2197
+ # @return [String]
2198
+ #
2199
+ # @!attribute [rw] state
2200
+ # The state of the archive.
2201
+ # @return [String]
2202
+ #
2203
+ # @!attribute [rw] next_token
2204
+ # The token returned by a previous call to retrieve the next set of
2205
+ # results.
976
2206
  # @return [String]
977
2207
  #
978
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/InputTransformer AWS API Documentation
2208
+ # @!attribute [rw] limit
2209
+ # The maximum number of results to return.
2210
+ # @return [Integer]
979
2211
  #
980
- class InputTransformer < Struct.new(
981
- :input_paths_map,
982
- :input_template)
2212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListArchivesRequest AWS API Documentation
2213
+ #
2214
+ class ListArchivesRequest < Struct.new(
2215
+ :name_prefix,
2216
+ :event_source_arn,
2217
+ :state,
2218
+ :next_token,
2219
+ :limit)
983
2220
  SENSITIVE = []
984
2221
  include Aws::Structure
985
2222
  end
986
2223
 
987
- # This exception occurs due to unexpected causes.
988
- #
989
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/InternalException AWS API Documentation
990
- #
991
- class InternalException < Aws::EmptyStructure; end
992
-
993
- # The event pattern is not valid.
994
- #
995
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/InvalidEventPatternException AWS API Documentation
2224
+ # @!attribute [rw] archives
2225
+ # An array of `Archive` objects that include details about an archive.
2226
+ # @return [Array<Types::Archive>]
996
2227
  #
997
- class InvalidEventPatternException < Aws::EmptyStructure; end
998
-
999
- # The specified state is not a valid state for an event source.
2228
+ # @!attribute [rw] next_token
2229
+ # The token returned by a previous call to retrieve the next set of
2230
+ # results.
2231
+ # @return [String]
1000
2232
  #
1001
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/InvalidStateException AWS API Documentation
2233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListArchivesResponse AWS API Documentation
1002
2234
  #
1003
- class InvalidStateException < Aws::EmptyStructure; end
2235
+ class ListArchivesResponse < Struct.new(
2236
+ :archives,
2237
+ :next_token)
2238
+ SENSITIVE = []
2239
+ include Aws::Structure
2240
+ end
1004
2241
 
1005
- # This object enables you to specify a JSON path to extract from the
1006
- # event and use as the partition key for the Amazon Kinesis data stream,
1007
- # so that you can control the shard to which the event goes. If you do
1008
- # not include this parameter, the default is to use the `eventId` as the
1009
- # partition key.
2242
+ # @!attribute [rw] name_prefix
2243
+ # A name prefix to filter results returned. Only connections with a
2244
+ # name that starts with the prefix are returned.
2245
+ # @return [String]
1010
2246
  #
1011
- # @note When making an API call, you may pass KinesisParameters
1012
- # data as a hash:
2247
+ # @!attribute [rw] connection_state
2248
+ # The state of the connection.
2249
+ # @return [String]
1013
2250
  #
1014
- # {
1015
- # partition_key_path: "TargetPartitionKeyPath", # required
1016
- # }
2251
+ # @!attribute [rw] next_token
2252
+ # The token returned by a previous call to retrieve the next set of
2253
+ # results.
2254
+ # @return [String]
1017
2255
  #
1018
- # @!attribute [rw] partition_key_path
1019
- # The JSON path to be extracted from the event and used as the
1020
- # partition key. For more information, see [Amazon Kinesis Streams Key
1021
- # Concepts][1] in the *Amazon Kinesis Streams Developer Guide*.
2256
+ # @!attribute [rw] limit
2257
+ # The maximum number of connections to return.
2258
+ # @return [Integer]
1022
2259
  #
2260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListConnectionsRequest AWS API Documentation
1023
2261
  #
2262
+ class ListConnectionsRequest < Struct.new(
2263
+ :name_prefix,
2264
+ :connection_state,
2265
+ :next_token,
2266
+ :limit)
2267
+ SENSITIVE = []
2268
+ include Aws::Structure
2269
+ end
2270
+
2271
+ # @!attribute [rw] connections
2272
+ # An array of connections objects that include details about the
2273
+ # connections.
2274
+ # @return [Array<Types::Connection>]
1024
2275
  #
1025
- # [1]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key
2276
+ # @!attribute [rw] next_token
2277
+ # A token you can use in a subsequent request to retrieve the next set
2278
+ # of results.
1026
2279
  # @return [String]
1027
2280
  #
1028
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/KinesisParameters AWS API Documentation
2281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListConnectionsResponse AWS API Documentation
1029
2282
  #
1030
- class KinesisParameters < Struct.new(
1031
- :partition_key_path)
2283
+ class ListConnectionsResponse < Struct.new(
2284
+ :connections,
2285
+ :next_token)
1032
2286
  SENSITIVE = []
1033
2287
  include Aws::Structure
1034
2288
  end
1035
2289
 
1036
- # You tried to create more rules or add more targets to a rule than is
1037
- # allowed.
1038
- #
1039
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/LimitExceededException AWS API Documentation
1040
- #
1041
- class LimitExceededException < Aws::EmptyStructure; end
1042
-
1043
- # @note When making an API call, you may pass ListEventBusesRequest
1044
- # data as a hash:
1045
- #
1046
- # {
1047
- # name_prefix: "EventBusName",
1048
- # next_token: "NextToken",
1049
- # limit: 1,
1050
- # }
1051
- #
1052
2290
  # @!attribute [rw] name_prefix
1053
2291
  # Specifying this limits the results to only those event buses with
1054
2292
  # names that start with the specified prefix.
@@ -1093,15 +2331,6 @@ module Aws::CloudWatchEvents
1093
2331
  include Aws::Structure
1094
2332
  end
1095
2333
 
1096
- # @note When making an API call, you may pass ListEventSourcesRequest
1097
- # data as a hash:
1098
- #
1099
- # {
1100
- # name_prefix: "EventSourceNamePrefix",
1101
- # next_token: "NextToken",
1102
- # limit: 1,
1103
- # }
1104
- #
1105
2334
  # @!attribute [rw] name_prefix
1106
2335
  # Specifying this limits the results to only those partner event
1107
2336
  # sources with names that start with the specified prefix.
@@ -1146,15 +2375,6 @@ module Aws::CloudWatchEvents
1146
2375
  include Aws::Structure
1147
2376
  end
1148
2377
 
1149
- # @note When making an API call, you may pass ListPartnerEventSourceAccountsRequest
1150
- # data as a hash:
1151
- #
1152
- # {
1153
- # event_source_name: "EventSourceName", # required
1154
- # next_token: "NextToken",
1155
- # limit: 1,
1156
- # }
1157
- #
1158
2378
  # @!attribute [rw] event_source_name
1159
2379
  # The name of the partner event source to display account information
1160
2380
  # about.
@@ -1199,15 +2419,6 @@ module Aws::CloudWatchEvents
1199
2419
  include Aws::Structure
1200
2420
  end
1201
2421
 
1202
- # @note When making an API call, you may pass ListPartnerEventSourcesRequest
1203
- # data as a hash:
1204
- #
1205
- # {
1206
- # name_prefix: "PartnerEventSourceNamePrefix", # required
1207
- # next_token: "NextToken",
1208
- # limit: 1,
1209
- # }
1210
- #
1211
2422
  # @!attribute [rw] name_prefix
1212
2423
  # If you specify this, the results are limited to only those partner
1213
2424
  # event sources that start with the string you specify.
@@ -1252,23 +2463,66 @@ module Aws::CloudWatchEvents
1252
2463
  include Aws::Structure
1253
2464
  end
1254
2465
 
1255
- # @note When making an API call, you may pass ListRuleNamesByTargetRequest
1256
- # data as a hash:
2466
+ # @!attribute [rw] name_prefix
2467
+ # A name prefix to filter the replays returned. Only replays with name
2468
+ # that match the prefix are returned.
2469
+ # @return [String]
2470
+ #
2471
+ # @!attribute [rw] state
2472
+ # The state of the replay.
2473
+ # @return [String]
2474
+ #
2475
+ # @!attribute [rw] event_source_arn
2476
+ # The ARN of the archive from which the events are replayed.
2477
+ # @return [String]
2478
+ #
2479
+ # @!attribute [rw] next_token
2480
+ # The token returned by a previous call to retrieve the next set of
2481
+ # results.
2482
+ # @return [String]
2483
+ #
2484
+ # @!attribute [rw] limit
2485
+ # The maximum number of replays to retrieve.
2486
+ # @return [Integer]
2487
+ #
2488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListReplaysRequest AWS API Documentation
2489
+ #
2490
+ class ListReplaysRequest < Struct.new(
2491
+ :name_prefix,
2492
+ :state,
2493
+ :event_source_arn,
2494
+ :next_token,
2495
+ :limit)
2496
+ SENSITIVE = []
2497
+ include Aws::Structure
2498
+ end
2499
+
2500
+ # @!attribute [rw] replays
2501
+ # An array of `Replay` objects that contain information about the
2502
+ # replay.
2503
+ # @return [Array<Types::Replay>]
2504
+ #
2505
+ # @!attribute [rw] next_token
2506
+ # The token returned by a previous call to retrieve the next set of
2507
+ # results.
2508
+ # @return [String]
1257
2509
  #
1258
- # {
1259
- # target_arn: "TargetArn", # required
1260
- # event_bus_name: "EventBusName",
1261
- # next_token: "NextToken",
1262
- # limit: 1,
1263
- # }
2510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListReplaysResponse AWS API Documentation
1264
2511
  #
2512
+ class ListReplaysResponse < Struct.new(
2513
+ :replays,
2514
+ :next_token)
2515
+ SENSITIVE = []
2516
+ include Aws::Structure
2517
+ end
2518
+
1265
2519
  # @!attribute [rw] target_arn
1266
2520
  # The Amazon Resource Name (ARN) of the target resource.
1267
2521
  # @return [String]
1268
2522
  #
1269
2523
  # @!attribute [rw] event_bus_name
1270
- # Limits the results to show only the rules associated with the
1271
- # specified event bus.
2524
+ # The name or ARN of the event bus to list rules for. If you omit
2525
+ # this, the default event bus is used.
1272
2526
  # @return [String]
1273
2527
  #
1274
2528
  # @!attribute [rw] next_token
@@ -1309,23 +2563,13 @@ module Aws::CloudWatchEvents
1309
2563
  include Aws::Structure
1310
2564
  end
1311
2565
 
1312
- # @note When making an API call, you may pass ListRulesRequest
1313
- # data as a hash:
1314
- #
1315
- # {
1316
- # name_prefix: "RuleName",
1317
- # event_bus_name: "EventBusName",
1318
- # next_token: "NextToken",
1319
- # limit: 1,
1320
- # }
1321
- #
1322
2566
  # @!attribute [rw] name_prefix
1323
2567
  # The prefix matching the rule name.
1324
2568
  # @return [String]
1325
2569
  #
1326
2570
  # @!attribute [rw] event_bus_name
1327
- # Limits the results to show only the rules associated with the
1328
- # specified event bus.
2571
+ # The name or ARN of the event bus to list the rules for. If you omit
2572
+ # this, the default event bus is used.
1329
2573
  # @return [String]
1330
2574
  #
1331
2575
  # @!attribute [rw] next_token
@@ -1366,13 +2610,6 @@ module Aws::CloudWatchEvents
1366
2610
  include Aws::Structure
1367
2611
  end
1368
2612
 
1369
- # @note When making an API call, you may pass ListTagsForResourceRequest
1370
- # data as a hash:
1371
- #
1372
- # {
1373
- # resource_arn: "Arn", # required
1374
- # }
1375
- #
1376
2613
  # @!attribute [rw] resource_arn
1377
2614
  # The ARN of the EventBridge resource for which you want to view tags.
1378
2615
  # @return [String]
@@ -1398,23 +2635,13 @@ module Aws::CloudWatchEvents
1398
2635
  include Aws::Structure
1399
2636
  end
1400
2637
 
1401
- # @note When making an API call, you may pass ListTargetsByRuleRequest
1402
- # data as a hash:
1403
- #
1404
- # {
1405
- # rule: "RuleName", # required
1406
- # event_bus_name: "EventBusName",
1407
- # next_token: "NextToken",
1408
- # limit: 1,
1409
- # }
1410
- #
1411
2638
  # @!attribute [rw] rule
1412
2639
  # The name of the rule.
1413
2640
  # @return [String]
1414
2641
  #
1415
2642
  # @!attribute [rw] event_bus_name
1416
- # The event bus associated with the rule. If you omit this, the
1417
- # default event bus is used.
2643
+ # The name or ARN of the event bus associated with the rule. If you
2644
+ # omit this, the default event bus is used.
1418
2645
  # @return [String]
1419
2646
  #
1420
2647
  # @!attribute [rw] next_token
@@ -1455,11 +2682,11 @@ module Aws::CloudWatchEvents
1455
2682
  include Aws::Structure
1456
2683
  end
1457
2684
 
1458
- # This rule was created by an AWS service on behalf of your account. It
1459
- # is managed by that service. If you see this error in response to
1460
- # `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in
1461
- # those calls to delete the rule or remove targets from the rule. You
1462
- # cannot modify these managed rules by using `DisableRule`,
2685
+ # This rule was created by an Amazon Web Services service on behalf of
2686
+ # your account. It is managed by that service. If you see this error in
2687
+ # response to `DeleteRule` or `RemoveTargets`, you can use the `Force`
2688
+ # parameter in those calls to delete the rule or remove targets from the
2689
+ # rule. You cannot modify these managed rules by using `DisableRule`,
1463
2690
  # `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or
1464
2691
  # `UntagResource`.
1465
2692
  #
@@ -1469,17 +2696,6 @@ module Aws::CloudWatchEvents
1469
2696
 
1470
2697
  # This structure specifies the network configuration for an ECS task.
1471
2698
  #
1472
- # @note When making an API call, you may pass NetworkConfiguration
1473
- # data as a hash:
1474
- #
1475
- # {
1476
- # awsvpc_configuration: {
1477
- # subnets: ["String"], # required
1478
- # security_groups: ["String"],
1479
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
1480
- # },
1481
- # }
1482
- #
1483
2699
  # @!attribute [rw] awsvpc_configuration
1484
2700
  # Use this structure to specify the VPC subnets and security groups
1485
2701
  # for the task, and whether a public IP address is to be used. This
@@ -1502,9 +2718,9 @@ module Aws::CloudWatchEvents
1502
2718
  class OperationDisabledException < Aws::EmptyStructure; end
1503
2719
 
1504
2720
  # A partner event source is created by an SaaS partner. If a customer
1505
- # creates a partner event bus that matches this event source, that AWS
1506
- # account can receive events from the partner's applications or
1507
- # services.
2721
+ # creates a partner event bus that matches this event source, that
2722
+ # Amazon Web Services account can receive events from the partner's
2723
+ # applications or services.
1508
2724
  #
1509
2725
  # @!attribute [rw] arn
1510
2726
  # The ARN of the partner event source.
@@ -1523,10 +2739,12 @@ module Aws::CloudWatchEvents
1523
2739
  include Aws::Structure
1524
2740
  end
1525
2741
 
1526
- # The AWS account that a partner event source has been offered to.
2742
+ # The Amazon Web Services account that a partner event source has been
2743
+ # offered to.
1527
2744
  #
1528
2745
  # @!attribute [rw] account
1529
- # The AWS account ID that the partner event source was offered to.
2746
+ # The Amazon Web Services account ID that the partner event source was
2747
+ # offered to.
1530
2748
  # @return [String]
1531
2749
  #
1532
2750
  # @!attribute [rw] creation_time
@@ -1534,8 +2752,8 @@ module Aws::CloudWatchEvents
1534
2752
  # @return [Time]
1535
2753
  #
1536
2754
  # @!attribute [rw] expiration_time
1537
- # The date and time that the event source will expire, if the AWS
1538
- # account doesn't create a matching event bus for it.
2755
+ # The date and time that the event source will expire, if the Amazon
2756
+ # Web Services account doesn't create a matching event bus for it.
1539
2757
  # @return [Time]
1540
2758
  #
1541
2759
  # @!attribute [rw] state
@@ -1558,6 +2776,79 @@ module Aws::CloudWatchEvents
1558
2776
  include Aws::Structure
1559
2777
  end
1560
2778
 
2779
+ # An object representing a constraint on task placement. To learn more,
2780
+ # see [Task Placement Constraints][1] in the Amazon Elastic Container
2781
+ # Service Developer Guide.
2782
+ #
2783
+ #
2784
+ #
2785
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html
2786
+ #
2787
+ # @!attribute [rw] type
2788
+ # The type of constraint. Use distinctInstance to ensure that each
2789
+ # task in a particular group is running on a different container
2790
+ # instance. Use memberOf to restrict the selection to a group of valid
2791
+ # candidates.
2792
+ # @return [String]
2793
+ #
2794
+ # @!attribute [rw] expression
2795
+ # A cluster query language expression to apply to the constraint. You
2796
+ # cannot specify an expression if the constraint type is
2797
+ # `distinctInstance`. To learn more, see [Cluster Query Language][1]
2798
+ # in the Amazon Elastic Container Service Developer Guide.
2799
+ #
2800
+ #
2801
+ #
2802
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html
2803
+ # @return [String]
2804
+ #
2805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PlacementConstraint AWS API Documentation
2806
+ #
2807
+ class PlacementConstraint < Struct.new(
2808
+ :type,
2809
+ :expression)
2810
+ SENSITIVE = []
2811
+ include Aws::Structure
2812
+ end
2813
+
2814
+ # The task placement strategy for a task or service. To learn more, see
2815
+ # [Task Placement Strategies][1] in the Amazon Elastic Container Service
2816
+ # Service Developer Guide.
2817
+ #
2818
+ #
2819
+ #
2820
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html
2821
+ #
2822
+ # @!attribute [rw] type
2823
+ # The type of placement strategy. The random placement strategy
2824
+ # randomly places tasks on available candidates. The spread placement
2825
+ # strategy spreads placement across available candidates evenly based
2826
+ # on the field parameter. The binpack strategy places tasks on
2827
+ # available candidates that have the least available amount of the
2828
+ # resource that is specified with the field parameter. For example, if
2829
+ # you binpack on memory, a task is placed on the instance with the
2830
+ # least amount of remaining memory (but still enough to run the task).
2831
+ # @return [String]
2832
+ #
2833
+ # @!attribute [rw] field
2834
+ # The field to apply the placement strategy against. For the spread
2835
+ # placement strategy, valid values are instanceId (or host, which has
2836
+ # the same effect), or any platform or custom attribute that is
2837
+ # applied to a container instance, such as
2838
+ # attribute:ecs.availability-zone. For the binpack placement strategy,
2839
+ # valid values are cpu and memory. For the random placement strategy,
2840
+ # this field is not used.
2841
+ # @return [String]
2842
+ #
2843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PlacementStrategy AWS API Documentation
2844
+ #
2845
+ class PlacementStrategy < Struct.new(
2846
+ :type,
2847
+ :field)
2848
+ SENSITIVE = []
2849
+ include Aws::Structure
2850
+ end
2851
+
1561
2852
  # The event bus policy is too long. For more information, see the
1562
2853
  # limits.
1563
2854
  #
@@ -1565,22 +2856,6 @@ module Aws::CloudWatchEvents
1565
2856
  #
1566
2857
  class PolicyLengthExceededException < Aws::EmptyStructure; end
1567
2858
 
1568
- # @note When making an API call, you may pass PutEventsRequest
1569
- # data as a hash:
1570
- #
1571
- # {
1572
- # entries: [ # required
1573
- # {
1574
- # time: Time.now,
1575
- # source: "String",
1576
- # resources: ["EventResource"],
1577
- # detail_type: "String",
1578
- # detail: "String",
1579
- # event_bus_name: "NonPartnerEventBusName",
1580
- # },
1581
- # ],
1582
- # }
1583
- #
1584
2859
  # @!attribute [rw] entries
1585
2860
  # The entry that defines an event in your system. You can specify
1586
2861
  # several parameters for the entry such as the source and type of the
@@ -1597,25 +2872,14 @@ module Aws::CloudWatchEvents
1597
2872
 
1598
2873
  # Represents an event to be submitted.
1599
2874
  #
1600
- # @note When making an API call, you may pass PutEventsRequestEntry
1601
- # data as a hash:
1602
- #
1603
- # {
1604
- # time: Time.now,
1605
- # source: "String",
1606
- # resources: ["EventResource"],
1607
- # detail_type: "String",
1608
- # detail: "String",
1609
- # event_bus_name: "NonPartnerEventBusName",
1610
- # }
1611
- #
1612
2875
  # @!attribute [rw] time
1613
2876
  # The time stamp of the event, per [RFC3339][1]. If no time stamp is
1614
- # provided, the time stamp of the PutEvents call is used.
2877
+ # provided, the time stamp of the [PutEvents][2] call is used.
1615
2878
  #
1616
2879
  #
1617
2880
  #
1618
2881
  # [1]: https://www.rfc-editor.org/rfc/rfc3339.txt
2882
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html
1619
2883
  # @return [Time]
1620
2884
  #
1621
2885
  # @!attribute [rw] source
@@ -1623,9 +2887,9 @@ module Aws::CloudWatchEvents
1623
2887
  # @return [String]
1624
2888
  #
1625
2889
  # @!attribute [rw] resources
1626
- # AWS resources, identified by Amazon Resource Name (ARN), which the
1627
- # event primarily concerns. Any number, including zero, may be
1628
- # present.
2890
+ # Amazon Web Services resources, identified by Amazon Resource Name
2891
+ # (ARN), which the event primarily concerns. Any number, including
2892
+ # zero, may be present.
1629
2893
  # @return [Array<String>]
1630
2894
  #
1631
2895
  # @!attribute [rw] detail_type
@@ -1639,8 +2903,21 @@ module Aws::CloudWatchEvents
1639
2903
  # @return [String]
1640
2904
  #
1641
2905
  # @!attribute [rw] event_bus_name
1642
- # The event bus that will receive the event. Only the rules that are
1643
- # associated with this event bus will be able to match the event.
2906
+ # The name or ARN of the event bus to receive the event. Only the
2907
+ # rules that are associated with this event bus are used to match the
2908
+ # event. If you omit this, the default event bus is used.
2909
+ # @return [String]
2910
+ #
2911
+ # @!attribute [rw] trace_header
2912
+ # An X-Ray trade header, which is an http header (X-Amzn-Trace-Id)
2913
+ # that contains the trace-id associated with the event.
2914
+ #
2915
+ # To learn more about X-Ray trace headers, see [Tracing header][1] in
2916
+ # the X-Ray Developer Guide.
2917
+ #
2918
+ #
2919
+ #
2920
+ # [1]: https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader
1644
2921
  # @return [String]
1645
2922
  #
1646
2923
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutEventsRequestEntry AWS API Documentation
@@ -1651,7 +2928,8 @@ module Aws::CloudWatchEvents
1651
2928
  :resources,
1652
2929
  :detail_type,
1653
2930
  :detail,
1654
- :event_bus_name)
2931
+ :event_bus_name,
2932
+ :trace_header)
1655
2933
  SENSITIVE = []
1656
2934
  include Aws::Structure
1657
2935
  end
@@ -1700,21 +2978,6 @@ module Aws::CloudWatchEvents
1700
2978
  include Aws::Structure
1701
2979
  end
1702
2980
 
1703
- # @note When making an API call, you may pass PutPartnerEventsRequest
1704
- # data as a hash:
1705
- #
1706
- # {
1707
- # entries: [ # required
1708
- # {
1709
- # time: Time.now,
1710
- # source: "EventSourceName",
1711
- # resources: ["EventResource"],
1712
- # detail_type: "String",
1713
- # detail: "String",
1714
- # },
1715
- # ],
1716
- # }
1717
- #
1718
2981
  # @!attribute [rw] entries
1719
2982
  # The list of events to write to the event bus.
1720
2983
  # @return [Array<Types::PutPartnerEventsRequestEntry>]
@@ -1729,29 +2992,18 @@ module Aws::CloudWatchEvents
1729
2992
 
1730
2993
  # The details about an event generated by an SaaS partner.
1731
2994
  #
1732
- # @note When making an API call, you may pass PutPartnerEventsRequestEntry
1733
- # data as a hash:
1734
- #
1735
- # {
1736
- # time: Time.now,
1737
- # source: "EventSourceName",
1738
- # resources: ["EventResource"],
1739
- # detail_type: "String",
1740
- # detail: "String",
1741
- # }
1742
- #
1743
2995
  # @!attribute [rw] time
1744
2996
  # The date and time of the event.
1745
2997
  # @return [Time]
1746
2998
  #
1747
2999
  # @!attribute [rw] source
1748
- # The event source that is generating the evntry.
3000
+ # The event source that is generating the entry.
1749
3001
  # @return [String]
1750
3002
  #
1751
3003
  # @!attribute [rw] resources
1752
- # AWS resources, identified by Amazon Resource Name (ARN), which the
1753
- # event primarily concerns. Any number, including zero, may be
1754
- # present.
3004
+ # Amazon Web Services resources, identified by Amazon Resource Name
3005
+ # (ARN), which the event primarily concerns. Any number, including
3006
+ # zero, may be present.
1755
3007
  # @return [Array<String>]
1756
3008
  #
1757
3009
  # @!attribute [rw] detail_type
@@ -1819,35 +3071,19 @@ module Aws::CloudWatchEvents
1819
3071
  include Aws::Structure
1820
3072
  end
1821
3073
 
1822
- # @note When making an API call, you may pass PutPermissionRequest
1823
- # data as a hash:
1824
- #
1825
- # {
1826
- # event_bus_name: "NonPartnerEventBusName",
1827
- # action: "Action", # required
1828
- # principal: "Principal", # required
1829
- # statement_id: "StatementId", # required
1830
- # condition: {
1831
- # type: "String", # required
1832
- # key: "String", # required
1833
- # value: "String", # required
1834
- # },
1835
- # }
1836
- #
1837
3074
  # @!attribute [rw] event_bus_name
1838
- # The event bus associated with the rule. If you omit this, the
1839
- # default event bus is used.
3075
+ # The name of the event bus associated with the rule. If you omit
3076
+ # this, the default event bus is used.
1840
3077
  # @return [String]
1841
3078
  #
1842
3079
  # @!attribute [rw] action
1843
3080
  # The action that you are enabling the other account to perform.
1844
- # Currently, this must be `events:PutEvents`.
1845
3081
  # @return [String]
1846
3082
  #
1847
3083
  # @!attribute [rw] principal
1848
- # The 12-digit AWS account ID that you are permitting to put events to
1849
- # your default event bus. Specify "*" to permit any account to put
1850
- # events to your default event bus.
3084
+ # The 12-digit Amazon Web Services account ID that you are permitting
3085
+ # to put events to your default event bus. Specify "*" to permit
3086
+ # any account to put events to your default event bus.
1851
3087
  #
1852
3088
  # If you specify "*" without specifying `Condition`, avoid creating
1853
3089
  # rules that may match undesirable events. To create more secure
@@ -1861,19 +3097,24 @@ module Aws::CloudWatchEvents
1861
3097
  # An identifier string for the external account that you are granting
1862
3098
  # permissions to. If you later want to revoke the permission for this
1863
3099
  # external account, specify this `StatementId` when you run
1864
- # RemovePermission.
3100
+ # [RemovePermission][1].
3101
+ #
3102
+ #
3103
+ #
3104
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html
1865
3105
  # @return [String]
1866
3106
  #
1867
3107
  # @!attribute [rw] condition
1868
3108
  # This parameter enables you to limit the permission to accounts that
1869
- # fulfill a certain condition, such as being a member of a certain AWS
1870
- # organization. For more information about AWS Organizations, see
1871
- # [What Is AWS Organizations][1] in the *AWS Organizations User
3109
+ # fulfill a certain condition, such as being a member of a certain
3110
+ # Amazon Web Services organization. For more information about Amazon
3111
+ # Web Services Organizations, see [What Is Amazon Web Services
3112
+ # Organizations][1] in the *Amazon Web Services Organizations User
1872
3113
  # Guide*.
1873
3114
  #
1874
- # If you specify `Condition` with an AWS organization ID, and specify
1875
- # "*" as the value for `Principal`, you grant permission to all the
1876
- # accounts in the named organization.
3115
+ # If you specify `Condition` with an Amazon Web Services organization
3116
+ # ID, and specify "*" as the value for `Principal`, you grant
3117
+ # permission to all the accounts in the named organization.
1877
3118
  #
1878
3119
  # The `Condition` is a JSON string which must contain `Type`, `Key`,
1879
3120
  # and `Value` fields.
@@ -1883,6 +3124,12 @@ module Aws::CloudWatchEvents
1883
3124
  # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html
1884
3125
  # @return [Types::Condition]
1885
3126
  #
3127
+ # @!attribute [rw] policy
3128
+ # A JSON string that describes the permission policy statement. You
3129
+ # can include a `Policy` parameter in the request instead of using the
3130
+ # `StatementId`, `Action`, `Principal`, or `Condition` parameters.
3131
+ # @return [String]
3132
+ #
1886
3133
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPermissionRequest AWS API Documentation
1887
3134
  #
1888
3135
  class PutPermissionRequest < Struct.new(
@@ -1890,30 +3137,12 @@ module Aws::CloudWatchEvents
1890
3137
  :action,
1891
3138
  :principal,
1892
3139
  :statement_id,
1893
- :condition)
3140
+ :condition,
3141
+ :policy)
1894
3142
  SENSITIVE = []
1895
3143
  include Aws::Structure
1896
3144
  end
1897
3145
 
1898
- # @note When making an API call, you may pass PutRuleRequest
1899
- # data as a hash:
1900
- #
1901
- # {
1902
- # name: "RuleName", # required
1903
- # schedule_expression: "ScheduleExpression",
1904
- # event_pattern: "EventPattern",
1905
- # state: "ENABLED", # accepts ENABLED, DISABLED
1906
- # description: "RuleDescription",
1907
- # role_arn: "RoleArn",
1908
- # tags: [
1909
- # {
1910
- # key: "TagKey", # required
1911
- # value: "TagValue", # required
1912
- # },
1913
- # ],
1914
- # event_bus_name: "EventBusName",
1915
- # }
1916
- #
1917
3146
  # @!attribute [rw] name
1918
3147
  # The name of the rule that you are creating or updating.
1919
3148
  # @return [String]
@@ -1943,6 +3172,12 @@ module Aws::CloudWatchEvents
1943
3172
  # @!attribute [rw] role_arn
1944
3173
  # The Amazon Resource Name (ARN) of the IAM role associated with the
1945
3174
  # rule.
3175
+ #
3176
+ # If you're setting an event bus in another account as the target and
3177
+ # that account granted permission to your account through an
3178
+ # organization instead of directly by the account ID, you must specify
3179
+ # a `RoleArn` with proper permissions in the `Target` structure,
3180
+ # instead of here in this parameter.
1946
3181
  # @return [String]
1947
3182
  #
1948
3183
  # @!attribute [rw] tags
@@ -1950,8 +3185,8 @@ module Aws::CloudWatchEvents
1950
3185
  # @return [Array<Types::Tag>]
1951
3186
  #
1952
3187
  # @!attribute [rw] event_bus_name
1953
- # The event bus to associate with this rule. If you omit this, the
1954
- # default event bus is used.
3188
+ # The name or ARN of the event bus to associate with this rule. If you
3189
+ # omit this, the default event bus is used.
1955
3190
  # @return [String]
1956
3191
  #
1957
3192
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutRuleRequest AWS API Documentation
@@ -1981,83 +3216,13 @@ module Aws::CloudWatchEvents
1981
3216
  include Aws::Structure
1982
3217
  end
1983
3218
 
1984
- # @note When making an API call, you may pass PutTargetsRequest
1985
- # data as a hash:
1986
- #
1987
- # {
1988
- # rule: "RuleName", # required
1989
- # event_bus_name: "EventBusName",
1990
- # targets: [ # required
1991
- # {
1992
- # id: "TargetId", # required
1993
- # arn: "TargetArn", # required
1994
- # role_arn: "RoleArn",
1995
- # input: "TargetInput",
1996
- # input_path: "TargetInputPath",
1997
- # input_transformer: {
1998
- # input_paths_map: {
1999
- # "InputTransformerPathKey" => "TargetInputPath",
2000
- # },
2001
- # input_template: "TransformerInput", # required
2002
- # },
2003
- # kinesis_parameters: {
2004
- # partition_key_path: "TargetPartitionKeyPath", # required
2005
- # },
2006
- # run_command_parameters: {
2007
- # run_command_targets: [ # required
2008
- # {
2009
- # key: "RunCommandTargetKey", # required
2010
- # values: ["RunCommandTargetValue"], # required
2011
- # },
2012
- # ],
2013
- # },
2014
- # ecs_parameters: {
2015
- # task_definition_arn: "Arn", # required
2016
- # task_count: 1,
2017
- # launch_type: "EC2", # accepts EC2, FARGATE
2018
- # network_configuration: {
2019
- # awsvpc_configuration: {
2020
- # subnets: ["String"], # required
2021
- # security_groups: ["String"],
2022
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
2023
- # },
2024
- # },
2025
- # platform_version: "String",
2026
- # group: "String",
2027
- # },
2028
- # batch_parameters: {
2029
- # job_definition: "String", # required
2030
- # job_name: "String", # required
2031
- # array_properties: {
2032
- # size: 1,
2033
- # },
2034
- # retry_strategy: {
2035
- # attempts: 1,
2036
- # },
2037
- # },
2038
- # sqs_parameters: {
2039
- # message_group_id: "MessageGroupId",
2040
- # },
2041
- # http_parameters: {
2042
- # path_parameter_values: ["PathParameter"],
2043
- # header_parameters: {
2044
- # "HeaderKey" => "HeaderValue",
2045
- # },
2046
- # query_string_parameters: {
2047
- # "QueryStringKey" => "QueryStringValue",
2048
- # },
2049
- # },
2050
- # },
2051
- # ],
2052
- # }
2053
- #
2054
3219
  # @!attribute [rw] rule
2055
3220
  # The name of the rule.
2056
3221
  # @return [String]
2057
3222
  #
2058
3223
  # @!attribute [rw] event_bus_name
2059
- # The name of the event bus associated with the rule. If you omit
2060
- # this, the default event bus is used.
3224
+ # The name or ARN of the event bus associated with the rule. If you
3225
+ # omit this, the default event bus is used.
2061
3226
  # @return [String]
2062
3227
  #
2063
3228
  # @!attribute [rw] targets
@@ -2117,19 +3282,62 @@ module Aws::CloudWatchEvents
2117
3282
  include Aws::Structure
2118
3283
  end
2119
3284
 
2120
- # @note When making an API call, you may pass RemovePermissionRequest
2121
- # data as a hash:
3285
+ # These are custom parameters to be used when the target is a Amazon
3286
+ # Redshift cluster to invoke the Amazon Redshift Data API
3287
+ # ExecuteStatement based on EventBridge events.
3288
+ #
3289
+ # @!attribute [rw] secret_manager_arn
3290
+ # The name or ARN of the secret that enables access to the database.
3291
+ # Required when authenticating using Amazon Web Services Secrets
3292
+ # Manager.
3293
+ # @return [String]
3294
+ #
3295
+ # @!attribute [rw] database
3296
+ # The name of the database. Required when authenticating using
3297
+ # temporary credentials.
3298
+ # @return [String]
3299
+ #
3300
+ # @!attribute [rw] db_user
3301
+ # The database user name. Required when authenticating using temporary
3302
+ # credentials.
3303
+ # @return [String]
3304
+ #
3305
+ # @!attribute [rw] sql
3306
+ # The SQL statement text to run.
3307
+ # @return [String]
3308
+ #
3309
+ # @!attribute [rw] statement_name
3310
+ # The name of the SQL statement. You can name the SQL statement when
3311
+ # you create it to identify the query.
3312
+ # @return [String]
3313
+ #
3314
+ # @!attribute [rw] with_event
3315
+ # Indicates whether to send an event back to EventBridge after the SQL
3316
+ # statement runs.
3317
+ # @return [Boolean]
2122
3318
  #
2123
- # {
2124
- # statement_id: "StatementId", # required
2125
- # event_bus_name: "NonPartnerEventBusName",
2126
- # }
3319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RedshiftDataParameters AWS API Documentation
2127
3320
  #
3321
+ class RedshiftDataParameters < Struct.new(
3322
+ :secret_manager_arn,
3323
+ :database,
3324
+ :db_user,
3325
+ :sql,
3326
+ :statement_name,
3327
+ :with_event)
3328
+ SENSITIVE = []
3329
+ include Aws::Structure
3330
+ end
3331
+
2128
3332
  # @!attribute [rw] statement_id
2129
3333
  # The statement ID corresponding to the account that is no longer
2130
3334
  # allowed to put events to the default event bus.
2131
3335
  # @return [String]
2132
3336
  #
3337
+ # @!attribute [rw] remove_all_permissions
3338
+ # Specifies whether to remove all permissions.
3339
+ # @return [Boolean]
3340
+ #
2133
3341
  # @!attribute [rw] event_bus_name
2134
3342
  # The name of the event bus to revoke permissions for. If you omit
2135
3343
  # this, the default event bus is used.
@@ -2139,27 +3347,19 @@ module Aws::CloudWatchEvents
2139
3347
  #
2140
3348
  class RemovePermissionRequest < Struct.new(
2141
3349
  :statement_id,
3350
+ :remove_all_permissions,
2142
3351
  :event_bus_name)
2143
3352
  SENSITIVE = []
2144
3353
  include Aws::Structure
2145
3354
  end
2146
3355
 
2147
- # @note When making an API call, you may pass RemoveTargetsRequest
2148
- # data as a hash:
2149
- #
2150
- # {
2151
- # rule: "RuleName", # required
2152
- # event_bus_name: "EventBusName",
2153
- # ids: ["TargetId"], # required
2154
- # force: false,
2155
- # }
2156
- #
2157
3356
  # @!attribute [rw] rule
2158
3357
  # The name of the rule.
2159
3358
  # @return [String]
2160
3359
  #
2161
3360
  # @!attribute [rw] event_bus_name
2162
- # The name of the event bus associated with the rule.
3361
+ # The name or ARN of the event bus associated with the rule. If you
3362
+ # omit this, the default event bus is used.
2163
3363
  # @return [String]
2164
3364
  #
2165
3365
  # @!attribute [rw] ids
@@ -2167,11 +3367,12 @@ module Aws::CloudWatchEvents
2167
3367
  # @return [Array<String>]
2168
3368
  #
2169
3369
  # @!attribute [rw] force
2170
- # If this is a managed rule, created by an AWS service on your behalf,
2171
- # you must specify `Force` as `True` to remove targets. This parameter
2172
- # is ignored for rules that are not managed rules. You can check
2173
- # whether a rule is a managed rule by using `DescribeRule` or
2174
- # `ListRules` and checking the `ManagedBy` field of the response.
3370
+ # If this is a managed rule, created by an Amazon Web Services service
3371
+ # on your behalf, you must specify `Force` as `True` to remove
3372
+ # targets. This parameter is ignored for rules that are not managed
3373
+ # rules. You can check whether a rule is a managed rule by using
3374
+ # `DescribeRule` or `ListRules` and checking the `ManagedBy` field of
3375
+ # the response.
2175
3376
  # @return [Boolean]
2176
3377
  #
2177
3378
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemoveTargetsRequest AWS API Documentation
@@ -2218,12 +3419,92 @@ module Aws::CloudWatchEvents
2218
3419
  # The error message that explains why the target removal failed.
2219
3420
  # @return [String]
2220
3421
  #
2221
- # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemoveTargetsResultEntry AWS API Documentation
3422
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemoveTargetsResultEntry AWS API Documentation
3423
+ #
3424
+ class RemoveTargetsResultEntry < Struct.new(
3425
+ :target_id,
3426
+ :error_code,
3427
+ :error_message)
3428
+ SENSITIVE = []
3429
+ include Aws::Structure
3430
+ end
3431
+
3432
+ # A `Replay` object that contains details about a replay.
3433
+ #
3434
+ # @!attribute [rw] replay_name
3435
+ # The name of the replay.
3436
+ # @return [String]
3437
+ #
3438
+ # @!attribute [rw] event_source_arn
3439
+ # The ARN of the archive to replay event from.
3440
+ # @return [String]
3441
+ #
3442
+ # @!attribute [rw] state
3443
+ # The current state of the replay.
3444
+ # @return [String]
3445
+ #
3446
+ # @!attribute [rw] state_reason
3447
+ # A description of why the replay is in the current state.
3448
+ # @return [String]
3449
+ #
3450
+ # @!attribute [rw] event_start_time
3451
+ # A time stamp for the time to start replaying events. This is
3452
+ # determined by the time in the event as described in [Time][1].
3453
+ #
3454
+ #
3455
+ #
3456
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time
3457
+ # @return [Time]
3458
+ #
3459
+ # @!attribute [rw] event_end_time
3460
+ # A time stamp for the time to start replaying events. Any event with
3461
+ # a creation time prior to the `EventEndTime` specified is replayed.
3462
+ # @return [Time]
3463
+ #
3464
+ # @!attribute [rw] event_last_replayed_time
3465
+ # A time stamp for the time that the last event was replayed.
3466
+ # @return [Time]
3467
+ #
3468
+ # @!attribute [rw] replay_start_time
3469
+ # A time stamp for the time that the replay started.
3470
+ # @return [Time]
3471
+ #
3472
+ # @!attribute [rw] replay_end_time
3473
+ # A time stamp for the time that the replay completed.
3474
+ # @return [Time]
3475
+ #
3476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Replay AWS API Documentation
3477
+ #
3478
+ class Replay < Struct.new(
3479
+ :replay_name,
3480
+ :event_source_arn,
3481
+ :state,
3482
+ :state_reason,
3483
+ :event_start_time,
3484
+ :event_end_time,
3485
+ :event_last_replayed_time,
3486
+ :replay_start_time,
3487
+ :replay_end_time)
3488
+ SENSITIVE = []
3489
+ include Aws::Structure
3490
+ end
3491
+
3492
+ # A `ReplayDestination` object that contains details about a replay.
3493
+ #
3494
+ # @!attribute [rw] arn
3495
+ # The ARN of the event bus to replay event to. You can replay events
3496
+ # only to the event bus specified to create the archive.
3497
+ # @return [String]
3498
+ #
3499
+ # @!attribute [rw] filter_arns
3500
+ # A list of ARNs for rules to replay events to.
3501
+ # @return [Array<String>]
2222
3502
  #
2223
- class RemoveTargetsResultEntry < Struct.new(
2224
- :target_id,
2225
- :error_code,
2226
- :error_message)
3503
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ReplayDestination AWS API Documentation
3504
+ #
3505
+ class ReplayDestination < Struct.new(
3506
+ :arn,
3507
+ :filter_arns)
2227
3508
  SENSITIVE = []
2228
3509
  include Aws::Structure
2229
3510
  end
@@ -2240,6 +3521,30 @@ module Aws::CloudWatchEvents
2240
3521
  #
2241
3522
  class ResourceNotFoundException < Aws::EmptyStructure; end
2242
3523
 
3524
+ # A `RetryPolicy` object that includes information about the retry
3525
+ # policy settings.
3526
+ #
3527
+ # @!attribute [rw] maximum_retry_attempts
3528
+ # The maximum number of retry attempts to make before the request
3529
+ # fails. Retry attempts continue until either the maximum number of
3530
+ # attempts is made or until the duration of the
3531
+ # `MaximumEventAgeInSeconds` is met.
3532
+ # @return [Integer]
3533
+ #
3534
+ # @!attribute [rw] maximum_event_age_in_seconds
3535
+ # The maximum amount of time, in seconds, to continue to make retry
3536
+ # attempts.
3537
+ # @return [Integer]
3538
+ #
3539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RetryPolicy AWS API Documentation
3540
+ #
3541
+ class RetryPolicy < Struct.new(
3542
+ :maximum_retry_attempts,
3543
+ :maximum_event_age_in_seconds)
3544
+ SENSITIVE = []
3545
+ include Aws::Structure
3546
+ end
3547
+
2243
3548
  # Contains information about a rule in Amazon EventBridge.
2244
3549
  #
2245
3550
  # @!attribute [rw] name
@@ -2269,22 +3574,34 @@ module Aws::CloudWatchEvents
2269
3574
  #
2270
3575
  # @!attribute [rw] schedule_expression
2271
3576
  # The scheduling expression. For example, "cron(0 20 * * ? *)",
2272
- # "rate(5 minutes)".
3577
+ # "rate(5 minutes)". For more information, see [Creating an Amazon
3578
+ # EventBridge rule that runs on a schedule][1].
3579
+ #
3580
+ #
3581
+ #
3582
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html
2273
3583
  # @return [String]
2274
3584
  #
2275
3585
  # @!attribute [rw] role_arn
2276
3586
  # The Amazon Resource Name (ARN) of the role that is used for target
2277
3587
  # invocation.
3588
+ #
3589
+ # If you're setting an event bus in another account as the target and
3590
+ # that account granted permission to your account through an
3591
+ # organization instead of directly by the account ID, you must specify
3592
+ # a `RoleArn` with proper permissions in the `Target` structure,
3593
+ # instead of here in this parameter.
2278
3594
  # @return [String]
2279
3595
  #
2280
3596
  # @!attribute [rw] managed_by
2281
- # If the rule was created on behalf of your account by an AWS service,
2282
- # this field displays the principal name of the service that created
2283
- # the rule.
3597
+ # If the rule was created on behalf of your account by an Amazon Web
3598
+ # Services service, this field displays the principal name of the
3599
+ # service that created the rule.
2284
3600
  # @return [String]
2285
3601
  #
2286
3602
  # @!attribute [rw] event_bus_name
2287
- # The event bus associated with the rule.
3603
+ # The name or ARN of the event bus associated with the rule. If you
3604
+ # omit this, the default event bus is used.
2288
3605
  # @return [String]
2289
3606
  #
2290
3607
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Rule AWS API Documentation
@@ -2306,18 +3623,6 @@ module Aws::CloudWatchEvents
2306
3623
  # This parameter contains the criteria (either InstanceIds or a tag)
2307
3624
  # used to specify which EC2 instances are to be sent the command.
2308
3625
  #
2309
- # @note When making an API call, you may pass RunCommandParameters
2310
- # data as a hash:
2311
- #
2312
- # {
2313
- # run_command_targets: [ # required
2314
- # {
2315
- # key: "RunCommandTargetKey", # required
2316
- # values: ["RunCommandTargetValue"], # required
2317
- # },
2318
- # ],
2319
- # }
2320
- #
2321
3626
  # @!attribute [rw] run_command_targets
2322
3627
  # Currently, we support including only one RunCommandTarget block,
2323
3628
  # which specifies either an array of InstanceIds or a tag.
@@ -2335,14 +3640,6 @@ module Aws::CloudWatchEvents
2335
3640
  # specified as key-value pairs. Each `RunCommandTarget` block can
2336
3641
  # include only one key, but this key may specify multiple values.
2337
3642
  #
2338
- # @note When making an API call, you may pass RunCommandTarget
2339
- # data as a hash:
2340
- #
2341
- # {
2342
- # key: "RunCommandTargetKey", # required
2343
- # values: ["RunCommandTargetValue"], # required
2344
- # }
2345
- #
2346
3643
  # @!attribute [rw] key
2347
3644
  # Can be either `tag:` *tag-key* or `InstanceIds`.
2348
3645
  # @return [String]
@@ -2362,15 +3659,46 @@ module Aws::CloudWatchEvents
2362
3659
  include Aws::Structure
2363
3660
  end
2364
3661
 
2365
- # This structure includes the custom parameter to be used when the
2366
- # target is an SQS FIFO queue.
3662
+ # Name/Value pair of a parameter to start execution of a SageMaker Model
3663
+ # Building Pipeline.
3664
+ #
3665
+ # @!attribute [rw] name
3666
+ # Name of parameter to start execution of a SageMaker Model Building
3667
+ # Pipeline.
3668
+ # @return [String]
3669
+ #
3670
+ # @!attribute [rw] value
3671
+ # Value of parameter to start execution of a SageMaker Model Building
3672
+ # Pipeline.
3673
+ # @return [String]
3674
+ #
3675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/SageMakerPipelineParameter AWS API Documentation
3676
+ #
3677
+ class SageMakerPipelineParameter < Struct.new(
3678
+ :name,
3679
+ :value)
3680
+ SENSITIVE = []
3681
+ include Aws::Structure
3682
+ end
3683
+
3684
+ # These are custom parameters to use when the target is a SageMaker
3685
+ # Model Building Pipeline that starts based on EventBridge events.
2367
3686
  #
2368
- # @note When making an API call, you may pass SqsParameters
2369
- # data as a hash:
3687
+ # @!attribute [rw] pipeline_parameter_list
3688
+ # List of Parameter names and values for SageMaker Model Building
3689
+ # Pipeline execution.
3690
+ # @return [Array<Types::SageMakerPipelineParameter>]
2370
3691
  #
2371
- # {
2372
- # message_group_id: "MessageGroupId",
2373
- # }
3692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/SageMakerPipelineParameters AWS API Documentation
3693
+ #
3694
+ class SageMakerPipelineParameters < Struct.new(
3695
+ :pipeline_parameter_list)
3696
+ SENSITIVE = []
3697
+ include Aws::Structure
3698
+ end
3699
+
3700
+ # This structure includes the custom parameter to be used when the
3701
+ # target is an SQS FIFO queue.
2374
3702
  #
2375
3703
  # @!attribute [rw] message_group_id
2376
3704
  # The FIFO message group ID to use as the target.
@@ -2384,16 +3712,77 @@ module Aws::CloudWatchEvents
2384
3712
  include Aws::Structure
2385
3713
  end
2386
3714
 
2387
- # A key-value pair associated with an AWS resource. In EventBridge,
2388
- # rules and event buses support tagging.
3715
+ # @!attribute [rw] replay_name
3716
+ # The name of the replay to start.
3717
+ # @return [String]
3718
+ #
3719
+ # @!attribute [rw] description
3720
+ # A description for the replay to start.
3721
+ # @return [String]
3722
+ #
3723
+ # @!attribute [rw] event_source_arn
3724
+ # The ARN of the archive to replay events from.
3725
+ # @return [String]
3726
+ #
3727
+ # @!attribute [rw] event_start_time
3728
+ # A time stamp for the time to start replaying events. Only events
3729
+ # that occurred between the `EventStartTime` and `EventEndTime` are
3730
+ # replayed.
3731
+ # @return [Time]
3732
+ #
3733
+ # @!attribute [rw] event_end_time
3734
+ # A time stamp for the time to stop replaying events. Only events that
3735
+ # occurred between the `EventStartTime` and `EventEndTime` are
3736
+ # replayed.
3737
+ # @return [Time]
3738
+ #
3739
+ # @!attribute [rw] destination
3740
+ # A `ReplayDestination` object that includes details about the
3741
+ # destination for the replay.
3742
+ # @return [Types::ReplayDestination]
3743
+ #
3744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/StartReplayRequest AWS API Documentation
3745
+ #
3746
+ class StartReplayRequest < Struct.new(
3747
+ :replay_name,
3748
+ :description,
3749
+ :event_source_arn,
3750
+ :event_start_time,
3751
+ :event_end_time,
3752
+ :destination)
3753
+ SENSITIVE = []
3754
+ include Aws::Structure
3755
+ end
3756
+
3757
+ # @!attribute [rw] replay_arn
3758
+ # The ARN of the replay.
3759
+ # @return [String]
3760
+ #
3761
+ # @!attribute [rw] state
3762
+ # The state of the replay.
3763
+ # @return [String]
2389
3764
  #
2390
- # @note When making an API call, you may pass Tag
2391
- # data as a hash:
3765
+ # @!attribute [rw] state_reason
3766
+ # The reason that the replay is in the state.
3767
+ # @return [String]
3768
+ #
3769
+ # @!attribute [rw] replay_start_time
3770
+ # The time at which the replay started.
3771
+ # @return [Time]
3772
+ #
3773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/StartReplayResponse AWS API Documentation
2392
3774
  #
2393
- # {
2394
- # key: "TagKey", # required
2395
- # value: "TagValue", # required
2396
- # }
3775
+ class StartReplayResponse < Struct.new(
3776
+ :replay_arn,
3777
+ :state,
3778
+ :state_reason,
3779
+ :replay_start_time)
3780
+ SENSITIVE = []
3781
+ include Aws::Structure
3782
+ end
3783
+
3784
+ # A key-value pair associated with an Amazon Web Services resource. In
3785
+ # EventBridge, rules and event buses support tagging.
2397
3786
  #
2398
3787
  # @!attribute [rw] key
2399
3788
  # A string you can use to assign a value. The combination of tag keys
@@ -2413,19 +3802,6 @@ module Aws::CloudWatchEvents
2413
3802
  include Aws::Structure
2414
3803
  end
2415
3804
 
2416
- # @note When making an API call, you may pass TagResourceRequest
2417
- # data as a hash:
2418
- #
2419
- # {
2420
- # resource_arn: "Arn", # required
2421
- # tags: [ # required
2422
- # {
2423
- # key: "TagKey", # required
2424
- # value: "TagValue", # required
2425
- # },
2426
- # ],
2427
- # }
2428
- #
2429
3805
  # @!attribute [rw] resource_arn
2430
3806
  # The ARN of the EventBridge resource that you're adding tags to.
2431
3807
  # @return [String]
@@ -2449,85 +3825,23 @@ module Aws::CloudWatchEvents
2449
3825
 
2450
3826
  # Targets are the resources to be invoked when a rule is triggered. For
2451
3827
  # a complete list of services and resources that can be set as a target,
2452
- # see PutTargets.
3828
+ # see [PutTargets][1].
2453
3829
  #
2454
3830
  # If you are setting the event bus of another account as the target, and
2455
3831
  # that account granted permission to your account through an
2456
3832
  # organization instead of directly by the account ID, then you must
2457
3833
  # specify a `RoleArn` with proper permissions in the `Target` structure.
2458
- # For more information, see [Sending and Receiving Events Between AWS
2459
- # Accounts][1] in the *Amazon EventBridge User Guide*.
2460
- #
2461
- #
2462
- #
2463
- # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
2464
- #
2465
- # @note When making an API call, you may pass Target
2466
- # data as a hash:
2467
- #
2468
- # {
2469
- # id: "TargetId", # required
2470
- # arn: "TargetArn", # required
2471
- # role_arn: "RoleArn",
2472
- # input: "TargetInput",
2473
- # input_path: "TargetInputPath",
2474
- # input_transformer: {
2475
- # input_paths_map: {
2476
- # "InputTransformerPathKey" => "TargetInputPath",
2477
- # },
2478
- # input_template: "TransformerInput", # required
2479
- # },
2480
- # kinesis_parameters: {
2481
- # partition_key_path: "TargetPartitionKeyPath", # required
2482
- # },
2483
- # run_command_parameters: {
2484
- # run_command_targets: [ # required
2485
- # {
2486
- # key: "RunCommandTargetKey", # required
2487
- # values: ["RunCommandTargetValue"], # required
2488
- # },
2489
- # ],
2490
- # },
2491
- # ecs_parameters: {
2492
- # task_definition_arn: "Arn", # required
2493
- # task_count: 1,
2494
- # launch_type: "EC2", # accepts EC2, FARGATE
2495
- # network_configuration: {
2496
- # awsvpc_configuration: {
2497
- # subnets: ["String"], # required
2498
- # security_groups: ["String"],
2499
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
2500
- # },
2501
- # },
2502
- # platform_version: "String",
2503
- # group: "String",
2504
- # },
2505
- # batch_parameters: {
2506
- # job_definition: "String", # required
2507
- # job_name: "String", # required
2508
- # array_properties: {
2509
- # size: 1,
2510
- # },
2511
- # retry_strategy: {
2512
- # attempts: 1,
2513
- # },
2514
- # },
2515
- # sqs_parameters: {
2516
- # message_group_id: "MessageGroupId",
2517
- # },
2518
- # http_parameters: {
2519
- # path_parameter_values: ["PathParameter"],
2520
- # header_parameters: {
2521
- # "HeaderKey" => "HeaderValue",
2522
- # },
2523
- # query_string_parameters: {
2524
- # "QueryStringKey" => "QueryStringValue",
2525
- # },
2526
- # },
2527
- # }
3834
+ # For more information, see [Sending and Receiving Events Between Amazon
3835
+ # Web Services Accounts][2] in the *Amazon EventBridge User Guide*.
3836
+ #
3837
+ #
3838
+ #
3839
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html
3840
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
2528
3841
  #
2529
3842
  # @!attribute [rw] id
2530
- # The ID of the target.
3843
+ # The ID of the target. We recommend using a memorable and unique
3844
+ # string.
2531
3845
  # @return [String]
2532
3846
  #
2533
3847
  # @!attribute [rw] arn
@@ -2591,9 +3905,9 @@ module Aws::CloudWatchEvents
2591
3905
  # @return [Types::EcsParameters]
2592
3906
  #
2593
3907
  # @!attribute [rw] batch_parameters
2594
- # If the event target is an AWS Batch job, this contains the job
3908
+ # If the event target is an Batch job, this contains the job
2595
3909
  # definition, job name, and other parameters. For more information,
2596
- # see [Jobs][1] in the *AWS Batch User Guide*.
3910
+ # see [Jobs][1] in the *Batch User Guide*.
2597
3911
  #
2598
3912
  #
2599
3913
  #
@@ -2610,13 +3924,45 @@ module Aws::CloudWatchEvents
2610
3924
  #
2611
3925
  # @!attribute [rw] http_parameters
2612
3926
  # Contains the HTTP parameters to use when the target is a API Gateway
2613
- # REST endpoint.
2614
- #
2615
- # If you specify an API Gateway REST API as a target, you can use this
2616
- # parameter to specify headers, path parameter, query string
2617
- # keys/values as part of your target invoking request.
3927
+ # REST endpoint or EventBridge ApiDestination.
3928
+ #
3929
+ # If you specify an API Gateway REST API or EventBridge ApiDestination
3930
+ # as a target, you can use this parameter to specify headers, path
3931
+ # parameters, and query string keys/values as part of your target
3932
+ # invoking request. If you're using ApiDestinations, the
3933
+ # corresponding Connection can also have these values configured. In
3934
+ # case of any conflicting keys, values from the Connection take
3935
+ # precedence.
2618
3936
  # @return [Types::HttpParameters]
2619
3937
  #
3938
+ # @!attribute [rw] redshift_data_parameters
3939
+ # Contains the Amazon Redshift Data API parameters to use when the
3940
+ # target is a Amazon Redshift cluster.
3941
+ #
3942
+ # If you specify a Amazon Redshift Cluster as a Target, you can use
3943
+ # this to specify parameters to invoke the Amazon Redshift Data API
3944
+ # ExecuteStatement based on EventBridge events.
3945
+ # @return [Types::RedshiftDataParameters]
3946
+ #
3947
+ # @!attribute [rw] sage_maker_pipeline_parameters
3948
+ # Contains the SageMaker Model Building Pipeline parameters to start
3949
+ # execution of a SageMaker Model Building Pipeline.
3950
+ #
3951
+ # If you specify a SageMaker Model Building Pipeline as a target, you
3952
+ # can use this to specify parameters to start a pipeline execution
3953
+ # based on EventBridge events.
3954
+ # @return [Types::SageMakerPipelineParameters]
3955
+ #
3956
+ # @!attribute [rw] dead_letter_config
3957
+ # The `DeadLetterConfig` that defines the target queue to send
3958
+ # dead-letter queue events to.
3959
+ # @return [Types::DeadLetterConfig]
3960
+ #
3961
+ # @!attribute [rw] retry_policy
3962
+ # The `RetryPolicy` object that contains the retry policy
3963
+ # configuration to use for the dead-letter queue.
3964
+ # @return [Types::RetryPolicy]
3965
+ #
2620
3966
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Target AWS API Documentation
2621
3967
  #
2622
3968
  class Target < Struct.new(
@@ -2631,19 +3977,15 @@ module Aws::CloudWatchEvents
2631
3977
  :ecs_parameters,
2632
3978
  :batch_parameters,
2633
3979
  :sqs_parameters,
2634
- :http_parameters)
3980
+ :http_parameters,
3981
+ :redshift_data_parameters,
3982
+ :sage_maker_pipeline_parameters,
3983
+ :dead_letter_config,
3984
+ :retry_policy)
2635
3985
  SENSITIVE = []
2636
3986
  include Aws::Structure
2637
3987
  end
2638
3988
 
2639
- # @note When making an API call, you may pass TestEventPatternRequest
2640
- # data as a hash:
2641
- #
2642
- # {
2643
- # event_pattern: "EventPattern", # required
2644
- # event: "String", # required
2645
- # }
2646
- #
2647
3989
  # @!attribute [rw] event_pattern
2648
3990
  # The event pattern. For more information, see [Events and Event
2649
3991
  # Patterns][1] in the *Amazon EventBridge User Guide*.
@@ -2654,7 +3996,27 @@ module Aws::CloudWatchEvents
2654
3996
  # @return [String]
2655
3997
  #
2656
3998
  # @!attribute [rw] event
2657
- # The event, in JSON format, to test against the event pattern.
3999
+ # The event, in JSON format, to test against the event pattern. The
4000
+ # JSON must follow the format specified in [Amazon Web Services
4001
+ # Events][1], and the following fields are mandatory:
4002
+ #
4003
+ # * `id`
4004
+ #
4005
+ # * `account`
4006
+ #
4007
+ # * `source`
4008
+ #
4009
+ # * `time`
4010
+ #
4011
+ # * `region`
4012
+ #
4013
+ # * `resources`
4014
+ #
4015
+ # * `detail-type`
4016
+ #
4017
+ #
4018
+ #
4019
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html
2658
4020
  # @return [String]
2659
4021
  #
2660
4022
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/TestEventPatternRequest AWS API Documentation
@@ -2678,14 +4040,6 @@ module Aws::CloudWatchEvents
2678
4040
  include Aws::Structure
2679
4041
  end
2680
4042
 
2681
- # @note When making an API call, you may pass UntagResourceRequest
2682
- # data as a hash:
2683
- #
2684
- # {
2685
- # resource_arn: "Arn", # required
2686
- # tag_keys: ["TagKey"], # required
2687
- # }
2688
- #
2689
4043
  # @!attribute [rw] resource_arn
2690
4044
  # The ARN of the EventBridge resource from which you are removing
2691
4045
  # tags.
@@ -2708,5 +4062,310 @@ module Aws::CloudWatchEvents
2708
4062
  #
2709
4063
  class UntagResourceResponse < Aws::EmptyStructure; end
2710
4064
 
4065
+ # @!attribute [rw] name
4066
+ # The name of the API destination to update.
4067
+ # @return [String]
4068
+ #
4069
+ # @!attribute [rw] description
4070
+ # The name of the API destination to update.
4071
+ # @return [String]
4072
+ #
4073
+ # @!attribute [rw] connection_arn
4074
+ # The ARN of the connection to use for the API destination.
4075
+ # @return [String]
4076
+ #
4077
+ # @!attribute [rw] invocation_endpoint
4078
+ # The URL to the endpoint to use for the API destination.
4079
+ # @return [String]
4080
+ #
4081
+ # @!attribute [rw] http_method
4082
+ # The method to use for the API destination.
4083
+ # @return [String]
4084
+ #
4085
+ # @!attribute [rw] invocation_rate_limit_per_second
4086
+ # The maximum number of invocations per second to send to the API
4087
+ # destination.
4088
+ # @return [Integer]
4089
+ #
4090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateApiDestinationRequest AWS API Documentation
4091
+ #
4092
+ class UpdateApiDestinationRequest < Struct.new(
4093
+ :name,
4094
+ :description,
4095
+ :connection_arn,
4096
+ :invocation_endpoint,
4097
+ :http_method,
4098
+ :invocation_rate_limit_per_second)
4099
+ SENSITIVE = []
4100
+ include Aws::Structure
4101
+ end
4102
+
4103
+ # @!attribute [rw] api_destination_arn
4104
+ # The ARN of the API destination that was updated.
4105
+ # @return [String]
4106
+ #
4107
+ # @!attribute [rw] api_destination_state
4108
+ # The state of the API destination that was updated.
4109
+ # @return [String]
4110
+ #
4111
+ # @!attribute [rw] creation_time
4112
+ # A time stamp for the time that the API destination was created.
4113
+ # @return [Time]
4114
+ #
4115
+ # @!attribute [rw] last_modified_time
4116
+ # A time stamp for the time that the API destination was last
4117
+ # modified.
4118
+ # @return [Time]
4119
+ #
4120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateApiDestinationResponse AWS API Documentation
4121
+ #
4122
+ class UpdateApiDestinationResponse < Struct.new(
4123
+ :api_destination_arn,
4124
+ :api_destination_state,
4125
+ :creation_time,
4126
+ :last_modified_time)
4127
+ SENSITIVE = []
4128
+ include Aws::Structure
4129
+ end
4130
+
4131
+ # @!attribute [rw] archive_name
4132
+ # The name of the archive to update.
4133
+ # @return [String]
4134
+ #
4135
+ # @!attribute [rw] description
4136
+ # The description for the archive.
4137
+ # @return [String]
4138
+ #
4139
+ # @!attribute [rw] event_pattern
4140
+ # The event pattern to use to filter events sent to the archive.
4141
+ # @return [String]
4142
+ #
4143
+ # @!attribute [rw] retention_days
4144
+ # The number of days to retain events in the archive.
4145
+ # @return [Integer]
4146
+ #
4147
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateArchiveRequest AWS API Documentation
4148
+ #
4149
+ class UpdateArchiveRequest < Struct.new(
4150
+ :archive_name,
4151
+ :description,
4152
+ :event_pattern,
4153
+ :retention_days)
4154
+ SENSITIVE = []
4155
+ include Aws::Structure
4156
+ end
4157
+
4158
+ # @!attribute [rw] archive_arn
4159
+ # The ARN of the archive.
4160
+ # @return [String]
4161
+ #
4162
+ # @!attribute [rw] state
4163
+ # The state of the archive.
4164
+ # @return [String]
4165
+ #
4166
+ # @!attribute [rw] state_reason
4167
+ # The reason that the archive is in the current state.
4168
+ # @return [String]
4169
+ #
4170
+ # @!attribute [rw] creation_time
4171
+ # The time at which the archive was updated.
4172
+ # @return [Time]
4173
+ #
4174
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateArchiveResponse AWS API Documentation
4175
+ #
4176
+ class UpdateArchiveResponse < Struct.new(
4177
+ :archive_arn,
4178
+ :state,
4179
+ :state_reason,
4180
+ :creation_time)
4181
+ SENSITIVE = []
4182
+ include Aws::Structure
4183
+ end
4184
+
4185
+ # Contains the API key authorization parameters to use to update the
4186
+ # connection.
4187
+ #
4188
+ # @!attribute [rw] api_key_name
4189
+ # The name of the API key to use for authorization.
4190
+ # @return [String]
4191
+ #
4192
+ # @!attribute [rw] api_key_value
4193
+ # The value associated with teh API key to use for authorization.
4194
+ # @return [String]
4195
+ #
4196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnectionApiKeyAuthRequestParameters AWS API Documentation
4197
+ #
4198
+ class UpdateConnectionApiKeyAuthRequestParameters < Struct.new(
4199
+ :api_key_name,
4200
+ :api_key_value)
4201
+ SENSITIVE = []
4202
+ include Aws::Structure
4203
+ end
4204
+
4205
+ # Contains the additional parameters to use for the connection.
4206
+ #
4207
+ # @!attribute [rw] basic_auth_parameters
4208
+ # A `UpdateConnectionBasicAuthRequestParameters` object that contains
4209
+ # the authorization parameters for Basic authorization.
4210
+ # @return [Types::UpdateConnectionBasicAuthRequestParameters]
4211
+ #
4212
+ # @!attribute [rw] o_auth_parameters
4213
+ # A `UpdateConnectionOAuthRequestParameters` object that contains the
4214
+ # authorization parameters for OAuth authorization.
4215
+ # @return [Types::UpdateConnectionOAuthRequestParameters]
4216
+ #
4217
+ # @!attribute [rw] api_key_auth_parameters
4218
+ # A `UpdateConnectionApiKeyAuthRequestParameters` object that contains
4219
+ # the authorization parameters for API key authorization.
4220
+ # @return [Types::UpdateConnectionApiKeyAuthRequestParameters]
4221
+ #
4222
+ # @!attribute [rw] invocation_http_parameters
4223
+ # A `ConnectionHttpParameters` object that contains the additional
4224
+ # parameters to use for the connection.
4225
+ # @return [Types::ConnectionHttpParameters]
4226
+ #
4227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnectionAuthRequestParameters AWS API Documentation
4228
+ #
4229
+ class UpdateConnectionAuthRequestParameters < Struct.new(
4230
+ :basic_auth_parameters,
4231
+ :o_auth_parameters,
4232
+ :api_key_auth_parameters,
4233
+ :invocation_http_parameters)
4234
+ SENSITIVE = []
4235
+ include Aws::Structure
4236
+ end
4237
+
4238
+ # Contains the Basic authorization parameters for the connection.
4239
+ #
4240
+ # @!attribute [rw] username
4241
+ # The user name to use for Basic authorization.
4242
+ # @return [String]
4243
+ #
4244
+ # @!attribute [rw] password
4245
+ # The password associated with the user name to use for Basic
4246
+ # authorization.
4247
+ # @return [String]
4248
+ #
4249
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnectionBasicAuthRequestParameters AWS API Documentation
4250
+ #
4251
+ class UpdateConnectionBasicAuthRequestParameters < Struct.new(
4252
+ :username,
4253
+ :password)
4254
+ SENSITIVE = []
4255
+ include Aws::Structure
4256
+ end
4257
+
4258
+ # Contains the OAuth authorization parameters to use for the connection.
4259
+ #
4260
+ # @!attribute [rw] client_id
4261
+ # The client ID to use for OAuth authorization.
4262
+ # @return [String]
4263
+ #
4264
+ # @!attribute [rw] client_secret
4265
+ # The client secret assciated with the client ID to use for OAuth
4266
+ # authorization.
4267
+ # @return [String]
4268
+ #
4269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnectionOAuthClientRequestParameters AWS API Documentation
4270
+ #
4271
+ class UpdateConnectionOAuthClientRequestParameters < Struct.new(
4272
+ :client_id,
4273
+ :client_secret)
4274
+ SENSITIVE = []
4275
+ include Aws::Structure
4276
+ end
4277
+
4278
+ # Contains the OAuth request parameters to use for the connection.
4279
+ #
4280
+ # @!attribute [rw] client_parameters
4281
+ # A `UpdateConnectionOAuthClientRequestParameters` object that
4282
+ # contains the client parameters to use for the connection when OAuth
4283
+ # is specified as the authorization type.
4284
+ # @return [Types::UpdateConnectionOAuthClientRequestParameters]
4285
+ #
4286
+ # @!attribute [rw] authorization_endpoint
4287
+ # The URL to the authorization endpoint when OAuth is specified as the
4288
+ # authorization type.
4289
+ # @return [String]
4290
+ #
4291
+ # @!attribute [rw] http_method
4292
+ # The method used to connect to the HTTP endpoint.
4293
+ # @return [String]
4294
+ #
4295
+ # @!attribute [rw] o_auth_http_parameters
4296
+ # The additional HTTP parameters used for the OAuth authorization
4297
+ # request.
4298
+ # @return [Types::ConnectionHttpParameters]
4299
+ #
4300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnectionOAuthRequestParameters AWS API Documentation
4301
+ #
4302
+ class UpdateConnectionOAuthRequestParameters < Struct.new(
4303
+ :client_parameters,
4304
+ :authorization_endpoint,
4305
+ :http_method,
4306
+ :o_auth_http_parameters)
4307
+ SENSITIVE = []
4308
+ include Aws::Structure
4309
+ end
4310
+
4311
+ # @!attribute [rw] name
4312
+ # The name of the connection to update.
4313
+ # @return [String]
4314
+ #
4315
+ # @!attribute [rw] description
4316
+ # A description for the connection.
4317
+ # @return [String]
4318
+ #
4319
+ # @!attribute [rw] authorization_type
4320
+ # The type of authorization to use for the connection.
4321
+ # @return [String]
4322
+ #
4323
+ # @!attribute [rw] auth_parameters
4324
+ # The authorization parameters to use for the connection.
4325
+ # @return [Types::UpdateConnectionAuthRequestParameters]
4326
+ #
4327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnectionRequest AWS API Documentation
4328
+ #
4329
+ class UpdateConnectionRequest < Struct.new(
4330
+ :name,
4331
+ :description,
4332
+ :authorization_type,
4333
+ :auth_parameters)
4334
+ SENSITIVE = []
4335
+ include Aws::Structure
4336
+ end
4337
+
4338
+ # @!attribute [rw] connection_arn
4339
+ # The ARN of the connection that was updated.
4340
+ # @return [String]
4341
+ #
4342
+ # @!attribute [rw] connection_state
4343
+ # The state of the connection that was updated.
4344
+ # @return [String]
4345
+ #
4346
+ # @!attribute [rw] creation_time
4347
+ # A time stamp for the time that the connection was created.
4348
+ # @return [Time]
4349
+ #
4350
+ # @!attribute [rw] last_modified_time
4351
+ # A time stamp for the time that the connection was last modified.
4352
+ # @return [Time]
4353
+ #
4354
+ # @!attribute [rw] last_authorized_time
4355
+ # A time stamp for the time that the connection was last authorized.
4356
+ # @return [Time]
4357
+ #
4358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnectionResponse AWS API Documentation
4359
+ #
4360
+ class UpdateConnectionResponse < Struct.new(
4361
+ :connection_arn,
4362
+ :connection_state,
4363
+ :creation_time,
4364
+ :last_modified_time,
4365
+ :last_authorized_time)
4366
+ SENSITIVE = []
4367
+ include Aws::Structure
4368
+ end
4369
+
2711
4370
  end
2712
4371
  end