aws-sdk 2.624.0 → 2.628.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.
Files changed (38) hide show
  1. package/CHANGELOG.md +24 -1
  2. package/README.md +1 -1
  3. package/apis/ec2-2016-11-15.min.json +1 -0
  4. package/apis/eventbridge-2015-10-07.min.json +8 -5
  5. package/apis/events-2015-10-07.min.json +8 -5
  6. package/apis/fsx-2018-03-01.min.json +28 -19
  7. package/apis/globalaccelerator-2018-08-08.min.json +235 -30
  8. package/apis/kafka-2018-11-14.min.json +118 -37
  9. package/apis/lightsail-2016-11-28.min.json +368 -110
  10. package/apis/outposts-2019-12-03.min.json +44 -0
  11. package/apis/sagemaker-2017-07-24.min.json +163 -147
  12. package/apis/securityhub-2018-10-26.min.json +19 -15
  13. package/apis/snowball-2016-06-30.min.json +36 -13
  14. package/apis/states-2016-11-23.min.json +3 -0
  15. package/apis/transcribe-2017-10-26.min.json +23 -2
  16. package/clients/cloudwatchevents.d.ts +115 -111
  17. package/clients/docdb.d.ts +5 -5
  18. package/clients/ec2.d.ts +7 -7
  19. package/clients/eventbridge.d.ts +117 -113
  20. package/clients/fsx.d.ts +30 -7
  21. package/clients/globalaccelerator.d.ts +240 -23
  22. package/clients/iotevents.d.ts +22 -22
  23. package/clients/kafka.d.ts +25 -0
  24. package/clients/lightsail.d.ts +492 -130
  25. package/clients/outposts.d.ts +26 -0
  26. package/clients/sagemaker.d.ts +47 -28
  27. package/clients/secretsmanager.d.ts +7 -1
  28. package/clients/securityhub.d.ts +31 -25
  29. package/clients/snowball.d.ts +32 -3
  30. package/clients/stepfunctions.d.ts +36 -38
  31. package/clients/transcribeservice.d.ts +33 -5
  32. package/dist/aws-sdk-core-react-native.js +1 -1
  33. package/dist/aws-sdk-react-native.js +15 -15
  34. package/dist/aws-sdk.js +13 -9
  35. package/dist/aws-sdk.min.js +45 -45
  36. package/lib/core.js +1 -1
  37. package/lib/s3/managed_upload.js +1 -1
  38. package/package.json +2 -2
@@ -12,59 +12,59 @@ declare class CloudWatchEvents extends Service {
12
12
  constructor(options?: CloudWatchEvents.Types.ClientConfiguration)
13
13
  config: Config & CloudWatchEvents.Types.ClientConfiguration;
14
14
  /**
15
- * Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source. This operation is performed by AWS customers, not by SaaS partners.
15
+ * Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
16
16
  */
17
17
  activateEventSource(params: CloudWatchEvents.Types.ActivateEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
18
18
  /**
19
- * Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source. This operation is performed by AWS customers, not by SaaS partners.
19
+ * Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
20
20
  */
21
21
  activateEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
22
22
  /**
23
- * Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your own custom applications and services, or it can be a partner event bus which can be matched to a partner event source. This operation is used by AWS customers, not by SaaS partners.
23
+ * Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.
24
24
  */
25
25
  createEventBus(params: CloudWatchEvents.Types.CreateEventBusRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.CreateEventBusResponse) => void): Request<CloudWatchEvents.Types.CreateEventBusResponse, AWSError>;
26
26
  /**
27
- * Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your own custom applications and services, or it can be a partner event bus which can be matched to a partner event source. This operation is used by AWS customers, not by SaaS partners.
27
+ * Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.
28
28
  */
29
29
  createEventBus(callback?: (err: AWSError, data: CloudWatchEvents.Types.CreateEventBusResponse) => void): Request<CloudWatchEvents.Types.CreateEventBusResponse, AWSError>;
30
30
  /**
31
- * Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers. Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types. A partner event source creates events based on resources in the SaaS partner's service or application. An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets. Partner event source names follow this format: aws.partner/partner_name/event_namespace/event_name partner_name is determined during partner registration and identifies the partner to AWS customers. For event_namespace, we recommend that partners use a string that identifies the AWS customer within the partner's system. This should not be the customer's AWS account ID. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. This should help AWS customers decide whether to create an event bus to receive these events.
31
+ * Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers. Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types. A partner event source creates events based on resources within the SaaS partner's service or application. An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets. Partner event source names follow this format: partner_name/event_namespace/event_name partner_name is determined during partner registration and identifies the partner to AWS customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help AWS customers decide whether to create an event bus to receive these events.
32
32
  */
33
33
  createPartnerEventSource(params: CloudWatchEvents.Types.CreatePartnerEventSourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.CreatePartnerEventSourceResponse) => void): Request<CloudWatchEvents.Types.CreatePartnerEventSourceResponse, AWSError>;
34
34
  /**
35
- * Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers. Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types. A partner event source creates events based on resources in the SaaS partner's service or application. An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets. Partner event source names follow this format: aws.partner/partner_name/event_namespace/event_name partner_name is determined during partner registration and identifies the partner to AWS customers. For event_namespace, we recommend that partners use a string that identifies the AWS customer within the partner's system. This should not be the customer's AWS account ID. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. This should help AWS customers decide whether to create an event bus to receive these events.
35
+ * Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers. Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types. A partner event source creates events based on resources within the SaaS partner's service or application. An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets. Partner event source names follow this format: partner_name/event_namespace/event_name partner_name is determined during partner registration and identifies the partner to AWS customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help AWS customers decide whether to create an event bus to receive these events.
36
36
  */
37
37
  createPartnerEventSource(callback?: (err: AWSError, data: CloudWatchEvents.Types.CreatePartnerEventSourceResponse) => void): Request<CloudWatchEvents.Types.CreatePartnerEventSourceResponse, AWSError>;
38
38
  /**
39
- * An AWS customer uses this operation to temporarily stop receiving events from the specified partner event source. The matching event bus isn't deleted. When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it's deleted. To activate a deactivated partner event source, use ActivateEventSource.
39
+ * You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted. To activate a deactivated partner event source, use ActivateEventSource.
40
40
  */
41
41
  deactivateEventSource(params: CloudWatchEvents.Types.DeactivateEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
42
42
  /**
43
- * An AWS customer uses this operation to temporarily stop receiving events from the specified partner event source. The matching event bus isn't deleted. When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it's deleted. To activate a deactivated partner event source, use ActivateEventSource.
43
+ * You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted. To activate a deactivated partner event source, use ActivateEventSource.
44
44
  */
45
45
  deactivateEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
46
46
  /**
47
- * Deletes the specified custom event bus or partner event bus. All rules associated with this event bus are also deleted. You can't delete your account's default event bus. This operation is performed by AWS customers, not by SaaS partners.
47
+ * Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.
48
48
  */
49
49
  deleteEventBus(params: CloudWatchEvents.Types.DeleteEventBusRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
50
50
  /**
51
- * Deletes the specified custom event bus or partner event bus. All rules associated with this event bus are also deleted. You can't delete your account's default event bus. This operation is performed by AWS customers, not by SaaS partners.
51
+ * Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.
52
52
  */
53
53
  deleteEventBus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
54
54
  /**
55
- * This operation is used by SaaS partners to delete a partner event source. AWS customers don't use this operation. When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.
55
+ * This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers. When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.
56
56
  */
57
57
  deletePartnerEventSource(params: CloudWatchEvents.Types.DeletePartnerEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
58
58
  /**
59
- * This operation is used by SaaS partners to delete a partner event source. AWS customers don't use this operation. When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.
59
+ * This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers. When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.
60
60
  */
61
61
  deletePartnerEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
62
62
  /**
63
- * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you're sure that the other service isn't still using that rule.
63
+ * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.
64
64
  */
65
65
  deleteRule(params: CloudWatchEvents.Types.DeleteRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
66
66
  /**
67
- * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you're sure that the other service isn't still using that rule.
67
+ * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.
68
68
  */
69
69
  deleteRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
70
70
  /**
@@ -76,99 +76,99 @@ declare class CloudWatchEvents extends Service {
76
76
  */
77
77
  describeEventBus(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeEventBusResponse) => void): Request<CloudWatchEvents.Types.DescribeEventBusResponse, AWSError>;
78
78
  /**
79
- * This operation lists details about a partner event source that is shared with your account. This operation is run by AWS customers, not by SaaS partners.
79
+ * This operation lists details about a partner event source that is shared with your account.
80
80
  */
81
81
  describeEventSource(params: CloudWatchEvents.Types.DescribeEventSourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeEventSourceResponse) => void): Request<CloudWatchEvents.Types.DescribeEventSourceResponse, AWSError>;
82
82
  /**
83
- * This operation lists details about a partner event source that is shared with your account. This operation is run by AWS customers, not by SaaS partners.
83
+ * This operation lists details about a partner event source that is shared with your account.
84
84
  */
85
85
  describeEventSource(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeEventSourceResponse) => void): Request<CloudWatchEvents.Types.DescribeEventSourceResponse, AWSError>;
86
86
  /**
87
- * An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.
87
+ * An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.
88
88
  */
89
89
  describePartnerEventSource(params: CloudWatchEvents.Types.DescribePartnerEventSourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribePartnerEventSourceResponse) => void): Request<CloudWatchEvents.Types.DescribePartnerEventSourceResponse, AWSError>;
90
90
  /**
91
- * An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.
91
+ * An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.
92
92
  */
93
93
  describePartnerEventSource(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribePartnerEventSourceResponse) => void): Request<CloudWatchEvents.Types.DescribePartnerEventSourceResponse, AWSError>;
94
94
  /**
95
- * Describes the specified rule. DescribeRule doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
95
+ * Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
96
96
  */
97
97
  describeRule(params: CloudWatchEvents.Types.DescribeRuleRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeRuleResponse) => void): Request<CloudWatchEvents.Types.DescribeRuleResponse, AWSError>;
98
98
  /**
99
- * Describes the specified rule. DescribeRule doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
99
+ * Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
100
100
  */
101
101
  describeRule(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeRuleResponse) => void): Request<CloudWatchEvents.Types.DescribeRuleResponse, AWSError>;
102
102
  /**
103
- * Disables the specified rule. A disabled rule won't match any events and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.
103
+ * Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.
104
104
  */
105
105
  disableRule(params: CloudWatchEvents.Types.DisableRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
106
106
  /**
107
- * Disables the specified rule. A disabled rule won't match any events and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.
107
+ * Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.
108
108
  */
109
109
  disableRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
110
110
  /**
111
- * Enables the specified rule. If the rule doesn't exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.
111
+ * Enables the specified rule. If the rule does not exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.
112
112
  */
113
113
  enableRule(params: CloudWatchEvents.Types.EnableRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
114
114
  /**
115
- * Enables the specified rule. If the rule doesn't exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.
115
+ * Enables the specified rule. If the rule does not exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.
116
116
  */
117
117
  enableRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
118
118
  /**
119
- * Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses. This operation is run by AWS customers, not by SaaS partners.
119
+ * Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
120
120
  */
121
121
  listEventBuses(params: CloudWatchEvents.Types.ListEventBusesRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListEventBusesResponse) => void): Request<CloudWatchEvents.Types.ListEventBusesResponse, AWSError>;
122
122
  /**
123
- * Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses. This operation is run by AWS customers, not by SaaS partners.
123
+ * Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
124
124
  */
125
125
  listEventBuses(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListEventBusesResponse) => void): Request<CloudWatchEvents.Types.ListEventBusesResponse, AWSError>;
126
126
  /**
127
- * You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus. This operation is run by AWS customers, not by SaaS partners.
127
+ * You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.
128
128
  */
129
129
  listEventSources(params: CloudWatchEvents.Types.ListEventSourcesRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListEventSourcesResponse) => void): Request<CloudWatchEvents.Types.ListEventSourcesResponse, AWSError>;
130
130
  /**
131
- * You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus. This operation is run by AWS customers, not by SaaS partners.
131
+ * You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.
132
132
  */
133
133
  listEventSources(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListEventSourcesResponse) => void): Request<CloudWatchEvents.Types.ListEventSourcesResponse, AWSError>;
134
134
  /**
135
- * An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is used by SaaS partners, not by AWS customers.
135
+ * An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is not used by AWS customers.
136
136
  */
137
137
  listPartnerEventSourceAccounts(params: CloudWatchEvents.Types.ListPartnerEventSourceAccountsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListPartnerEventSourceAccountsResponse) => void): Request<CloudWatchEvents.Types.ListPartnerEventSourceAccountsResponse, AWSError>;
138
138
  /**
139
- * An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is used by SaaS partners, not by AWS customers.
139
+ * An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is not used by AWS customers.
140
140
  */
141
141
  listPartnerEventSourceAccounts(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListPartnerEventSourceAccountsResponse) => void): Request<CloudWatchEvents.Types.ListPartnerEventSourceAccountsResponse, AWSError>;
142
142
  /**
143
- * An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by AWS customers.
143
+ * An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by AWS customers.
144
144
  */
145
145
  listPartnerEventSources(params: CloudWatchEvents.Types.ListPartnerEventSourcesRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListPartnerEventSourcesResponse) => void): Request<CloudWatchEvents.Types.ListPartnerEventSourcesResponse, AWSError>;
146
146
  /**
147
- * An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by AWS customers.
147
+ * An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by AWS customers.
148
148
  */
149
149
  listPartnerEventSources(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListPartnerEventSourcesResponse) => void): Request<CloudWatchEvents.Types.ListPartnerEventSourcesResponse, AWSError>;
150
150
  /**
151
- * Lists the rules for the specified target. You can see which rules can invoke a specific target in your account.
151
+ * Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.
152
152
  */
153
153
  listRuleNamesByTarget(params: CloudWatchEvents.Types.ListRuleNamesByTargetRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListRuleNamesByTargetResponse) => void): Request<CloudWatchEvents.Types.ListRuleNamesByTargetResponse, AWSError>;
154
154
  /**
155
- * Lists the rules for the specified target. You can see which rules can invoke a specific target in your account.
155
+ * Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.
156
156
  */
157
157
  listRuleNamesByTarget(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListRuleNamesByTargetResponse) => void): Request<CloudWatchEvents.Types.ListRuleNamesByTargetResponse, AWSError>;
158
158
  /**
159
- * Lists your EventBridge rules. You can either list all the rules or provide a prefix to match to the rule names. ListRules doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
159
+ * Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
160
160
  */
161
161
  listRules(params: CloudWatchEvents.Types.ListRulesRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListRulesResponse) => void): Request<CloudWatchEvents.Types.ListRulesResponse, AWSError>;
162
162
  /**
163
- * Lists your EventBridge rules. You can either list all the rules or provide a prefix to match to the rule names. ListRules doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
163
+ * Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
164
164
  */
165
165
  listRules(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListRulesResponse) => void): Request<CloudWatchEvents.Types.ListRulesResponse, AWSError>;
166
166
  /**
167
- * Displays the tags associated with an EventBridge resource. In EventBridge, rules can be tagged.
167
+ * Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
168
168
  */
169
169
  listTagsForResource(params: CloudWatchEvents.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListTagsForResourceResponse) => void): Request<CloudWatchEvents.Types.ListTagsForResourceResponse, AWSError>;
170
170
  /**
171
- * Displays the tags associated with an EventBridge resource. In EventBridge, rules can be tagged.
171
+ * Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
172
172
  */
173
173
  listTagsForResource(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListTagsForResourceResponse) => void): Request<CloudWatchEvents.Types.ListTagsForResourceResponse, AWSError>;
174
174
  /**
@@ -180,43 +180,43 @@ declare class CloudWatchEvents extends Service {
180
180
  */
181
181
  listTargetsByRule(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListTargetsByRuleResponse) => void): Request<CloudWatchEvents.Types.ListTargetsByRuleResponse, AWSError>;
182
182
  /**
183
- * Sends custom events to EventBridge so that they can be matched to rules. These events can be from your custom applications and services.
183
+ * Sends custom events to Amazon EventBridge so that they can be matched to rules.
184
184
  */
185
185
  putEvents(params: CloudWatchEvents.Types.PutEventsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutEventsResponse) => void): Request<CloudWatchEvents.Types.PutEventsResponse, AWSError>;
186
186
  /**
187
- * Sends custom events to EventBridge so that they can be matched to rules. These events can be from your custom applications and services.
187
+ * Sends custom events to Amazon EventBridge so that they can be matched to rules.
188
188
  */
189
189
  putEvents(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutEventsResponse) => void): Request<CloudWatchEvents.Types.PutEventsResponse, AWSError>;
190
190
  /**
191
- * This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation. Instead, AWS customers can use PutEvents to write custom events from their own applications to an event bus.
191
+ * This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.
192
192
  */
193
193
  putPartnerEvents(params: CloudWatchEvents.Types.PutPartnerEventsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutPartnerEventsResponse) => void): Request<CloudWatchEvents.Types.PutPartnerEventsResponse, AWSError>;
194
194
  /**
195
- * This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation. Instead, AWS customers can use PutEvents to write custom events from their own applications to an event bus.
195
+ * This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.
196
196
  */
197
197
  putPartnerEvents(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutPartnerEventsResponse) => void): Request<CloudWatchEvents.Types.PutPartnerEventsResponse, AWSError>;
198
198
  /**
199
- * Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Rules in your account are triggered by these events arriving to an event bus in your account. For another account to send events to your account, that external account must have a rule with your account's event bus as a target. To enable multiple AWS accounts to put events to an event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide. The permission policy on an event bus can't exceed 10 KB in size.
199
+ * Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. CloudWatch Events rules in your account are triggered by these events arriving to an event bus in your account. For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target. To enable multiple AWS accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide. The permission policy on the default event bus cannot exceed 10 KB in size.
200
200
  */
201
201
  putPermission(params: CloudWatchEvents.Types.PutPermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
202
202
  /**
203
- * Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Rules in your account are triggered by these events arriving to an event bus in your account. For another account to send events to your account, that external account must have a rule with your account's event bus as a target. To enable multiple AWS accounts to put events to an event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide. The permission policy on an event bus can't exceed 10 KB in size.
203
+ * Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. CloudWatch Events rules in your account are triggered by these events arriving to an event bus in your account. For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target. To enable multiple AWS accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide. The permission policy on the default event bus cannot exceed 10 KB in size.
204
204
  */
205
205
  putPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
206
206
  /**
207
- * Creates or updates the specified rule. Rules are enabled by default or based on value of the state. You can disable a rule using DisableRule. A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus. If you're updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments aren't kept. Instead, they're replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event that you want to match. In EventBridge, you could create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If you don't write the rule carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions don't refire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
207
+ * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule. A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus. If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
208
208
  */
209
209
  putRule(params: CloudWatchEvents.Types.PutRuleRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutRuleResponse) => void): Request<CloudWatchEvents.Types.PutRuleResponse, AWSError>;
210
210
  /**
211
- * Creates or updates the specified rule. Rules are enabled by default or based on value of the state. You can disable a rule using DisableRule. A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus. If you're updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments aren't kept. Instead, they're replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event that you want to match. In EventBridge, you could create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If you don't write the rule carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions don't refire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
211
+ * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule. A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus. If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
212
212
  */
213
213
  putRule(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutRuleResponse) => void): Request<CloudWatchEvents.Types.PutRuleResponse, AWSError>;
214
214
  /**
215
- * Adds the specified targets to the specified rule, or updates the targets if they're already associated with the rule. Targets are the resources that are invoked when a rule is triggered. You can configure the following as targets in EventBridge: EC2 instances SSM Run Command SSM Automation AWS Lambda functions Data streams in Amazon Kinesis Data Streams Data delivery streams in Amazon Kinesis Data Firehose Amazon ECS tasks AWS Step Functions state machines AWS Batch jobs AWS CodeBuild projects Pipelines in AWS CodePipeline Amazon Inspector assessment templates Amazon SNS topics Amazon SQS queues, including FIFO queues The default event bus of another AWS account Creating rules with built-in targets is supported only on the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide. If another AWS account is in the same Region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event isn't charged. For more information, see Amazon EventBridge Pricing. If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). If InputTransformer is specified, one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is nonzero in the response, and each entry in FailedEntries provides the ID of the failed target and the error code.
215
+ * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered. You can configure the following as targets for Events: EC2 instances SSM Run Command SSM Automation AWS Lambda functions Data streams in Amazon Kinesis Data Streams Data delivery streams in Amazon Kinesis Data Firehose Amazon ECS tasks AWS Step Functions state machines AWS Batch jobs AWS CodeBuild projects Pipelines in AWS CodePipeline Amazon Inspector assessment templates Amazon SNS topics Amazon SQS queues, including FIFO queues The default event bus of another AWS account Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide. If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon CloudWatch Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account. If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
216
216
  */
217
217
  putTargets(params: CloudWatchEvents.Types.PutTargetsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutTargetsResponse) => void): Request<CloudWatchEvents.Types.PutTargetsResponse, AWSError>;
218
218
  /**
219
- * Adds the specified targets to the specified rule, or updates the targets if they're already associated with the rule. Targets are the resources that are invoked when a rule is triggered. You can configure the following as targets in EventBridge: EC2 instances SSM Run Command SSM Automation AWS Lambda functions Data streams in Amazon Kinesis Data Streams Data delivery streams in Amazon Kinesis Data Firehose Amazon ECS tasks AWS Step Functions state machines AWS Batch jobs AWS CodeBuild projects Pipelines in AWS CodePipeline Amazon Inspector assessment templates Amazon SNS topics Amazon SQS queues, including FIFO queues The default event bus of another AWS account Creating rules with built-in targets is supported only on the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide. If another AWS account is in the same Region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event isn't charged. For more information, see Amazon EventBridge Pricing. If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). If InputTransformer is specified, one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is nonzero in the response, and each entry in FailedEntries provides the ID of the failed target and the error code.
219
+ * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered. You can configure the following as targets for Events: EC2 instances SSM Run Command SSM Automation AWS Lambda functions Data streams in Amazon Kinesis Data Streams Data delivery streams in Amazon Kinesis Data Firehose Amazon ECS tasks AWS Step Functions state machines AWS Batch jobs AWS CodeBuild projects Pipelines in AWS CodePipeline Amazon Inspector assessment templates Amazon SNS topics Amazon SQS queues, including FIFO queues The default event bus of another AWS account Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide. If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon CloudWatch Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account. If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
220
220
  */
221
221
  putTargets(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutTargetsResponse) => void): Request<CloudWatchEvents.Types.PutTargetsResponse, AWSError>;
222
222
  /**
@@ -236,27 +236,27 @@ declare class CloudWatchEvents extends Service {
236
236
  */
237
237
  removeTargets(callback?: (err: AWSError, data: CloudWatchEvents.Types.RemoveTargetsResponse) => void): Request<CloudWatchEvents.Types.RemoveTargetsResponse, AWSError>;
238
238
  /**
239
- * Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a rule that already has tags. If you specify a new tag key for the rule, this tag is appended to the list of tags associated with the rule. If you specify a tag key that is already associated with the rule, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource.
239
+ * Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource.
240
240
  */
241
241
  tagResource(params: CloudWatchEvents.Types.TagResourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.TagResourceResponse) => void): Request<CloudWatchEvents.Types.TagResourceResponse, AWSError>;
242
242
  /**
243
- * Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a rule that already has tags. If you specify a new tag key for the rule, this tag is appended to the list of tags associated with the rule. If you specify a tag key that is already associated with the rule, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource.
243
+ * Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource.
244
244
  */
245
245
  tagResource(callback?: (err: AWSError, data: CloudWatchEvents.Types.TagResourceResponse) => void): Request<CloudWatchEvents.Types.TagResourceResponse, AWSError>;
246
246
  /**
247
- * Tests whether the specified event pattern matches the provided event. Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event that you want to match.
247
+ * Tests whether the specified event pattern matches the provided event. Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
248
248
  */
249
249
  testEventPattern(params: CloudWatchEvents.Types.TestEventPatternRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.TestEventPatternResponse) => void): Request<CloudWatchEvents.Types.TestEventPatternResponse, AWSError>;
250
250
  /**
251
- * Tests whether the specified event pattern matches the provided event. Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event that you want to match.
251
+ * Tests whether the specified event pattern matches the provided event. Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
252
252
  */
253
253
  testEventPattern(callback?: (err: AWSError, data: CloudWatchEvents.Types.TestEventPatternResponse) => void): Request<CloudWatchEvents.Types.TestEventPatternResponse, AWSError>;
254
254
  /**
255
- * Removes one or more tags from the specified EventBridge resource. In EventBridge, rules can be tagged.
255
+ * Removes one or more tags from the specified EventBridge resource. In CloudWatch Events, rules and event buses can be tagged.
256
256
  */
257
257
  untagResource(params: CloudWatchEvents.Types.UntagResourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.UntagResourceResponse) => void): Request<CloudWatchEvents.Types.UntagResourceResponse, AWSError>;
258
258
  /**
259
- * Removes one or more tags from the specified EventBridge resource. In EventBridge, rules can be tagged.
259
+ * Removes one or more tags from the specified EventBridge resource. In CloudWatch Events, rules and event buses can be tagged.
260
260
  */
261
261
  untagResource(callback?: (err: AWSError, data: CloudWatchEvents.Types.UntagResourceResponse) => void): Request<CloudWatchEvents.Types.UntagResourceResponse, AWSError>;
262
262
  }
@@ -277,7 +277,7 @@ declare namespace CloudWatchEvents {
277
277
  */
278
278
  Subnets: StringList;
279
279
  /**
280
- * Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you don't specify a security group, the default security group for the VPC is used.
280
+ * Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
281
281
  */
282
282
  SecurityGroups?: StringList;
283
283
  /**
@@ -305,7 +305,7 @@ declare namespace CloudWatchEvents {
305
305
  */
306
306
  ArrayProperties?: BatchArrayProperties;
307
307
  /**
308
- * The retry strategy to use for failed jobs if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
308
+ * The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
309
309
  */
310
310
  RetryStrategy?: BatchRetryStrategy;
311
311
  }
@@ -318,27 +318,31 @@ declare namespace CloudWatchEvents {
318
318
  export type Boolean = boolean;
319
319
  export interface Condition {
320
320
  /**
321
- * The type of condition. Currently, the only supported value is StringEquals.
321
+ * Specifies the type of condition. Currently the only supported value is StringEquals.
322
322
  */
323
323
  Type: String;
324
324
  /**
325
- * The key for the condition. Currently, the only supported key is aws:PrincipalOrgID.
325
+ * Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID.
326
326
  */
327
327
  Key: String;
328
328
  /**
329
- * The value for the key. Currently, this must be the ID of the organization.
329
+ * Specifies the value for the key. Currently, this must be the ID of the organization.
330
330
  */
331
331
  Value: String;
332
332
  }
333
333
  export interface CreateEventBusRequest {
334
334
  /**
335
- * The name of the new event bus. The names of custom event buses can't contain the / character. You can't use the name default for a custom event bus because this name is already used for your account's default event bus. If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to. This name will include the / character.
335
+ * The name of the new event bus. Event bus names cannot contain the / character. You can't use the name default for a custom event bus, as this name is already used for your account's default event bus. If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.
336
336
  */
337
337
  Name: EventBusName;
338
338
  /**
339
- * If you're creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
339
+ * If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
340
340
  */
341
341
  EventSourceName?: EventSourceName;
342
+ /**
343
+ * Tags to associate with the event bus.
344
+ */
345
+ Tags?: TagList;
342
346
  }
343
347
  export interface CreateEventBusResponse {
344
348
  /**
@@ -352,7 +356,7 @@ declare namespace CloudWatchEvents {
352
356
  */
353
357
  Name: EventSourceName;
354
358
  /**
355
- * The AWS account ID of the customer who is permitted to create a matching partner event bus for this partner event source.
359
+ * The AWS account ID that is permitted to create a matching partner event bus for this partner event source.
356
360
  */
357
361
  Account: AccountId;
358
362
  }
@@ -438,7 +442,7 @@ declare namespace CloudWatchEvents {
438
442
  */
439
443
  CreationTime?: Timestamp;
440
444
  /**
441
- * The date and time that the event source will expire if you don't create a matching event bus.
445
+ * The date and time that the event source will expire if you do not create a matching event bus.
442
446
  */
443
447
  ExpirationTime?: Timestamp;
444
448
  /**
@@ -446,7 +450,7 @@ declare namespace CloudWatchEvents {
446
450
  */
447
451
  Name?: String;
448
452
  /**
449
- * The state of the event source. If it's ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it's PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching event bus, but the event source has since been deleted.
453
+ * The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
450
454
  */
451
455
  State?: EventSourceState;
452
456
  }
@@ -486,11 +490,11 @@ declare namespace CloudWatchEvents {
486
490
  */
487
491
  Arn?: RuleArn;
488
492
  /**
489
- * The event pattern. For more information, see Event Patterns in the Amazon EventBridge User Guide.
493
+ * The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
490
494
  */
491
495
  EventPattern?: EventPattern;
492
496
  /**
493
- * The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
497
+ * The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
494
498
  */
495
499
  ScheduleExpression?: ScheduleExpression;
496
500
  /**
@@ -538,7 +542,7 @@ declare namespace CloudWatchEvents {
538
542
  */
539
543
  LaunchType?: LaunchType;
540
544
  /**
541
- * Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. If you specify NetworkConfiguration when the target ECS task doesn't use the awsvpc network mode, the task fails.
545
+ * Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.
542
546
  */
543
547
  NetworkConfiguration?: NetworkConfiguration;
544
548
  /**
@@ -592,11 +596,11 @@ declare namespace CloudWatchEvents {
592
596
  */
593
597
  CreatedBy?: String;
594
598
  /**
595
- * The date and time when the event source was created.
599
+ * The date and time the event source was created.
596
600
  */
597
601
  CreationTime?: Timestamp;
598
602
  /**
599
- * The date and time when the event source will expire if the AWS account doesn't create a matching event bus for it.
603
+ * The date and time that the event source will expire, if the AWS account doesn't create a matching event bus for it.
600
604
  */
601
605
  ExpirationTime?: Timestamp;
602
606
  /**
@@ -604,7 +608,7 @@ declare namespace CloudWatchEvents {
604
608
  */
605
609
  Name?: String;
606
610
  /**
607
- * The state of the event source. If it's ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it's PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching event bus, but the event source has since been deleted.
611
+ * The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
608
612
  */
609
613
  State?: EventSourceState;
610
614
  }
@@ -615,11 +619,11 @@ declare namespace CloudWatchEvents {
615
619
  export type EventTime = Date;
616
620
  export interface InputTransformer {
617
621
  /**
618
- * Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output to be sent to the target. InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation. The keys can't start with "AWS".
622
+ * Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target. InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation. The keys cannot start with "AWS."
619
623
  */
620
624
  InputPathsMap?: TransformerPaths;
621
625
  /**
622
- * Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: &lt;value&gt;. The InputTemplate must be valid JSON. If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply: The placeholder can't be used as an object key Object values can't include quote marks The following example shows the syntax for using InputPathsMap and InputTemplate. "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}, "InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;" } To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}, "InputTemplate": "&lt;instance&gt; is in state \"&lt;status&gt;\"" }
626
+ * Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: &lt;value&gt; The InputTemplate must be valid JSON. If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply: The placeholder cannot be used as an object key. Object values cannot include quote marks. The following example shows the syntax for using InputPathsMap and InputTemplate. "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}, "InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;" } To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}, "InputTemplate": "&lt;instance&gt; is in state \"&lt;status&gt;\"" }
623
627
  */
624
628
  InputTemplate: TransformerInput;
625
629
  }
@@ -644,7 +648,7 @@ declare namespace CloudWatchEvents {
644
648
  */
645
649
  NextToken?: NextToken;
646
650
  /**
647
- * Specifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.
651
+ * Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
648
652
  */
649
653
  Limit?: LimitMax100;
650
654
  }
@@ -668,7 +672,7 @@ declare namespace CloudWatchEvents {
668
672
  */
669
673
  NextToken?: NextToken;
670
674
  /**
671
- * Specifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.
675
+ * Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
672
676
  */
673
677
  Limit?: LimitMax100;
674
678
  }
@@ -692,7 +696,7 @@ declare namespace CloudWatchEvents {
692
696
  */
693
697
  NextToken?: NextToken;
694
698
  /**
695
- * Specifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.
699
+ * Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
696
700
  */
697
701
  Limit?: LimitMax100;
698
702
  }
@@ -716,7 +720,7 @@ declare namespace CloudWatchEvents {
716
720
  */
717
721
  NextToken?: NextToken;
718
722
  /**
719
- * pecifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.
723
+ * pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
720
724
  */
721
725
  Limit?: LimitMax100;
722
726
  }
@@ -788,13 +792,13 @@ declare namespace CloudWatchEvents {
788
792
  }
789
793
  export interface ListTagsForResourceRequest {
790
794
  /**
791
- * The ARN of the rule for which you want to view tags.
795
+ * The ARN of the EventBridge resource for which you want to view tags.
792
796
  */
793
797
  ResourceARN: Arn;
794
798
  }
795
799
  export interface ListTagsForResourceResponse {
796
800
  /**
797
- * The list of tag keys and values associated with the rule that you specified.
801
+ * The list of tag keys and values associated with the resource you specified
798
802
  */
799
803
  Tags?: TagList;
800
804
  }
@@ -830,7 +834,7 @@ declare namespace CloudWatchEvents {
830
834
  export type MessageGroupId = string;
831
835
  export interface NetworkConfiguration {
832
836
  /**
833
- * Use this structure to specify the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
837
+ * Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
834
838
  */
835
839
  awsvpcConfiguration?: AwsVpcConfiguration;
836
840
  }
@@ -852,15 +856,15 @@ declare namespace CloudWatchEvents {
852
856
  */
853
857
  Account?: AccountId;
854
858
  /**
855
- * The date and time when the event source was created.
859
+ * The date and time the event source was created.
856
860
  */
857
861
  CreationTime?: Timestamp;
858
862
  /**
859
- * The date and time when the event source will expire if the AWS account doesn't create a matching event bus for it.
863
+ * The date and time that the event source will expire, if the AWS account doesn't create a matching event bus for it.
860
864
  */
861
865
  ExpirationTime?: Timestamp;
862
866
  /**
863
- * The state of the event source. If it's ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it's PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching event bus, but the event source has since been deleted.
867
+ * The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
864
868
  */
865
869
  State?: EventSourceState;
866
870
  }
@@ -876,27 +880,27 @@ declare namespace CloudWatchEvents {
876
880
  }
877
881
  export interface PutEventsRequestEntry {
878
882
  /**
879
- * The timestamp of the event, per RFC3339. If no timestamp is provided, the timestamp of the PutEvents call is used.
883
+ * The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.
880
884
  */
881
885
  Time?: EventTime;
882
886
  /**
883
- * The source of the event. This field is required.
887
+ * The source of the event.
884
888
  */
885
889
  Source?: String;
886
890
  /**
887
- * AWS resources, identified by Amazon Resource Name (ARN), that the event primarily concerns. Any number, including zero, can be present.
891
+ * AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
888
892
  */
889
893
  Resources?: EventResourceList;
890
894
  /**
891
- * Free-form string used to decide which fields to expect in the event detail.
895
+ * Free-form string used to decide what fields to expect in the event detail.
892
896
  */
893
897
  DetailType?: String;
894
898
  /**
895
- * A valid JSON string. There is no other schema imposed. The JSON string can contain fields and nested subobjects.
899
+ * A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
896
900
  */
897
901
  Detail?: String;
898
902
  /**
899
- * The event bus that will receive the event. Only the rules that are associated with this event bus can match the event.
903
+ * The event bus that will receive the event. Only the rules that are associated with this event bus will be able to match the event.
900
904
  */
901
905
  EventBusName?: NonPartnerEventBusName;
902
906
  }
@@ -940,24 +944,24 @@ declare namespace CloudWatchEvents {
940
944
  /**
941
945
  * The event source that is generating the evntry.
942
946
  */
943
- Source?: String;
947
+ Source?: EventSourceName;
944
948
  /**
945
- * AWS resources, identified by Amazon Resource Name (ARN), that the event primarily concerns. Any number, including zero, can be present.
949
+ * AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
946
950
  */
947
951
  Resources?: EventResourceList;
948
952
  /**
949
- * A free-form string used to decide which fields to expect in the event detail.
953
+ * A free-form string used to decide what fields to expect in the event detail.
950
954
  */
951
955
  DetailType?: String;
952
956
  /**
953
- * A valid JSON string. There is no other schema imposed. The JSON string can contain fields and nested subobjects.
957
+ * A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
954
958
  */
955
959
  Detail?: String;
956
960
  }
957
961
  export type PutPartnerEventsRequestEntryList = PutPartnerEventsRequestEntry[];
958
962
  export interface PutPartnerEventsResponse {
959
963
  /**
960
- * The number of events from this operation that couldn't be written to the partner event bus.
964
+ * The number of events from this operation that could not be written to the partner event bus.
961
965
  */
962
966
  FailedEntryCount?: Integer;
963
967
  /**
@@ -986,33 +990,33 @@ declare namespace CloudWatchEvents {
986
990
  */
987
991
  EventBusName?: NonPartnerEventBusName;
988
992
  /**
989
- * The action that you're enabling the other account to perform. Currently, this must be events:PutEvents.
993
+ * The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.
990
994
  */
991
995
  Action: Action;
992
996
  /**
993
- * The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus. If you specify "*" without specifying Condition, avoid creating rules that might match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID to receive events from. Rules with an account field don't match any events sent from other accounts.
997
+ * The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus. If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
994
998
  */
995
999
  Principal: Principal;
996
1000
  /**
997
- * An identifier string for the external account that you're granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.
1001
+ * An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.
998
1002
  */
999
1003
  StatementId: StatementId;
1000
1004
  /**
1001
- * This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations? in the AWS Organizations User Guide. If you specify Condition with an AWS organization ID and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization. The Condition is a JSON string that must contain Type, Key, and Value fields.
1005
+ * This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide. If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization. The Condition is a JSON string which must contain Type, Key, and Value fields.
1002
1006
  */
1003
1007
  Condition?: Condition;
1004
1008
  }
1005
1009
  export interface PutRuleRequest {
1006
1010
  /**
1007
- * The name of the rule that you're creating or updating.
1011
+ * The name of the rule that you are creating or updating.
1008
1012
  */
1009
1013
  Name: RuleName;
1010
1014
  /**
1011
- * The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
1015
+ * The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
1012
1016
  */
1013
1017
  ScheduleExpression?: ScheduleExpression;
1014
1018
  /**
1015
- * The event pattern. For more information, see Event Patterns in the Amazon EventBridge User Guide.
1019
+ * The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
1016
1020
  */
1017
1021
  EventPattern?: EventPattern;
1018
1022
  /**
@@ -1105,7 +1109,7 @@ declare namespace CloudWatchEvents {
1105
1109
  */
1106
1110
  Ids: TargetIdList;
1107
1111
  /**
1108
- * If this is a managed rule created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that aren't managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
1112
+ * If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
1109
1113
  */
1110
1114
  Force?: Boolean;
1111
1115
  }
@@ -1145,7 +1149,7 @@ declare namespace CloudWatchEvents {
1145
1149
  */
1146
1150
  Arn?: RuleArn;
1147
1151
  /**
1148
- * The event pattern of the rule. For more information, see Event Patterns in the Amazon EventBridge User Guide.
1152
+ * The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
1149
1153
  */
1150
1154
  EventPattern?: EventPattern;
1151
1155
  /**
@@ -1157,7 +1161,7 @@ declare namespace CloudWatchEvents {
1157
1161
  */
1158
1162
  Description?: RuleDescription;
1159
1163
  /**
1160
- * The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
1164
+ * The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
1161
1165
  */
1162
1166
  ScheduleExpression?: ScheduleExpression;
1163
1167
  /**
@@ -1165,7 +1169,7 @@ declare namespace CloudWatchEvents {
1165
1169
  */
1166
1170
  RoleArn?: RoleArn;
1167
1171
  /**
1168
- * If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
1172
+ * If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.
1169
1173
  */
1170
1174
  ManagedBy?: ManagedBy;
1171
1175
  /**
@@ -1211,7 +1215,7 @@ declare namespace CloudWatchEvents {
1211
1215
  export type StringList = String[];
1212
1216
  export interface Tag {
1213
1217
  /**
1214
- * A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
1218
+ * A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
1215
1219
  */
1216
1220
  Key: TagKey;
1217
1221
  /**
@@ -1224,11 +1228,11 @@ declare namespace CloudWatchEvents {
1224
1228
  export type TagList = Tag[];
1225
1229
  export interface TagResourceRequest {
1226
1230
  /**
1227
- * The ARN of the rule that you're adding tags to.
1231
+ * The ARN of the EventBridge resource that you're adding tags to.
1228
1232
  */
1229
1233
  ResourceARN: Arn;
1230
1234
  /**
1231
- * The list of key-value pairs to associate with the rule.
1235
+ * The list of key-value pairs to associate with the resource.
1232
1236
  */
1233
1237
  Tags: TagList;
1234
1238
  }
@@ -1261,7 +1265,7 @@ declare namespace CloudWatchEvents {
1261
1265
  */
1262
1266
  InputTransformer?: InputTransformer;
1263
1267
  /**
1264
- * The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.
1268
+ * The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.
1265
1269
  */
1266
1270
  KinesisParameters?: KinesisParameters;
1267
1271
  /**
@@ -1269,7 +1273,7 @@ declare namespace CloudWatchEvents {
1269
1273
  */
1270
1274
  RunCommandParameters?: RunCommandParameters;
1271
1275
  /**
1272
- * Contains the Amazon ECS task definition and task count to be used if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.
1276
+ * Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.
1273
1277
  */
1274
1278
  EcsParameters?: EcsParameters;
1275
1279
  /**
@@ -1290,7 +1294,7 @@ declare namespace CloudWatchEvents {
1290
1294
  export type TargetPartitionKeyPath = string;
1291
1295
  export interface TestEventPatternRequest {
1292
1296
  /**
1293
- * The event pattern. For more information, see Event Patterns in the Amazon EventBridge User Guide.
1297
+ * The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
1294
1298
  */
1295
1299
  EventPattern: EventPattern;
1296
1300
  /**
@@ -1309,7 +1313,7 @@ declare namespace CloudWatchEvents {
1309
1313
  export type TransformerPaths = {[key: string]: TargetInputPath};
1310
1314
  export interface UntagResourceRequest {
1311
1315
  /**
1312
- * The ARN of the rule that you're removing tags from.
1316
+ * The ARN of the EventBridge resource from which you are removing tags.
1313
1317
  */
1314
1318
  ResourceARN: Arn;
1315
1319
  /**