aws-sdk-eventbridge 1.3.0 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -192,6 +192,7 @@ module Aws::EventBridge
192
192
 
193
193
  CreateEventBusRequest.add_member(:name, Shapes::ShapeRef.new(shape: EventBusName, required: true, location_name: "Name"))
194
194
  CreateEventBusRequest.add_member(:event_source_name, Shapes::ShapeRef.new(shape: EventSourceName, location_name: "EventSourceName"))
195
+ CreateEventBusRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
195
196
  CreateEventBusRequest.struct_class = Types::CreateEventBusRequest
196
197
 
197
198
  CreateEventBusResponse.add_member(:event_bus_arn, Shapes::ShapeRef.new(shape: String, location_name: "EventBusArn"))
@@ -419,7 +420,7 @@ module Aws::EventBridge
419
420
  PutPartnerEventsRequest.struct_class = Types::PutPartnerEventsRequest
420
421
 
421
422
  PutPartnerEventsRequestEntry.add_member(:time, Shapes::ShapeRef.new(shape: EventTime, location_name: "Time"))
422
- PutPartnerEventsRequestEntry.add_member(:source, Shapes::ShapeRef.new(shape: String, location_name: "Source"))
423
+ PutPartnerEventsRequestEntry.add_member(:source, Shapes::ShapeRef.new(shape: EventSourceName, location_name: "Source"))
423
424
  PutPartnerEventsRequestEntry.add_member(:resources, Shapes::ShapeRef.new(shape: EventResourceList, location_name: "Resources"))
424
425
  PutPartnerEventsRequestEntry.add_member(:detail_type, Shapes::ShapeRef.new(shape: String, location_name: "DetailType"))
425
426
  PutPartnerEventsRequestEntry.add_member(:detail, Shapes::ShapeRef.new(shape: String, location_name: "Detail"))
@@ -598,6 +599,7 @@ module Aws::EventBridge
598
599
  o.input = Shapes::ShapeRef.new(shape: ActivateEventSourceRequest)
599
600
  o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
600
601
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
602
+ o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
601
603
  o.errors << Shapes::ShapeRef.new(shape: InvalidStateException)
602
604
  o.errors << Shapes::ShapeRef.new(shape: InternalException)
603
605
  end)
@@ -635,6 +637,7 @@ module Aws::EventBridge
635
637
  o.input = Shapes::ShapeRef.new(shape: DeactivateEventSourceRequest)
636
638
  o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
637
639
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
640
+ o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
638
641
  o.errors << Shapes::ShapeRef.new(shape: InvalidStateException)
639
642
  o.errors << Shapes::ShapeRef.new(shape: InternalException)
640
643
  end)
@@ -646,6 +649,7 @@ module Aws::EventBridge
646
649
  o.input = Shapes::ShapeRef.new(shape: DeleteEventBusRequest)
647
650
  o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
648
651
  o.errors << Shapes::ShapeRef.new(shape: InternalException)
652
+ o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
649
653
  end)
650
654
 
651
655
  api.add_operation(:delete_partner_event_source, Seahorse::Model::Operation.new.tap do |o|
@@ -655,6 +659,7 @@ module Aws::EventBridge
655
659
  o.input = Shapes::ShapeRef.new(shape: DeletePartnerEventSourceRequest)
656
660
  o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
657
661
  o.errors << Shapes::ShapeRef.new(shape: InternalException)
662
+ o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
658
663
  end)
659
664
 
660
665
  api.add_operation(:delete_rule, Seahorse::Model::Operation.new.tap do |o|
@@ -27,7 +27,7 @@ module Aws::EventBridge
27
27
  end
28
28
 
29
29
  # This structure specifies the VPC subnets and security groups for the
30
- # task and whether a public IP address is to be used. This structure is
30
+ # task, and whether a public IP address is to be used. This structure is
31
31
  # relevant only for ECS tasks that use the `awsvpc` network mode.
32
32
  #
33
33
  # @note When making an API call, you may pass AwsVpcConfiguration
@@ -47,7 +47,7 @@ module Aws::EventBridge
47
47
  # @!attribute [rw] security_groups
48
48
  # Specifies the security groups associated with the task. These
49
49
  # security groups must all be in the same VPC. You can specify as many
50
- # as five security groups. If you don't specify a security group, the
50
+ # as five security groups. If you do not specify a security group, the
51
51
  # default security group for the VPC is used.
52
52
  # @return [Array<String>]
53
53
  #
@@ -124,7 +124,7 @@ module Aws::EventBridge
124
124
  # @return [Types::BatchArrayProperties]
125
125
  #
126
126
  # @!attribute [rw] retry_strategy
127
- # The retry strategy to use for failed jobs if the target is an AWS
127
+ # The retry strategy to use for failed jobs, if the target is an AWS
128
128
  # Batch job. The retry strategy is the number of times to retry the
129
129
  # failed job execution. Valid values are 1–10. When you specify a
130
130
  # retry strategy here, it overrides the retry strategy defined in the
@@ -141,7 +141,7 @@ module Aws::EventBridge
141
141
  include Aws::Structure
142
142
  end
143
143
 
144
- # The retry strategy to use for failed jobs if the target is an AWS
144
+ # The retry strategy to use for failed jobs, if the target is an AWS
145
145
  # Batch job. If you specify a retry strategy here, it overrides the
146
146
  # retry strategy defined in the job definition.
147
147
  #
@@ -164,12 +164,12 @@ module Aws::EventBridge
164
164
  include Aws::Structure
165
165
  end
166
166
 
167
- # A JSON string that you can use to limit the event bus permissions that
168
- # you're granting to only accounts that fulfill the condition.
169
- # Currently, the only supported condition is membership in a certain AWS
167
+ # A JSON string which you can use to limit the event bus permissions you
168
+ # are granting to only accounts that fulfill the condition. Currently,
169
+ # the only supported condition is membership in a certain AWS
170
170
  # organization. The string must contain `Type`, `Key`, and `Value`
171
171
  # fields. The `Value` field specifies the ID of the AWS organization.
172
- # The following is an example value for `Condition`\:
172
+ # Following is an example value for `Condition`\:
173
173
  #
174
174
  # `'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
175
175
  # "o-1234567890"\}'`
@@ -184,18 +184,18 @@ module Aws::EventBridge
184
184
  # }
185
185
  #
186
186
  # @!attribute [rw] type
187
- # The type of condition. Currently, the only supported value is
188
- # `StringEquals`.
187
+ # Specifies the type of condition. Currently the only supported value
188
+ # is `StringEquals`.
189
189
  # @return [String]
190
190
  #
191
191
  # @!attribute [rw] key
192
- # The key for the condition. Currently, the only supported key is
193
- # `aws:PrincipalOrgID`.
192
+ # Specifies the key for the condition. Currently the only supported
193
+ # key is `aws:PrincipalOrgID`.
194
194
  # @return [String]
195
195
  #
196
196
  # @!attribute [rw] value
197
- # The value for the key. Currently, this must be the ID of the
198
- # organization.
197
+ # Specifies the value for the key. Currently, this must be the ID of
198
+ # the organization.
199
199
  # @return [String]
200
200
  #
201
201
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Condition AWS API Documentation
@@ -213,30 +213,40 @@ module Aws::EventBridge
213
213
  # {
214
214
  # name: "EventBusName", # required
215
215
  # event_source_name: "EventSourceName",
216
+ # tags: [
217
+ # {
218
+ # key: "TagKey", # required
219
+ # value: "TagValue", # required
220
+ # },
221
+ # ],
216
222
  # }
217
223
  #
218
224
  # @!attribute [rw] name
219
225
  # The name of the new event bus.
220
226
  #
221
- # The names of custom event buses can't contain the `/` character.
222
- # You can't use the name `default` for a custom event bus because
223
- # this name is already used for your account's default event bus.
227
+ # Event bus names cannot contain the / character. You can't use the
228
+ # name `default` for a custom event bus, as this name is already used
229
+ # for your account's default event bus.
224
230
  #
225
231
  # If this is a partner event bus, the name must exactly match the name
226
- # of the partner event source that this event bus is matched to. This
227
- # name will include the `/` character.
232
+ # of the partner event source that this event bus is matched to.
228
233
  # @return [String]
229
234
  #
230
235
  # @!attribute [rw] event_source_name
231
- # If you're creating a partner event bus, this specifies the partner
236
+ # If you are creating a partner event bus, this specifies the partner
232
237
  # event source that the new event bus will be matched with.
233
238
  # @return [String]
234
239
  #
240
+ # @!attribute [rw] tags
241
+ # Tags to associate with the event bus.
242
+ # @return [Array<Types::Tag>]
243
+ #
235
244
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEventBusRequest AWS API Documentation
236
245
  #
237
246
  class CreateEventBusRequest < Struct.new(
238
247
  :name,
239
- :event_source_name)
248
+ :event_source_name,
249
+ :tags)
240
250
  include Aws::Structure
241
251
  end
242
252
 
@@ -268,8 +278,8 @@ module Aws::EventBridge
268
278
  # @return [String]
269
279
  #
270
280
  # @!attribute [rw] account
271
- # The AWS account ID of the customer who is permitted to create a
272
- # matching partner event bus for this partner event source.
281
+ # The AWS account ID that is permitted to create a matching partner
282
+ # event bus for this partner event source.
273
283
  # @return [String]
274
284
  #
275
285
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
@@ -460,7 +470,7 @@ module Aws::EventBridge
460
470
  # @return [Time]
461
471
  #
462
472
  # @!attribute [rw] expiration_time
463
- # The date and time that the event source will expire if you don't
473
+ # The date and time that the event source will expire if you do not
464
474
  # create a matching event bus.
465
475
  # @return [Time]
466
476
  #
@@ -469,12 +479,12 @@ module Aws::EventBridge
469
479
  # @return [String]
470
480
  #
471
481
  # @!attribute [rw] state
472
- # The state of the event source. If it's `ACTIVE`, you have already
482
+ # The state of the event source. If it is ACTIVE, you have already
473
483
  # created a matching event bus for this event source, and that event
474
- # bus is active. If it's `PENDING`, either you haven't yet created a
475
- # matching event bus, or that event bus is deactivated. If it's
476
- # `DELETED`, you have created a matching event bus, but the event
477
- # source has since been deleted.
484
+ # bus is active. If it is PENDING, either you haven't yet created a
485
+ # matching event bus, or that event bus is deactivated. If it is
486
+ # DELETED, you have created a matching event bus, but the event source
487
+ # has since been deleted.
478
488
  # @return [String]
479
489
  #
480
490
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeEventSourceResponse AWS API Documentation
@@ -557,8 +567,8 @@ module Aws::EventBridge
557
567
  # @return [String]
558
568
  #
559
569
  # @!attribute [rw] event_pattern
560
- # The event pattern. For more information, see [Event Patterns][1] in
561
- # the *Amazon EventBridge User Guide*.
570
+ # The event pattern. For more information, see [Events and Event
571
+ # Patterns][1] in the *Amazon EventBridge User Guide*.
562
572
  #
563
573
  #
564
574
  #
@@ -566,8 +576,8 @@ module Aws::EventBridge
566
576
  # @return [String]
567
577
  #
568
578
  # @!attribute [rw] schedule_expression
569
- # The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
570
- # `"rate(5 minutes)"`.
579
+ # The scheduling expression. For example, "cron(0 20 * * ? *)",
580
+ # "rate(5 minutes)".
571
581
  # @return [String]
572
582
  #
573
583
  # @!attribute [rw] state
@@ -680,12 +690,12 @@ module Aws::EventBridge
680
690
  # @!attribute [rw] network_configuration
681
691
  # Use this structure if the ECS task uses the `awsvpc` network mode.
682
692
  # This structure specifies the VPC subnets and security groups
683
- # associated with the task and whether a public IP address is to be
693
+ # associated with the task, and whether a public IP address is to be
684
694
  # used. This structure is required if `LaunchType` is `FARGATE`
685
695
  # because the `awsvpc` mode is required for Fargate tasks.
686
696
  #
687
- # If you specify `NetworkConfiguration` when the target ECS task
688
- # doesn't use the `awsvpc` network mode, the task fails.
697
+ # If you specify `NetworkConfiguration` when the target ECS task does
698
+ # not use the `awsvpc` network mode, the task fails.
689
699
  # @return [Types::NetworkConfiguration]
690
700
  #
691
701
  # @!attribute [rw] platform_version
@@ -788,11 +798,11 @@ module Aws::EventBridge
788
798
  # @return [String]
789
799
  #
790
800
  # @!attribute [rw] creation_time
791
- # The date and time when the event source was created.
801
+ # The date and time the event source was created.
792
802
  # @return [Time]
793
803
  #
794
804
  # @!attribute [rw] expiration_time
795
- # The date and time when the event source will expire if the AWS
805
+ # The date and time that the event source will expire, if the AWS
796
806
  # account doesn't create a matching event bus for it.
797
807
  # @return [Time]
798
808
  #
@@ -801,12 +811,12 @@ module Aws::EventBridge
801
811
  # @return [String]
802
812
  #
803
813
  # @!attribute [rw] state
804
- # The state of the event source. If it's `ACTIVE`, you have already
814
+ # The state of the event source. If it is ACTIVE, you have already
805
815
  # created a matching event bus for this event source, and that event
806
- # bus is active. If it's `PENDING`, either you haven't yet created a
807
- # matching event bus, or that event bus is deactivated. If it's
808
- # `DELETED`, you have created a matching event bus, but the event
809
- # source has since been deleted.
816
+ # bus is active. If it is PENDING, either you haven't yet created a
817
+ # matching event bus, or that event bus is deactivated. If it is
818
+ # DELETED, you have created a matching event bus, but the event source
819
+ # has since been deleted.
810
820
  # @return [String]
811
821
  #
812
822
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EventSource AWS API Documentation
@@ -837,27 +847,27 @@ module Aws::EventBridge
837
847
  # @!attribute [rw] input_paths_map
838
848
  # Map of JSON paths to be extracted from the event. You can then
839
849
  # insert these in the template in `InputTemplate` to produce the
840
- # output to be sent to the target.
850
+ # output you want to be sent to the target.
841
851
  #
842
852
  # `InputPathsMap` is an array key-value pairs, where each value is a
843
853
  # valid JSON path. You can have as many as 10 key-value pairs. You
844
854
  # must use JSON dot notation, not bracket notation.
845
855
  #
846
- # The keys can't start with `"AWS"`.
856
+ # The keys cannot start with "AWS."
847
857
  # @return [Hash<String,String>]
848
858
  #
849
859
  # @!attribute [rw] input_template
850
860
  # Input template where you specify placeholders that will be filled
851
861
  # with the values of the keys from `InputPathsMap` to customize the
852
862
  # data sent to the target. Enclose each `InputPathsMaps` value in
853
- # brackets: &lt;*value*&gt;. The InputTemplate must be valid JSON.
863
+ # brackets: &lt;*value*&gt; The InputTemplate must be valid JSON.
854
864
  #
855
865
  # If `InputTemplate` is a JSON object (surrounded by curly braces),
856
866
  # the following restrictions apply:
857
867
  #
858
- # * The placeholder can't be used as an object key
868
+ # * The placeholder cannot be used as an object key.
859
869
  #
860
- # * Object values can't include quote marks
870
+ # * Object values cannot include quote marks.
861
871
  #
862
872
  # The following example shows the syntax for using `InputPathsMap` and
863
873
  # `InputTemplate`.
@@ -898,10 +908,10 @@ module Aws::EventBridge
898
908
  end
899
909
 
900
910
  # This object enables you to specify a JSON path to extract from the
901
- # event and use as the partition key for the Amazon Kinesis data stream
902
- # so that you can control the shard that the event goes to. If you
903
- # don't include this parameter, the default is to use the `eventId` as
904
- # the partition key.
911
+ # event and use as the partition key for the Amazon Kinesis data stream,
912
+ # so that you can control the shard to which the event goes. If you do
913
+ # not include this parameter, the default is to use the `eventId` as the
914
+ # partition key.
905
915
  #
906
916
  # @note When making an API call, you may pass KinesisParameters
907
917
  # data as a hash:
@@ -948,7 +958,7 @@ module Aws::EventBridge
948
958
  #
949
959
  # @!attribute [rw] limit
950
960
  # Specifying this limits the number of results returned by this
951
- # operation. The operation also returns a `NextToken` that you can use
961
+ # operation. The operation also returns a NextToken which you can use
952
962
  # in a subsequent operation to retrieve the next set of results.
953
963
  # @return [Integer]
954
964
  #
@@ -999,7 +1009,7 @@ module Aws::EventBridge
999
1009
  #
1000
1010
  # @!attribute [rw] limit
1001
1011
  # Specifying this limits the number of results returned by this
1002
- # operation. The operation also returns a `NextToken` that you can use
1012
+ # operation. The operation also returns a NextToken which you can use
1003
1013
  # in a subsequent operation to retrieve the next set of results.
1004
1014
  # @return [Integer]
1005
1015
  #
@@ -1050,7 +1060,7 @@ module Aws::EventBridge
1050
1060
  #
1051
1061
  # @!attribute [rw] limit
1052
1062
  # Specifying this limits the number of results returned by this
1053
- # operation. The operation also returns a `NextToken` that you can use
1063
+ # operation. The operation also returns a NextToken which you can use
1054
1064
  # in a subsequent operation to retrieve the next set of results.
1055
1065
  # @return [Integer]
1056
1066
  #
@@ -1101,7 +1111,7 @@ module Aws::EventBridge
1101
1111
  #
1102
1112
  # @!attribute [rw] limit
1103
1113
  # pecifying this limits the number of results returned by this
1104
- # operation. The operation also returns a `NextToken` that you can use
1114
+ # operation. The operation also returns a NextToken which you can use
1105
1115
  # in a subsequent operation to retrieve the next set of results.
1106
1116
  # @return [Integer]
1107
1117
  #
@@ -1249,7 +1259,7 @@ module Aws::EventBridge
1249
1259
  # }
1250
1260
  #
1251
1261
  # @!attribute [rw] resource_arn
1252
- # The ARN of the rule for which you want to view tags.
1262
+ # The ARN of the EventBridge resource for which you want to view tags.
1253
1263
  # @return [String]
1254
1264
  #
1255
1265
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListTagsForResourceRequest AWS API Documentation
@@ -1260,8 +1270,8 @@ module Aws::EventBridge
1260
1270
  end
1261
1271
 
1262
1272
  # @!attribute [rw] tags
1263
- # The list of tag keys and values associated with the rule that you
1264
- # specified.
1273
+ # The list of tag keys and values associated with the resource you
1274
+ # specified
1265
1275
  # @return [Array<Types::Tag>]
1266
1276
  #
1267
1277
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListTagsForResourceResponse AWS API Documentation
@@ -1341,7 +1351,7 @@ module Aws::EventBridge
1341
1351
  #
1342
1352
  # @!attribute [rw] awsvpc_configuration
1343
1353
  # Use this structure to specify the VPC subnets and security groups
1344
- # for the task and whether a public IP address is to be used. This
1354
+ # for the task, and whether a public IP address is to be used. This
1345
1355
  # structure is relevant only for ECS tasks that use the `awsvpc`
1346
1356
  # network mode.
1347
1357
  # @return [Types::AwsVpcConfiguration]
@@ -1381,21 +1391,21 @@ module Aws::EventBridge
1381
1391
  # @return [String]
1382
1392
  #
1383
1393
  # @!attribute [rw] creation_time
1384
- # The date and time when the event source was created.
1394
+ # The date and time the event source was created.
1385
1395
  # @return [Time]
1386
1396
  #
1387
1397
  # @!attribute [rw] expiration_time
1388
- # The date and time when the event source will expire if the AWS
1398
+ # The date and time that the event source will expire, if the AWS
1389
1399
  # account doesn't create a matching event bus for it.
1390
1400
  # @return [Time]
1391
1401
  #
1392
1402
  # @!attribute [rw] state
1393
- # The state of the event source. If it's `ACTIVE`, you have already
1403
+ # The state of the event source. If it is ACTIVE, you have already
1394
1404
  # created a matching event bus for this event source, and that event
1395
- # bus is active. If it's `PENDING`, either you haven't yet created a
1396
- # matching event bus, or that event bus is deactivated. If it's
1397
- # `DELETED`, you have created a matching event bus, but the event
1398
- # source has since been deleted.
1405
+ # bus is active. If it is PENDING, either you haven't yet created a
1406
+ # matching event bus, or that event bus is deactivated. If it is
1407
+ # DELETED, you have created a matching event bus, but the event source
1408
+ # has since been deleted.
1399
1409
  # @return [String]
1400
1410
  #
1401
1411
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PartnerEventSourceAccount AWS API Documentation
@@ -1452,8 +1462,8 @@ module Aws::EventBridge
1452
1462
  # }
1453
1463
  #
1454
1464
  # @!attribute [rw] time
1455
- # The timestamp of the event, per [RFC3339][1]. If no timestamp is
1456
- # provided, the timestamp of the PutEvents call is used.
1465
+ # The time stamp of the event, per [RFC3339][1]. If no time stamp is
1466
+ # provided, the time stamp of the PutEvents call is used.
1457
1467
  #
1458
1468
  #
1459
1469
  #
@@ -1461,30 +1471,28 @@ module Aws::EventBridge
1461
1471
  # @return [Time]
1462
1472
  #
1463
1473
  # @!attribute [rw] source
1464
- # The source of the event. This field is required.
1474
+ # The source of the event.
1465
1475
  # @return [String]
1466
1476
  #
1467
1477
  # @!attribute [rw] resources
1468
- # AWS resources, identified by Amazon Resource Name (ARN), that the
1469
- # event primarily concerns. Any number, including zero, can be
1478
+ # AWS resources, identified by Amazon Resource Name (ARN), which the
1479
+ # event primarily concerns. Any number, including zero, may be
1470
1480
  # present.
1471
1481
  # @return [Array<String>]
1472
1482
  #
1473
1483
  # @!attribute [rw] detail_type
1474
- # Free-form string used to decide which fields to expect in the event
1475
- # detail. This field is required.
1484
+ # Free-form string used to decide what fields to expect in the event
1485
+ # detail.
1476
1486
  # @return [String]
1477
1487
  #
1478
1488
  # @!attribute [rw] detail
1479
- # A valid JSON object. There is no other schema imposed. The JSON
1480
- # object can contain fields and nested subobjects.
1481
- #
1482
- # This field is required.
1489
+ # A valid JSON string. There is no other schema imposed. The JSON
1490
+ # string may contain fields and nested subobjects.
1483
1491
  # @return [String]
1484
1492
  #
1485
1493
  # @!attribute [rw] event_bus_name
1486
1494
  # The event bus that will receive the event. Only the rules that are
1487
- # associated with this event bus can match the event.
1495
+ # associated with this event bus will be able to match the event.
1488
1496
  # @return [String]
1489
1497
  #
1490
1498
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutEventsRequestEntry AWS API Documentation
@@ -1548,7 +1556,7 @@ module Aws::EventBridge
1548
1556
  # entries: [ # required
1549
1557
  # {
1550
1558
  # time: Time.now,
1551
- # source: "String",
1559
+ # source: "EventSourceName",
1552
1560
  # resources: ["EventResource"],
1553
1561
  # detail_type: "String",
1554
1562
  # detail: "String",
@@ -1574,7 +1582,7 @@ module Aws::EventBridge
1574
1582
  #
1575
1583
  # {
1576
1584
  # time: Time.now,
1577
- # source: "String",
1585
+ # source: "EventSourceName",
1578
1586
  # resources: ["EventResource"],
1579
1587
  # detail_type: "String",
1580
1588
  # detail: "String",
@@ -1585,25 +1593,23 @@ module Aws::EventBridge
1585
1593
  # @return [Time]
1586
1594
  #
1587
1595
  # @!attribute [rw] source
1588
- # The event source that is generating the evntry. This field is
1589
- # required.
1596
+ # The event source that is generating the evntry.
1590
1597
  # @return [String]
1591
1598
  #
1592
1599
  # @!attribute [rw] resources
1593
- # AWS resources, identified by Amazon Resource Name (ARN), that the
1594
- # event primarily concerns. Any number, including zero, can be
1600
+ # AWS resources, identified by Amazon Resource Name (ARN), which the
1601
+ # event primarily concerns. Any number, including zero, may be
1595
1602
  # present.
1596
1603
  # @return [Array<String>]
1597
1604
  #
1598
1605
  # @!attribute [rw] detail_type
1599
- # A free-form string used to decide which fields to expect in the
1600
- # event detail. This field is required.
1606
+ # A free-form string used to decide what fields to expect in the event
1607
+ # detail.
1601
1608
  # @return [String]
1602
1609
  #
1603
1610
  # @!attribute [rw] detail
1604
- # A valid JSON object. There is no other schema imposed. The JSON
1605
- # object can contain fields and nested subobjects. This field is
1606
- # required.
1611
+ # A valid JSON string. There is no other schema imposed. The JSON
1612
+ # string may contain fields and nested subobjects.
1607
1613
  # @return [String]
1608
1614
  #
1609
1615
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutPartnerEventsRequestEntry AWS API Documentation
@@ -1618,7 +1624,7 @@ module Aws::EventBridge
1618
1624
  end
1619
1625
 
1620
1626
  # @!attribute [rw] failed_entry_count
1621
- # The number of events from this operation that couldn't be written
1627
+ # The number of events from this operation that could not be written
1622
1628
  # to the partner event bus.
1623
1629
  # @return [Integer]
1624
1630
  #
@@ -1635,7 +1641,7 @@ module Aws::EventBridge
1635
1641
  include Aws::Structure
1636
1642
  end
1637
1643
 
1638
- # Represents an event that a partner tried to generate but failed.
1644
+ # Represents an event that a partner tried to generate, but failed.
1639
1645
  #
1640
1646
  # @!attribute [rw] event_id
1641
1647
  # The ID of the event.
@@ -1679,7 +1685,7 @@ module Aws::EventBridge
1679
1685
  # @return [String]
1680
1686
  #
1681
1687
  # @!attribute [rw] action
1682
- # The action that you're enabling the other account to perform.
1688
+ # The action that you are enabling the other account to perform.
1683
1689
  # Currently, this must be `events:PutEvents`.
1684
1690
  # @return [String]
1685
1691
  #
@@ -1689,15 +1695,15 @@ module Aws::EventBridge
1689
1695
  # events to your default event bus.
1690
1696
  #
1691
1697
  # If you specify "*" without specifying `Condition`, avoid creating
1692
- # rules that might match undesirable events. To create more secure
1698
+ # rules that may match undesirable events. To create more secure
1693
1699
  # rules, make sure that the event pattern for each rule contains an
1694
- # `account` field with a specific account ID to receive events from.
1695
- # Rules that have an account field match events sent only from
1696
- # accounts that are listed in the rule's `account` field.
1700
+ # `account` field with a specific account ID from which to receive
1701
+ # events. Rules with an account field do not match any events sent
1702
+ # from other accounts.
1697
1703
  # @return [String]
1698
1704
  #
1699
1705
  # @!attribute [rw] statement_id
1700
- # An identifier string for the external account that you're granting
1706
+ # An identifier string for the external account that you are granting
1701
1707
  # permissions to. If you later want to revoke the permission for this
1702
1708
  # external account, specify this `StatementId` when you run
1703
1709
  # RemovePermission.
@@ -1707,14 +1713,14 @@ module Aws::EventBridge
1707
1713
  # This parameter enables you to limit the permission to accounts that
1708
1714
  # fulfill a certain condition, such as being a member of a certain AWS
1709
1715
  # organization. For more information about AWS Organizations, see
1710
- # [What Is AWS Organizations?][1] in the *AWS Organizations User
1716
+ # [What Is AWS Organizations][1] in the *AWS Organizations User
1711
1717
  # Guide*.
1712
1718
  #
1713
- # If you specify `Condition` with an AWS organization ID and specify
1719
+ # If you specify `Condition` with an AWS organization ID, and specify
1714
1720
  # "*" as the value for `Principal`, you grant permission to all the
1715
1721
  # accounts in the named organization.
1716
1722
  #
1717
- # The `Condition` is a JSON string that must contain `Type`, `Key`,
1723
+ # The `Condition` is a JSON string which must contain `Type`, `Key`,
1718
1724
  # and `Value` fields.
1719
1725
  #
1720
1726
  #
@@ -1753,20 +1759,17 @@ module Aws::EventBridge
1753
1759
  # }
1754
1760
  #
1755
1761
  # @!attribute [rw] name
1756
- # The name of the rule that you're creating or updating.
1757
- #
1758
- # A rule can't have the same name as another rule in the same Region
1759
- # or on the same event bus.
1762
+ # The name of the rule that you are creating or updating.
1760
1763
  # @return [String]
1761
1764
  #
1762
1765
  # @!attribute [rw] schedule_expression
1763
- # The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
1764
- # `"rate(5 minutes)"`.
1766
+ # The scheduling expression. For example, "cron(0 20 * * ? *)" or
1767
+ # "rate(5 minutes)".
1765
1768
  # @return [String]
1766
1769
  #
1767
1770
  # @!attribute [rw] event_pattern
1768
- # The event pattern. For more information, see [Event Patterns][1] in
1769
- # the *Amazon EventBridge User Guide*.
1771
+ # The event pattern. For more information, see [Events and Event
1772
+ # Patterns][1] in the *Amazon EventBridge User Guide*.
1770
1773
  #
1771
1774
  #
1772
1775
  #
@@ -1993,9 +1996,9 @@ module Aws::EventBridge
1993
1996
  # @return [Array<String>]
1994
1997
  #
1995
1998
  # @!attribute [rw] force
1996
- # If this is a managed rule created by an AWS service on your behalf,
1999
+ # If this is a managed rule, created by an AWS service on your behalf,
1997
2000
  # you must specify `Force` as `True` to remove targets. This parameter
1998
- # is ignored for rules that aren't managed rules. You can check
2001
+ # is ignored for rules that are not managed rules. You can check
1999
2002
  # whether a rule is a managed rule by using `DescribeRule` or
2000
2003
  # `ListRules` and checking the `ManagedBy` field of the response.
2001
2004
  # @return [Boolean]
@@ -2062,8 +2065,8 @@ module Aws::EventBridge
2062
2065
  # @return [String]
2063
2066
  #
2064
2067
  # @!attribute [rw] event_pattern
2065
- # The event pattern of the rule. For more information, see [Event
2066
- # Patterns][1] in the *Amazon EventBridge User Guide*.
2068
+ # The event pattern of the rule. For more information, see [Events and
2069
+ # Event Patterns][1] in the *Amazon EventBridge User Guide*.
2067
2070
  #
2068
2071
  #
2069
2072
  #
@@ -2079,8 +2082,8 @@ module Aws::EventBridge
2079
2082
  # @return [String]
2080
2083
  #
2081
2084
  # @!attribute [rw] schedule_expression
2082
- # The scheduling expression: for example, `"cron(0 20 * * ? *)"` or
2083
- # `"rate(5 minutes)"`.
2085
+ # The scheduling expression. For example, "cron(0 20 * * ? *)",
2086
+ # "rate(5 minutes)".
2084
2087
  # @return [String]
2085
2088
  #
2086
2089
  # @!attribute [rw] role_arn
@@ -2089,9 +2092,9 @@ module Aws::EventBridge
2089
2092
  # @return [String]
2090
2093
  #
2091
2094
  # @!attribute [rw] managed_by
2092
- # If an AWS service created the rule on behalf of your account, this
2093
- # field displays the principal name of the service that created the
2094
- # rule.
2095
+ # If the rule was created on behalf of your account by an AWS service,
2096
+ # this field displays the principal name of the service that created
2097
+ # the rule.
2095
2098
  # @return [String]
2096
2099
  #
2097
2100
  # @!attribute [rw] event_bus_name
@@ -2113,7 +2116,7 @@ module Aws::EventBridge
2113
2116
  include Aws::Structure
2114
2117
  end
2115
2118
 
2116
- # This parameter contains the criteria (either `InstanceIds` or a tag)
2119
+ # This parameter contains the criteria (either InstanceIds or a tag)
2117
2120
  # used to specify which EC2 instances are to be sent the command.
2118
2121
  #
2119
2122
  # @note When making an API call, you may pass RunCommandParameters
@@ -2129,8 +2132,8 @@ module Aws::EventBridge
2129
2132
  # }
2130
2133
  #
2131
2134
  # @!attribute [rw] run_command_targets
2132
- # Currently, we support including only one `RunCommandTarget` block,
2133
- # which specifies either an array of `InstanceIds` or a tag.
2135
+ # Currently, we support including only one RunCommandTarget block,
2136
+ # which specifies either an array of InstanceIds or a tag.
2134
2137
  # @return [Array<Types::RunCommandTarget>]
2135
2138
  #
2136
2139
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RunCommandParameters AWS API Documentation
@@ -2142,7 +2145,7 @@ module Aws::EventBridge
2142
2145
 
2143
2146
  # Information about the EC2 instances that are to be sent the command,
2144
2147
  # specified as key-value pairs. Each `RunCommandTarget` block can
2145
- # include only one key, but this key can specify multiple values.
2148
+ # include only one key, but this key may specify multiple values.
2146
2149
  #
2147
2150
  # @note When making an API call, you may pass RunCommandTarget
2148
2151
  # data as a hash:
@@ -2192,7 +2195,7 @@ module Aws::EventBridge
2192
2195
  end
2193
2196
 
2194
2197
  # A key-value pair associated with an AWS resource. In EventBridge,
2195
- # rules support tagging.
2198
+ # rules and event buses support tagging.
2196
2199
  #
2197
2200
  # @note When making an API call, you may pass Tag
2198
2201
  # data as a hash:
@@ -2203,8 +2206,8 @@ module Aws::EventBridge
2203
2206
  # }
2204
2207
  #
2205
2208
  # @!attribute [rw] key
2206
- # A string that you can use to assign a value. The combination of tag
2207
- # keys and values can help you organize and categorize your resources.
2209
+ # A string you can use to assign a value. The combination of tag keys
2210
+ # and values can help you organize and categorize your resources.
2208
2211
  # @return [String]
2209
2212
  #
2210
2213
  # @!attribute [rw] value
@@ -2233,11 +2236,11 @@ module Aws::EventBridge
2233
2236
  # }
2234
2237
  #
2235
2238
  # @!attribute [rw] resource_arn
2236
- # The ARN of the rule that you're adding tags to.
2239
+ # The ARN of the EventBridge resource that you're adding tags to.
2237
2240
  # @return [String]
2238
2241
  #
2239
2242
  # @!attribute [rw] tags
2240
- # The list of key-value pairs to associate with the rule.
2243
+ # The list of key-value pairs to associate with the resource.
2241
2244
  # @return [Array<Types::Tag>]
2242
2245
  #
2243
2246
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/TagResourceRequest AWS API Documentation
@@ -2256,11 +2259,11 @@ module Aws::EventBridge
2256
2259
  # a complete list of services and resources that can be set as a target,
2257
2260
  # see PutTargets.
2258
2261
  #
2259
- # If you're setting the event bus of another account as the target and
2262
+ # If you are setting the event bus of another account as the target, and
2260
2263
  # that account granted permission to your account through an
2261
- # organization instead of directly by the account ID, you must specify a
2262
- # `RoleArn` with proper permissions in the `Target` structure. For more
2263
- # information, see [Sending and Receiving Events Between AWS
2264
+ # organization instead of directly by the account ID, then you must
2265
+ # specify a `RoleArn` with proper permissions in the `Target` structure.
2266
+ # For more information, see [Sending and Receiving Events Between AWS
2264
2267
  # Accounts][1] in the *Amazon EventBridge User Guide*.
2265
2268
  #
2266
2269
  #
@@ -2323,9 +2326,7 @@ module Aws::EventBridge
2323
2326
  # }
2324
2327
  #
2325
2328
  # @!attribute [rw] id
2326
- # A name for the target. Use a string that will help you identify the
2327
- # target. Each target associated with a rule must have an `Id` unique
2328
- # for that rule.
2329
+ # The ID of the target.
2329
2330
  # @return [String]
2330
2331
  #
2331
2332
  # @!attribute [rw] arn
@@ -2367,10 +2368,9 @@ module Aws::EventBridge
2367
2368
  # @return [Types::InputTransformer]
2368
2369
  #
2369
2370
  # @!attribute [rw] kinesis_parameters
2370
- # The custom parameter that you can use to control the shard
2371
- # assignment when the target is a Kinesis data stream. If you don't
2372
- # include this parameter, the default is to use the `eventId` as the
2373
- # partition key.
2371
+ # The custom parameter you can use to control the shard assignment,
2372
+ # when the target is a Kinesis data stream. If you do not include this
2373
+ # parameter, the default is to use the `eventId` as the partition key.
2374
2374
  # @return [Types::KinesisParameters]
2375
2375
  #
2376
2376
  # @!attribute [rw] run_command_parameters
@@ -2379,10 +2379,10 @@ module Aws::EventBridge
2379
2379
  # @return [Types::RunCommandParameters]
2380
2380
  #
2381
2381
  # @!attribute [rw] ecs_parameters
2382
- # Contains the Amazon ECS task definition and task count to be used if
2383
- # the event target is an Amazon ECS task. For more information about
2384
- # Amazon ECS tasks, see [Task Definitions ][1] in the *Amazon EC2
2385
- # Container Service Developer Guide*.
2382
+ # Contains the Amazon ECS task definition and task count to be used,
2383
+ # if the event target is an Amazon ECS task. For more information
2384
+ # about Amazon ECS tasks, see [Task Definitions ][1] in the *Amazon
2385
+ # EC2 Container Service Developer Guide*.
2386
2386
  #
2387
2387
  #
2388
2388
  #
@@ -2433,8 +2433,8 @@ module Aws::EventBridge
2433
2433
  # }
2434
2434
  #
2435
2435
  # @!attribute [rw] event_pattern
2436
- # The event pattern. For more information, see [Event Patterns][1] in
2437
- # the *Amazon EventBridge User Guide*.
2436
+ # The event pattern. For more information, see [Events and Event
2437
+ # Patterns][1] in the *Amazon EventBridge User Guide*.
2438
2438
  #
2439
2439
  #
2440
2440
  #
@@ -2473,7 +2473,8 @@ module Aws::EventBridge
2473
2473
  # }
2474
2474
  #
2475
2475
  # @!attribute [rw] resource_arn
2476
- # The ARN of the rule that you're removing tags from.
2476
+ # The ARN of the EventBridge resource from which you are removing
2477
+ # tags.
2477
2478
  # @return [String]
2478
2479
  #
2479
2480
  # @!attribute [rw] tag_keys