aws-sdk-eventbridge 1.27.0 → 1.31.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.
@@ -181,7 +181,7 @@ module Aws::EventBridge
181
181
  # The array properties for the submitted job, such as the size of the
182
182
  # array. The array size can be between 2 and 10,000. If you specify
183
183
  # array properties for a job, it becomes an array job. This parameter is
184
- # used only if the target is an AWS Batch job.
184
+ # used only if the target is an Batch job.
185
185
  #
186
186
  # @note When making an API call, you may pass BatchArrayProperties
187
187
  # data as a hash:
@@ -203,7 +203,7 @@ module Aws::EventBridge
203
203
  include Aws::Structure
204
204
  end
205
205
 
206
- # The custom parameters to be used when the target is an AWS Batch job.
206
+ # The custom parameters to be used when the target is an Batch job.
207
207
  #
208
208
  # @note When making an API call, you may pass BatchParameters
209
209
  # data as a hash:
@@ -221,27 +221,27 @@ module Aws::EventBridge
221
221
  #
222
222
  # @!attribute [rw] job_definition
223
223
  # The ARN or name of the job definition to use if the event target is
224
- # an AWS Batch job. This job definition must already exist.
224
+ # an Batch job. This job definition must already exist.
225
225
  # @return [String]
226
226
  #
227
227
  # @!attribute [rw] job_name
228
228
  # The name to use for this execution of the job, if the target is an
229
- # AWS Batch job.
229
+ # Batch job.
230
230
  # @return [String]
231
231
  #
232
232
  # @!attribute [rw] array_properties
233
233
  # The array properties for the submitted job, such as the size of the
234
234
  # array. The array size can be between 2 and 10,000. If you specify
235
235
  # array properties for a job, it becomes an array job. This parameter
236
- # is used only if the target is an AWS Batch job.
236
+ # is used only if the target is an Batch job.
237
237
  # @return [Types::BatchArrayProperties]
238
238
  #
239
239
  # @!attribute [rw] retry_strategy
240
- # The retry strategy to use for failed jobs, if the target is an AWS
241
- # Batch job. The retry strategy is the number of times to retry the
242
- # failed job execution. Valid values are 1–10. When you specify a
243
- # retry strategy here, it overrides the retry strategy defined in the
244
- # job definition.
240
+ # The retry strategy to use for failed jobs, if the target is an Batch
241
+ # job. The retry strategy is the number of times to retry the failed
242
+ # job execution. Valid values are 1–10. When you specify a retry
243
+ # strategy here, it overrides the retry strategy defined in the job
244
+ # definition.
245
245
  # @return [Types::BatchRetryStrategy]
246
246
  #
247
247
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/BatchParameters AWS API Documentation
@@ -255,9 +255,9 @@ module Aws::EventBridge
255
255
  include Aws::Structure
256
256
  end
257
257
 
258
- # The retry strategy to use for failed jobs, if the target is an AWS
259
- # Batch job. If you specify a retry strategy here, it overrides the
260
- # retry strategy defined in the job definition.
258
+ # The retry strategy to use for failed jobs, if the target is an Batch
259
+ # job. If you specify a retry strategy here, it overrides the retry
260
+ # strategy defined in the job definition.
261
261
  #
262
262
  # @note When making an API call, you may pass BatchRetryStrategy
263
263
  # data as a hash:
@@ -373,10 +373,10 @@ module Aws::EventBridge
373
373
 
374
374
  # A JSON string which you can use to limit the event bus permissions you
375
375
  # are granting to only accounts that fulfill the condition. Currently,
376
- # the only supported condition is membership in a certain AWS
377
- # organization. The string must contain `Type`, `Key`, and `Value`
378
- # fields. The `Value` field specifies the ID of the AWS organization.
379
- # Following is an example value for `Condition`\:
376
+ # the only supported condition is membership in a certain Amazon Web
377
+ # Services organization. The string must contain `Type`, `Key`, and
378
+ # `Value` fields. The `Value` field specifies the ID of the Amazon Web
379
+ # Services organization. Following is an example value for `Condition`\:
380
380
  #
381
381
  # `'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
382
382
  # "o-1234567890"\}'`
@@ -828,7 +828,7 @@ module Aws::EventBridge
828
828
  # @return [String]
829
829
  #
830
830
  # @!attribute [rw] event_source_arn
831
- # The ARN of the event source associated with the archive.
831
+ # The ARN of the event bus that sends events to the archive.
832
832
  # @return [String]
833
833
  #
834
834
  # @!attribute [rw] description
@@ -1332,14 +1332,14 @@ module Aws::EventBridge
1332
1332
  # @!attribute [rw] name
1333
1333
  # The name of the partner event source. This name must be unique and
1334
1334
  # must be in the format ` partner_name/event_namespace/event_name `.
1335
- # The AWS account that wants to use this partner event source must
1336
- # create a partner event bus with a name that matches the name of the
1337
- # partner event source.
1335
+ # The Amazon Web Services account that wants to use this partner event
1336
+ # source must create a partner event bus with a name that matches the
1337
+ # name of the partner event source.
1338
1338
  # @return [String]
1339
1339
  #
1340
1340
  # @!attribute [rw] account
1341
- # The AWS account ID that is permitted to create a matching partner
1342
- # event bus for this partner event source.
1341
+ # The Amazon Web Services account ID that is permitted to create a
1342
+ # matching partner event bus for this partner event source.
1343
1343
  # @return [String]
1344
1344
  #
1345
1345
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
@@ -1587,8 +1587,8 @@ module Aws::EventBridge
1587
1587
  # @return [String]
1588
1588
  #
1589
1589
  # @!attribute [rw] account
1590
- # The AWS account ID of the AWS customer that the event source was
1591
- # created for.
1590
+ # The Amazon Web Services account ID of the Amazon Web Services
1591
+ # customer that the event source was created for.
1592
1592
  # @return [String]
1593
1593
  #
1594
1594
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
@@ -1619,11 +1619,12 @@ module Aws::EventBridge
1619
1619
  # @return [String]
1620
1620
  #
1621
1621
  # @!attribute [rw] force
1622
- # If this is a managed rule, created by an AWS service on your behalf,
1623
- # you must specify `Force` as `True` to delete the rule. This
1624
- # parameter is ignored for rules that are not managed rules. You can
1625
- # check whether a rule is a managed rule by using `DescribeRule` or
1626
- # `ListRules` and checking the `ManagedBy` field of the response.
1622
+ # If this is a managed rule, created by an Amazon Web Services service
1623
+ # on your behalf, you must specify `Force` as `True` to delete the
1624
+ # rule. This parameter is ignored for rules that are not managed
1625
+ # rules. You can check whether a rule is a managed rule by using
1626
+ # `DescribeRule` or `ListRules` and checking the `ManagedBy` field of
1627
+ # the response.
1627
1628
  # @return [Boolean]
1628
1629
  #
1629
1630
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteRuleRequest AWS API Documentation
@@ -2176,9 +2177,9 @@ module Aws::EventBridge
2176
2177
  # @return [String]
2177
2178
  #
2178
2179
  # @!attribute [rw] managed_by
2179
- # If this is a managed rule, created by an AWS service on your behalf,
2180
- # this field displays the principal name of the AWS service that
2181
- # created the rule.
2180
+ # If this is a managed rule, created by an Amazon Web Services service
2181
+ # on your behalf, this field displays the principal name of the Amazon
2182
+ # Web Services service that created the rule.
2182
2183
  # @return [String]
2183
2184
  #
2184
2185
  # @!attribute [rw] event_bus_name
@@ -2246,7 +2247,7 @@ module Aws::EventBridge
2246
2247
  # {
2247
2248
  # task_definition_arn: "Arn", # required
2248
2249
  # task_count: 1,
2249
- # launch_type: "EC2", # accepts EC2, FARGATE
2250
+ # launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
2250
2251
  # network_configuration: {
2251
2252
  # awsvpc_configuration: {
2252
2253
  # subnets: ["String"], # required
@@ -2301,9 +2302,9 @@ module Aws::EventBridge
2301
2302
  # Specifies the launch type on which your task is running. The launch
2302
2303
  # type that you specify here must match one of the launch type
2303
2304
  # (compatibilities) of the target task. The `FARGATE` value is
2304
- # supported only in the Regions where AWS Fargate with Amazon ECS is
2305
- # supported. For more information, see [AWS Fargate on Amazon ECS][1]
2306
- # in the *Amazon Elastic Container Service Developer Guide*.
2305
+ # supported only in the Regions where Fargate witt Amazon ECS is
2306
+ # supported. For more information, see [Fargate on Amazon ECS][1] in
2307
+ # the *Amazon Elastic Container Service Developer Guide*.
2307
2308
  #
2308
2309
  #
2309
2310
  #
@@ -2311,8 +2312,8 @@ module Aws::EventBridge
2311
2312
  # @return [String]
2312
2313
  #
2313
2314
  # @!attribute [rw] network_configuration
2314
- # Use this structure if the ECS task uses the `awsvpc` network mode.
2315
- # This structure specifies the VPC subnets and security groups
2315
+ # Use this structure if the Amazon ECS task uses the `awsvpc` network
2316
+ # mode. This structure specifies the VPC subnets and security groups
2316
2317
  # associated with the task, and whether a public IP address is to be
2317
2318
  # used. This structure is required if `LaunchType` is `FARGATE`
2318
2319
  # because the `awsvpc` mode is required for Fargate tasks.
@@ -2326,7 +2327,7 @@ module Aws::EventBridge
2326
2327
  # numeric portion of the platform version, such as `1.1.0`.
2327
2328
  #
2328
2329
  # This structure is used only if `LaunchType` is `FARGATE`. For more
2329
- # information about valid platform versions, see [AWS Fargate Platform
2330
+ # information about valid platform versions, see [Fargate Platform
2330
2331
  # Versions][1] in the *Amazon Elastic Container Service Developer
2331
2332
  # Guide*.
2332
2333
  #
@@ -2447,10 +2448,11 @@ module Aws::EventBridge
2447
2448
 
2448
2449
  # An event bus receives events from a source and routes them to rules
2449
2450
  # associated with that event bus. Your account's default event bus
2450
- # receives events from AWS services. A custom event bus can receive
2451
- # events from your custom applications and services. A partner event bus
2452
- # receives events from an event source created by an SaaS partner. These
2453
- # events come from the partners services or applications.
2451
+ # receives events from Amazon Web Services services. A custom event bus
2452
+ # can receive events from your custom applications and services. A
2453
+ # partner event bus receives events from an event source created by an
2454
+ # SaaS partner. These events come from the partners services or
2455
+ # applications.
2454
2456
  #
2455
2457
  # @!attribute [rw] name
2456
2458
  # The name of the event bus.
@@ -2461,8 +2463,8 @@ module Aws::EventBridge
2461
2463
  # @return [String]
2462
2464
  #
2463
2465
  # @!attribute [rw] policy
2464
- # The permissions policy of the event bus, describing which other AWS
2465
- # accounts can write events to this event bus.
2466
+ # The permissions policy of the event bus, describing which other
2467
+ # Amazon Web Services accounts can write events to this event bus.
2466
2468
  # @return [String]
2467
2469
  #
2468
2470
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EventBus AWS API Documentation
@@ -2476,9 +2478,9 @@ module Aws::EventBridge
2476
2478
  end
2477
2479
 
2478
2480
  # A partner event source is created by an SaaS partner. If a customer
2479
- # creates a partner event bus that matches this event source, that AWS
2480
- # account can receive events from the partner's applications or
2481
- # services.
2481
+ # creates a partner event bus that matches this event source, that
2482
+ # Amazon Web Services account can receive events from the partner's
2483
+ # applications or services.
2482
2484
  #
2483
2485
  # @!attribute [rw] arn
2484
2486
  # The ARN of the event source.
@@ -2493,8 +2495,8 @@ module Aws::EventBridge
2493
2495
  # @return [Time]
2494
2496
  #
2495
2497
  # @!attribute [rw] expiration_time
2496
- # The date and time that the event source will expire, if the AWS
2497
- # account doesn't create a matching event bus for it.
2498
+ # The date and time that the event source will expire, if the Amazon
2499
+ # Web Services account doesn't create a matching event bus for it.
2498
2500
  # @return [Time]
2499
2501
  #
2500
2502
  # @!attribute [rw] name
@@ -2595,7 +2597,7 @@ module Aws::EventBridge
2595
2597
  # valid JSON path. You can have as many as 100 key-value pairs. You
2596
2598
  # must use JSON dot notation, not bracket notation.
2597
2599
  #
2598
- # The keys cannot start with "AWS."
2600
+ # The keys cannot start with "Amazon Web Services."
2599
2601
  # @return [Hash<String,String>]
2600
2602
  #
2601
2603
  # @!attribute [rw] input_template
@@ -3133,7 +3135,7 @@ module Aws::EventBridge
3133
3135
  # @return [String]
3134
3136
  #
3135
3137
  # @!attribute [rw] event_source_arn
3136
- # The ARN of the event source associated with the replay.
3138
+ # The ARN of the archive from which the events are replayed.
3137
3139
  # @return [String]
3138
3140
  #
3139
3141
  # @!attribute [rw] next_token
@@ -3379,11 +3381,11 @@ module Aws::EventBridge
3379
3381
  include Aws::Structure
3380
3382
  end
3381
3383
 
3382
- # This rule was created by an AWS service on behalf of your account. It
3383
- # is managed by that service. If you see this error in response to
3384
- # `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in
3385
- # those calls to delete the rule or remove targets from the rule. You
3386
- # cannot modify these managed rules by using `DisableRule`,
3384
+ # This rule was created by an Amazon Web Services service on behalf of
3385
+ # your account. It is managed by that service. If you see this error in
3386
+ # response to `DeleteRule` or `RemoveTargets`, you can use the `Force`
3387
+ # parameter in those calls to delete the rule or remove targets from the
3388
+ # rule. You cannot modify these managed rules by using `DisableRule`,
3387
3389
  # `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or
3388
3390
  # `UntagResource`.
3389
3391
  #
@@ -3426,9 +3428,9 @@ module Aws::EventBridge
3426
3428
  class OperationDisabledException < Aws::EmptyStructure; end
3427
3429
 
3428
3430
  # A partner event source is created by an SaaS partner. If a customer
3429
- # creates a partner event bus that matches this event source, that AWS
3430
- # account can receive events from the partner's applications or
3431
- # services.
3431
+ # creates a partner event bus that matches this event source, that
3432
+ # Amazon Web Services account can receive events from the partner's
3433
+ # applications or services.
3432
3434
  #
3433
3435
  # @!attribute [rw] arn
3434
3436
  # The ARN of the partner event source.
@@ -3447,10 +3449,12 @@ module Aws::EventBridge
3447
3449
  include Aws::Structure
3448
3450
  end
3449
3451
 
3450
- # The AWS account that a partner event source has been offered to.
3452
+ # The Amazon Web Services account that a partner event source has been
3453
+ # offered to.
3451
3454
  #
3452
3455
  # @!attribute [rw] account
3453
- # The AWS account ID that the partner event source was offered to.
3456
+ # The Amazon Web Services account ID that the partner event source was
3457
+ # offered to.
3454
3458
  # @return [String]
3455
3459
  #
3456
3460
  # @!attribute [rw] creation_time
@@ -3458,8 +3462,8 @@ module Aws::EventBridge
3458
3462
  # @return [Time]
3459
3463
  #
3460
3464
  # @!attribute [rw] expiration_time
3461
- # The date and time that the event source will expire, if the AWS
3462
- # account doesn't create a matching event bus for it.
3465
+ # The date and time that the event source will expire, if the Amazon
3466
+ # Web Services account doesn't create a matching event bus for it.
3463
3467
  # @return [Time]
3464
3468
  #
3465
3469
  # @!attribute [rw] state
@@ -3527,7 +3531,7 @@ module Aws::EventBridge
3527
3531
 
3528
3532
  # The task placement strategy for a task or service. To learn more, see
3529
3533
  # [Task Placement Strategies][1] in the Amazon Elastic Container Service
3530
- # Developer Guide.
3534
+ # Service Developer Guide.
3531
3535
  #
3532
3536
  #
3533
3537
  #
@@ -3626,11 +3630,12 @@ module Aws::EventBridge
3626
3630
  #
3627
3631
  # @!attribute [rw] time
3628
3632
  # The time stamp of the event, per [RFC3339][1]. If no time stamp is
3629
- # provided, the time stamp of the PutEvents call is used.
3633
+ # provided, the time stamp of the [PutEvents][2] call is used.
3630
3634
  #
3631
3635
  #
3632
3636
  #
3633
3637
  # [1]: https://www.rfc-editor.org/rfc/rfc3339.txt
3638
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html
3634
3639
  # @return [Time]
3635
3640
  #
3636
3641
  # @!attribute [rw] source
@@ -3638,9 +3643,9 @@ module Aws::EventBridge
3638
3643
  # @return [String]
3639
3644
  #
3640
3645
  # @!attribute [rw] resources
3641
- # AWS resources, identified by Amazon Resource Name (ARN), which the
3642
- # event primarily concerns. Any number, including zero, may be
3643
- # present.
3646
+ # Amazon Web Services resources, identified by Amazon Resource Name
3647
+ # (ARN), which the event primarily concerns. Any number, including
3648
+ # zero, may be present.
3644
3649
  # @return [Array<String>]
3645
3650
  #
3646
3651
  # @!attribute [rw] detail_type
@@ -3660,11 +3665,11 @@ module Aws::EventBridge
3660
3665
  # @return [String]
3661
3666
  #
3662
3667
  # @!attribute [rw] trace_header
3663
- # An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id)
3668
+ # An X-Ray trade header, which is an http header (X-Amzn-Trace-Id)
3664
3669
  # that contains the trace-id associated with the event.
3665
3670
  #
3666
3671
  # To learn more about X-Ray trace headers, see [Tracing header][1] in
3667
- # the AWS X-Ray Developer Guide.
3672
+ # the X-Ray Developer Guide.
3668
3673
  #
3669
3674
  #
3670
3675
  #
@@ -3774,13 +3779,13 @@ module Aws::EventBridge
3774
3779
  # @return [Time]
3775
3780
  #
3776
3781
  # @!attribute [rw] source
3777
- # The event source that is generating the evntry.
3782
+ # The event source that is generating the entry.
3778
3783
  # @return [String]
3779
3784
  #
3780
3785
  # @!attribute [rw] resources
3781
- # AWS resources, identified by Amazon Resource Name (ARN), which the
3782
- # event primarily concerns. Any number, including zero, may be
3783
- # present.
3786
+ # Amazon Web Services resources, identified by Amazon Resource Name
3787
+ # (ARN), which the event primarily concerns. Any number, including
3788
+ # zero, may be present.
3784
3789
  # @return [Array<String>]
3785
3790
  #
3786
3791
  # @!attribute [rw] detail_type
@@ -3871,13 +3876,12 @@ module Aws::EventBridge
3871
3876
  #
3872
3877
  # @!attribute [rw] action
3873
3878
  # The action that you are enabling the other account to perform.
3874
- # Currently, this must be `events:PutEvents`.
3875
3879
  # @return [String]
3876
3880
  #
3877
3881
  # @!attribute [rw] principal
3878
- # The 12-digit AWS account ID that you are permitting to put events to
3879
- # your default event bus. Specify "*" to permit any account to put
3880
- # events to your default event bus.
3882
+ # The 12-digit Amazon Web Services account ID that you are permitting
3883
+ # to put events to your default event bus. Specify "*" to permit
3884
+ # any account to put events to your default event bus.
3881
3885
  #
3882
3886
  # If you specify "*" without specifying `Condition`, avoid creating
3883
3887
  # rules that may match undesirable events. To create more secure
@@ -3891,19 +3895,24 @@ module Aws::EventBridge
3891
3895
  # An identifier string for the external account that you are granting
3892
3896
  # permissions to. If you later want to revoke the permission for this
3893
3897
  # external account, specify this `StatementId` when you run
3894
- # RemovePermission.
3898
+ # [RemovePermission][1].
3899
+ #
3900
+ #
3901
+ #
3902
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html
3895
3903
  # @return [String]
3896
3904
  #
3897
3905
  # @!attribute [rw] condition
3898
3906
  # This parameter enables you to limit the permission to accounts that
3899
- # fulfill a certain condition, such as being a member of a certain AWS
3900
- # organization. For more information about AWS Organizations, see
3901
- # [What Is AWS Organizations][1] in the *AWS Organizations User
3907
+ # fulfill a certain condition, such as being a member of a certain
3908
+ # Amazon Web Services organization. For more information about Amazon
3909
+ # Web Services Organizations, see [What Is Amazon Web Services
3910
+ # Organizations][1] in the *Amazon Web Services Organizations User
3902
3911
  # Guide*.
3903
3912
  #
3904
- # If you specify `Condition` with an AWS organization ID, and specify
3905
- # "*" as the value for `Principal`, you grant permission to all the
3906
- # accounts in the named organization.
3913
+ # If you specify `Condition` with an Amazon Web Services organization
3914
+ # ID, and specify "*" as the value for `Principal`, you grant
3915
+ # permission to all the accounts in the named organization.
3907
3916
  #
3908
3917
  # The `Condition` is a JSON string which must contain `Type`, `Key`,
3909
3918
  # and `Value` fields.
@@ -3980,6 +3989,12 @@ module Aws::EventBridge
3980
3989
  # @!attribute [rw] role_arn
3981
3990
  # The Amazon Resource Name (ARN) of the IAM role associated with the
3982
3991
  # rule.
3992
+ #
3993
+ # If you're setting an event bus in another account as the target and
3994
+ # that account granted permission to your account through an
3995
+ # organization instead of directly by the account ID, you must specify
3996
+ # a `RoleArn` with proper permissions in the `Target` structure,
3997
+ # instead of here in this parameter.
3983
3998
  # @return [String]
3984
3999
  #
3985
4000
  # @!attribute [rw] tags
@@ -4051,7 +4066,7 @@ module Aws::EventBridge
4051
4066
  # ecs_parameters: {
4052
4067
  # task_definition_arn: "Arn", # required
4053
4068
  # task_count: 1,
4054
- # launch_type: "EC2", # accepts EC2, FARGATE
4069
+ # launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
4055
4070
  # network_configuration: {
4056
4071
  # awsvpc_configuration: {
4057
4072
  # subnets: ["String"], # required
@@ -4206,9 +4221,9 @@ module Aws::EventBridge
4206
4221
  include Aws::Structure
4207
4222
  end
4208
4223
 
4209
- # These are custom parameters to be used when the target is a Redshift
4210
- # cluster to invoke the Redshift Data API ExecuteStatement based on
4211
- # EventBridge events.
4224
+ # These are custom parameters to be used when the target is a Amazon
4225
+ # Redshift cluster to invoke the Amazon Redshift Data API
4226
+ # ExecuteStatement based on EventBridge events.
4212
4227
  #
4213
4228
  # @note When making an API call, you may pass RedshiftDataParameters
4214
4229
  # data as a hash:
@@ -4224,7 +4239,8 @@ module Aws::EventBridge
4224
4239
  #
4225
4240
  # @!attribute [rw] secret_manager_arn
4226
4241
  # The name or ARN of the secret that enables access to the database.
4227
- # Required when authenticating using AWS Secrets Manager.
4242
+ # Required when authenticating using Amazon Web Services Secrets
4243
+ # Manager.
4228
4244
  # @return [String]
4229
4245
  #
4230
4246
  # @!attribute [rw] database
@@ -4321,11 +4337,12 @@ module Aws::EventBridge
4321
4337
  # @return [Array<String>]
4322
4338
  #
4323
4339
  # @!attribute [rw] force
4324
- # If this is a managed rule, created by an AWS service on your behalf,
4325
- # you must specify `Force` as `True` to remove targets. This parameter
4326
- # is ignored for rules that are not managed rules. You can check
4327
- # whether a rule is a managed rule by using `DescribeRule` or
4328
- # `ListRules` and checking the `ManagedBy` field of the response.
4340
+ # If this is a managed rule, created by an Amazon Web Services service
4341
+ # on your behalf, you must specify `Force` as `True` to remove
4342
+ # targets. This parameter is ignored for rules that are not managed
4343
+ # rules. You can check whether a rule is a managed rule by using
4344
+ # `DescribeRule` or `ListRules` and checking the `ManagedBy` field of
4345
+ # the response.
4329
4346
  # @return [Boolean]
4330
4347
  #
4331
4348
  # @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RemoveTargetsRequest AWS API Documentation
@@ -4543,18 +4560,29 @@ module Aws::EventBridge
4543
4560
  #
4544
4561
  # @!attribute [rw] schedule_expression
4545
4562
  # The scheduling expression. For example, "cron(0 20 * * ? *)",
4546
- # "rate(5 minutes)".
4563
+ # "rate(5 minutes)". For more information, see [Creating an Amazon
4564
+ # EventBridge rule that runs on a schedule][1].
4565
+ #
4566
+ #
4567
+ #
4568
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html
4547
4569
  # @return [String]
4548
4570
  #
4549
4571
  # @!attribute [rw] role_arn
4550
4572
  # The Amazon Resource Name (ARN) of the role that is used for target
4551
4573
  # invocation.
4574
+ #
4575
+ # If you're setting an event bus in another account as the target and
4576
+ # that account granted permission to your account through an
4577
+ # organization instead of directly by the account ID, you must specify
4578
+ # a `RoleArn` with proper permissions in the `Target` structure,
4579
+ # instead of here in this parameter.
4552
4580
  # @return [String]
4553
4581
  #
4554
4582
  # @!attribute [rw] managed_by
4555
- # If the rule was created on behalf of your account by an AWS service,
4556
- # this field displays the principal name of the service that created
4557
- # the rule.
4583
+ # If the rule was created on behalf of your account by an Amazon Web
4584
+ # Services service, this field displays the principal name of the
4585
+ # service that created the rule.
4558
4586
  # @return [String]
4559
4587
  #
4560
4588
  # @!attribute [rw] event_bus_name
@@ -4801,8 +4829,8 @@ module Aws::EventBridge
4801
4829
  include Aws::Structure
4802
4830
  end
4803
4831
 
4804
- # A key-value pair associated with an AWS resource. In EventBridge,
4805
- # rules and event buses support tagging.
4832
+ # A key-value pair associated with an Amazon Web Services resource. In
4833
+ # EventBridge, rules and event buses support tagging.
4806
4834
  #
4807
4835
  # @note When making an API call, you may pass Tag
4808
4836
  # data as a hash:
@@ -4866,18 +4894,19 @@ module Aws::EventBridge
4866
4894
 
4867
4895
  # Targets are the resources to be invoked when a rule is triggered. For
4868
4896
  # a complete list of services and resources that can be set as a target,
4869
- # see PutTargets.
4897
+ # see [PutTargets][1].
4870
4898
  #
4871
4899
  # If you are setting the event bus of another account as the target, and
4872
4900
  # that account granted permission to your account through an
4873
4901
  # organization instead of directly by the account ID, then you must
4874
4902
  # specify a `RoleArn` with proper permissions in the `Target` structure.
4875
- # For more information, see [Sending and Receiving Events Between AWS
4876
- # Accounts][1] in the *Amazon EventBridge User Guide*.
4903
+ # For more information, see [Sending and Receiving Events Between Amazon
4904
+ # Web Services Accounts][2] in the *Amazon EventBridge User Guide*.
4877
4905
  #
4878
4906
  #
4879
4907
  #
4880
- # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
4908
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html
4909
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
4881
4910
  #
4882
4911
  # @note When making an API call, you may pass Target
4883
4912
  # data as a hash:
@@ -4908,7 +4937,7 @@ module Aws::EventBridge
4908
4937
  # ecs_parameters: {
4909
4938
  # task_definition_arn: "Arn", # required
4910
4939
  # task_count: 1,
4911
- # launch_type: "EC2", # accepts EC2, FARGATE
4940
+ # launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
4912
4941
  # network_configuration: {
4913
4942
  # awsvpc_configuration: {
4914
4943
  # subnets: ["String"], # required
@@ -4996,7 +5025,8 @@ module Aws::EventBridge
4996
5025
  # }
4997
5026
  #
4998
5027
  # @!attribute [rw] id
4999
- # The ID of the target.
5028
+ # The ID of the target. We recommend using a memorable and unique
5029
+ # string.
5000
5030
  # @return [String]
5001
5031
  #
5002
5032
  # @!attribute [rw] arn
@@ -5060,9 +5090,9 @@ module Aws::EventBridge
5060
5090
  # @return [Types::EcsParameters]
5061
5091
  #
5062
5092
  # @!attribute [rw] batch_parameters
5063
- # If the event target is an AWS Batch job, this contains the job
5093
+ # If the event target is an Batch job, this contains the job
5064
5094
  # definition, job name, and other parameters. For more information,
5065
- # see [Jobs][1] in the *AWS Batch User Guide*.
5095
+ # see [Jobs][1] in the *Batch User Guide*.
5066
5096
  #
5067
5097
  #
5068
5098
  #
@@ -5091,12 +5121,12 @@ module Aws::EventBridge
5091
5121
  # @return [Types::HttpParameters]
5092
5122
  #
5093
5123
  # @!attribute [rw] redshift_data_parameters
5094
- # Contains the Redshift Data API parameters to use when the target is
5095
- # a Redshift cluster.
5124
+ # Contains the Amazon Redshift Data API parameters to use when the
5125
+ # target is a Amazon Redshift cluster.
5096
5126
  #
5097
- # If you specify a Redshift Cluster as a Target, you can use this to
5098
- # specify parameters to invoke the Redshift Data API ExecuteStatement
5099
- # based on EventBridge events.
5127
+ # If you specify a Amazon Redshift Cluster as a Target, you can use
5128
+ # this to specify parameters to invoke the Amazon Redshift Data API
5129
+ # ExecuteStatement based on EventBridge events.
5100
5130
  # @return [Types::RedshiftDataParameters]
5101
5131
  #
5102
5132
  # @!attribute [rw] sage_maker_pipeline_parameters
@@ -5160,8 +5190,8 @@ module Aws::EventBridge
5160
5190
  #
5161
5191
  # @!attribute [rw] event
5162
5192
  # The event, in JSON format, to test against the event pattern. The
5163
- # JSON must follow the format specified in [AWS Events][1], and the
5164
- # following fields are mandatory:
5193
+ # JSON must follow the format specified in [Amazon Web Services
5194
+ # Events][1], and the following fields are mandatory:
5165
5195
  #
5166
5196
  # * `id`
5167
5197
  #
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-eventbridge/customizations'
48
48
  # @!group service
49
49
  module Aws::EventBridge
50
50
 
51
- GEM_VERSION = '1.27.0'
51
+ GEM_VERSION = '1.31.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-eventbridge
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.27.0
4
+ version: 1.31.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-30 00:00:00.000000000 Z
11
+ date: 2021-10-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.119.0
22
+ version: 3.121.2
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.119.0
32
+ version: 3.121.2
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
76
76
  requirements:
77
77
  - - ">="
78
78
  - !ruby/object:Gem::Version
79
- version: '0'
79
+ version: '2.3'
80
80
  required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  requirements:
82
82
  - - ">="