aws-sdk 2.972.0 → 2.976.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.
- package/CHANGELOG.md +29 -1
- package/README.md +1 -1
- package/apis/backup-2018-11-15.min.json +573 -32
- package/apis/backup-2018-11-15.paginators.json +15 -0
- package/apis/comprehend-2017-11-27.min.json +109 -69
- package/apis/datasync-2018-11-09.min.json +13 -1
- package/apis/dlm-2018-01-12.min.json +30 -9
- package/apis/dms-2016-01-01.min.json +191 -134
- package/apis/ec2-2016-11-15.min.json +232 -223
- package/apis/ec2-2016-11-15.paginators.json +6 -0
- package/apis/eks-2017-11-01.min.json +5 -0
- package/apis/fms-2018-01-01.min.json +6 -0
- package/apis/frauddetector-2019-11-15.min.json +30 -28
- package/apis/glue-2017-03-31.min.json +624 -354
- package/apis/glue-2017-03-31.paginators.json +10 -0
- package/apis/iot-data-2015-05-28.min.json +82 -0
- package/apis/iot-data-2015-05-28.paginators.json +7 -1
- package/apis/mediaconvert-2017-08-29.min.json +110 -89
- package/apis/ssm-2014-11-06.min.json +13 -3
- package/apis/transcribe-2017-10-26.min.json +161 -64
- package/clients/apigateway.d.ts +9 -9
- package/clients/backup.d.ts +715 -109
- package/clients/cloudwatchevents.d.ts +67 -67
- package/clients/comprehend.d.ts +96 -0
- package/clients/datasync.d.ts +69 -53
- package/clients/dlm.d.ts +50 -18
- package/clients/dms.d.ts +110 -19
- package/clients/ec2.d.ts +60 -42
- package/clients/eks.d.ts +6 -2
- package/clients/eventbridge.d.ts +3 -3
- package/clients/fms.d.ts +9 -1
- package/clients/frauddetector.d.ts +10 -9
- package/clients/glue.d.ts +392 -0
- package/clients/iotdata.d.ts +99 -13
- package/clients/iotsitewise.d.ts +3 -3
- package/clients/mediaconvert.d.ts +46 -12
- package/clients/polly.d.ts +15 -15
- package/clients/robomaker.d.ts +3 -3
- package/clients/transcribeservice.d.ts +146 -35
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +19 -19
- package/dist/aws-sdk.js +456 -300
- package/dist/aws-sdk.min.js +72 -71
- package/lib/core.js +1 -1
- package/lib/metadata_service/endpoint.js +6 -0
- package/lib/metadata_service/endpoint_config_options.js +14 -0
- package/lib/metadata_service/endpoint_mode.js +6 -0
- package/lib/metadata_service/endpoint_mode_config_options.js +16 -0
- package/lib/metadata_service/get_metadata_service_endpoint.js +24 -0
- package/lib/metadata_service.js +13 -3
- package/lib/node_loader.js +27 -0
- package/package.json +1 -1
|
@@ -60,11 +60,11 @@ declare class CloudWatchEvents extends Service {
|
|
|
60
60
|
*/
|
|
61
61
|
createEventBus(callback?: (err: AWSError, data: CloudWatchEvents.Types.CreateEventBusResponse) => void): Request<CloudWatchEvents.Types.CreateEventBusResponse, AWSError>;
|
|
62
62
|
/**
|
|
63
|
-
* Called by an SaaS partner to create a partner event source. This operation is not used by
|
|
63
|
+
* Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services customers decide whether to create an event bus to receive these events.
|
|
64
64
|
*/
|
|
65
65
|
createPartnerEventSource(params: CloudWatchEvents.Types.CreatePartnerEventSourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.CreatePartnerEventSourceResponse) => void): Request<CloudWatchEvents.Types.CreatePartnerEventSourceResponse, AWSError>;
|
|
66
66
|
/**
|
|
67
|
-
* Called by an SaaS partner to create a partner event source. This operation is not used by
|
|
67
|
+
* Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services customers decide whether to create an event bus to receive these events.
|
|
68
68
|
*/
|
|
69
69
|
createPartnerEventSource(callback?: (err: AWSError, data: CloudWatchEvents.Types.CreatePartnerEventSourceResponse) => void): Request<CloudWatchEvents.Types.CreatePartnerEventSourceResponse, AWSError>;
|
|
70
70
|
/**
|
|
@@ -116,19 +116,19 @@ declare class CloudWatchEvents extends Service {
|
|
|
116
116
|
*/
|
|
117
117
|
deleteEventBus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
118
118
|
/**
|
|
119
|
-
* This operation is used by SaaS partners to delete a partner event source. This operation is not used by
|
|
119
|
+
* This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.
|
|
120
120
|
*/
|
|
121
121
|
deletePartnerEventSource(params: CloudWatchEvents.Types.DeletePartnerEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
122
122
|
/**
|
|
123
|
-
* This operation is used by SaaS partners to delete a partner event source. This operation is not used by
|
|
123
|
+
* This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.
|
|
124
124
|
*/
|
|
125
125
|
deletePartnerEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
126
126
|
/**
|
|
127
|
-
* 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. If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned. Managed rules are rules created and managed by another
|
|
127
|
+
* 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. If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned. Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services 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.
|
|
128
128
|
*/
|
|
129
129
|
deleteRule(params: CloudWatchEvents.Types.DeleteRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
130
130
|
/**
|
|
131
|
-
* 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. If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned. Managed rules are rules created and managed by another
|
|
131
|
+
* 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. If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned. Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services 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.
|
|
132
132
|
*/
|
|
133
133
|
deleteRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
134
134
|
/**
|
|
@@ -156,11 +156,11 @@ declare class CloudWatchEvents extends Service {
|
|
|
156
156
|
*/
|
|
157
157
|
describeConnection(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeConnectionResponse) => void): Request<CloudWatchEvents.Types.DescribeConnectionResponse, AWSError>;
|
|
158
158
|
/**
|
|
159
|
-
* Displays details about an event bus in your account. This can include the external
|
|
159
|
+
* Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time. To enable your account to receive events from other accounts on its default event bus, use PutPermission. For more information about partner event buses, see CreateEventBus.
|
|
160
160
|
*/
|
|
161
161
|
describeEventBus(params: CloudWatchEvents.Types.DescribeEventBusRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeEventBusResponse) => void): Request<CloudWatchEvents.Types.DescribeEventBusResponse, AWSError>;
|
|
162
162
|
/**
|
|
163
|
-
* Displays details about an event bus in your account. This can include the external
|
|
163
|
+
* Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time. To enable your account to receive events from other accounts on its default event bus, use PutPermission. For more information about partner event buses, see CreateEventBus.
|
|
164
164
|
*/
|
|
165
165
|
describeEventBus(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeEventBusResponse) => void): Request<CloudWatchEvents.Types.DescribeEventBusResponse, AWSError>;
|
|
166
166
|
/**
|
|
@@ -172,11 +172,11 @@ declare class CloudWatchEvents extends Service {
|
|
|
172
172
|
*/
|
|
173
173
|
describeEventSource(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeEventSourceResponse) => void): Request<CloudWatchEvents.Types.DescribeEventSourceResponse, AWSError>;
|
|
174
174
|
/**
|
|
175
|
-
* An SaaS partner can use this operation to list details about a partner event source that they have created.
|
|
175
|
+
* An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.
|
|
176
176
|
*/
|
|
177
177
|
describePartnerEventSource(params: CloudWatchEvents.Types.DescribePartnerEventSourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribePartnerEventSourceResponse) => void): Request<CloudWatchEvents.Types.DescribePartnerEventSourceResponse, AWSError>;
|
|
178
178
|
/**
|
|
179
|
-
* An SaaS partner can use this operation to list details about a partner event source that they have created.
|
|
179
|
+
* An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.
|
|
180
180
|
*/
|
|
181
181
|
describePartnerEventSource(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribePartnerEventSourceResponse) => void): Request<CloudWatchEvents.Types.DescribePartnerEventSourceResponse, AWSError>;
|
|
182
182
|
/**
|
|
@@ -244,27 +244,27 @@ declare class CloudWatchEvents extends Service {
|
|
|
244
244
|
*/
|
|
245
245
|
listEventBuses(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListEventBusesResponse) => void): Request<CloudWatchEvents.Types.ListEventBusesResponse, AWSError>;
|
|
246
246
|
/**
|
|
247
|
-
* You can use this to see all the partner event sources that have been shared with your
|
|
247
|
+
* You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.
|
|
248
248
|
*/
|
|
249
249
|
listEventSources(params: CloudWatchEvents.Types.ListEventSourcesRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListEventSourcesResponse) => void): Request<CloudWatchEvents.Types.ListEventSourcesResponse, AWSError>;
|
|
250
250
|
/**
|
|
251
|
-
* You can use this to see all the partner event sources that have been shared with your
|
|
251
|
+
* You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.
|
|
252
252
|
*/
|
|
253
253
|
listEventSources(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListEventSourcesResponse) => void): Request<CloudWatchEvents.Types.ListEventSourcesResponse, AWSError>;
|
|
254
254
|
/**
|
|
255
|
-
* An SaaS partner can use this operation to display the
|
|
255
|
+
* An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.
|
|
256
256
|
*/
|
|
257
257
|
listPartnerEventSourceAccounts(params: CloudWatchEvents.Types.ListPartnerEventSourceAccountsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListPartnerEventSourceAccountsResponse) => void): Request<CloudWatchEvents.Types.ListPartnerEventSourceAccountsResponse, AWSError>;
|
|
258
258
|
/**
|
|
259
|
-
* An SaaS partner can use this operation to display the
|
|
259
|
+
* An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.
|
|
260
260
|
*/
|
|
261
261
|
listPartnerEventSourceAccounts(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListPartnerEventSourceAccountsResponse) => void): Request<CloudWatchEvents.Types.ListPartnerEventSourceAccountsResponse, AWSError>;
|
|
262
262
|
/**
|
|
263
|
-
* 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
|
|
263
|
+
* 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 Amazon Web Services customers.
|
|
264
264
|
*/
|
|
265
265
|
listPartnerEventSources(params: CloudWatchEvents.Types.ListPartnerEventSourcesRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListPartnerEventSourcesResponse) => void): Request<CloudWatchEvents.Types.ListPartnerEventSourcesResponse, AWSError>;
|
|
266
266
|
/**
|
|
267
|
-
* 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
|
|
267
|
+
* 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 Amazon Web Services customers.
|
|
268
268
|
*/
|
|
269
269
|
listPartnerEventSources(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListPartnerEventSourcesResponse) => void): Request<CloudWatchEvents.Types.ListPartnerEventSourcesResponse, AWSError>;
|
|
270
270
|
/**
|
|
@@ -316,43 +316,43 @@ declare class CloudWatchEvents extends Service {
|
|
|
316
316
|
*/
|
|
317
317
|
putEvents(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutEventsResponse) => void): Request<CloudWatchEvents.Types.PutEventsResponse, AWSError>;
|
|
318
318
|
/**
|
|
319
|
-
* This is used by SaaS partners to write events to a customer's partner event bus.
|
|
319
|
+
* This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
|
|
320
320
|
*/
|
|
321
321
|
putPartnerEvents(params: CloudWatchEvents.Types.PutPartnerEventsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutPartnerEventsResponse) => void): Request<CloudWatchEvents.Types.PutPartnerEventsResponse, AWSError>;
|
|
322
322
|
/**
|
|
323
|
-
* This is used by SaaS partners to write events to a customer's partner event bus.
|
|
323
|
+
* This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
|
|
324
324
|
*/
|
|
325
325
|
putPartnerEvents(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutPartnerEventsResponse) => void): Request<CloudWatchEvents.Types.PutPartnerEventsResponse, AWSError>;
|
|
326
326
|
/**
|
|
327
|
-
* Running PutPermission permits the specified
|
|
327
|
+
* Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (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 Amazon Web Services 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 Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services 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 Amazon Web Services Accounts in the Amazon EventBridge User Guide. The permission policy on the event bus cannot exceed 10 KB in size.
|
|
328
328
|
*/
|
|
329
329
|
putPermission(params: CloudWatchEvents.Types.PutPermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
330
330
|
/**
|
|
331
|
-
* Running PutPermission permits the specified
|
|
331
|
+
* Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (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 Amazon Web Services 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 Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services 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 Amazon Web Services Accounts in the Amazon EventBridge User Guide. The permission policy on the event bus cannot exceed 10 KB in size.
|
|
332
332
|
*/
|
|
333
333
|
putPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
334
334
|
/**
|
|
335
|
-
* 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
|
|
335
|
+
* 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 Amazon Web Services 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 Amazon Web Services 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.
|
|
336
336
|
*/
|
|
337
337
|
putRule(params: CloudWatchEvents.Types.PutRuleRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutRuleResponse) => void): Request<CloudWatchEvents.Types.PutRuleResponse, AWSError>;
|
|
338
338
|
/**
|
|
339
|
-
* 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
|
|
339
|
+
* 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 Amazon Web Services 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 Amazon Web Services 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.
|
|
340
340
|
*/
|
|
341
341
|
putRule(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutRuleResponse) => void): Request<CloudWatchEvents.Types.PutRuleResponse, AWSError>;
|
|
342
342
|
/**
|
|
343
|
-
* 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: API destination Amazon API Gateway REST API endpoints API Gateway
|
|
343
|
+
* 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: API destination Amazon API Gateway REST API endpoints API Gateway Batch job queue CloudWatch Logs group CodeBuild project CodePipeline Amazon EC2 CreateSnapshot API call Amazon EC2 RebootInstances API call Amazon EC2 StopInstances API call Amazon EC2 TerminateInstances API call Amazon ECS tasks Event bus in a different Amazon Web Services account or Region. You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule. Firehose delivery stream (Kinesis Data Firehose) Inspector assessment template (Amazon Inspector) Kinesis stream (Kinesis Data Stream) Lambda function Redshift clusters (Data API statement execution) Amazon SNS topic Amazon SQS queues (includes FIFO queues SSM Automation SSM OpsItem SSM Run Command Step Functions state machines Creating rules with built-in targets is supported only in the 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 Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway REST APIs, 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 Amazon Web Services 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 EventBridge Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services 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 Amazon Web Services 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.
|
|
344
344
|
*/
|
|
345
345
|
putTargets(params: CloudWatchEvents.Types.PutTargetsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutTargetsResponse) => void): Request<CloudWatchEvents.Types.PutTargetsResponse, AWSError>;
|
|
346
346
|
/**
|
|
347
|
-
* 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: API destination Amazon API Gateway REST API endpoints API Gateway
|
|
347
|
+
* 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: API destination Amazon API Gateway REST API endpoints API Gateway Batch job queue CloudWatch Logs group CodeBuild project CodePipeline Amazon EC2 CreateSnapshot API call Amazon EC2 RebootInstances API call Amazon EC2 StopInstances API call Amazon EC2 TerminateInstances API call Amazon ECS tasks Event bus in a different Amazon Web Services account or Region. You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule. Firehose delivery stream (Kinesis Data Firehose) Inspector assessment template (Amazon Inspector) Kinesis stream (Kinesis Data Stream) Lambda function Redshift clusters (Data API statement execution) Amazon SNS topic Amazon SQS queues (includes FIFO queues SSM Automation SSM OpsItem SSM Run Command Step Functions state machines Creating rules with built-in targets is supported only in the 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 Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway REST APIs, 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 Amazon Web Services 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 EventBridge Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services 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 Amazon Web Services 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.
|
|
348
348
|
*/
|
|
349
349
|
putTargets(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutTargetsResponse) => void): Request<CloudWatchEvents.Types.PutTargetsResponse, AWSError>;
|
|
350
350
|
/**
|
|
351
|
-
* Revokes the permission of another
|
|
351
|
+
* Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.
|
|
352
352
|
*/
|
|
353
353
|
removePermission(params: CloudWatchEvents.Types.RemovePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
354
354
|
/**
|
|
355
|
-
* Revokes the permission of another
|
|
355
|
+
* Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.
|
|
356
356
|
*/
|
|
357
357
|
removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
358
358
|
/**
|
|
@@ -372,19 +372,19 @@ declare class CloudWatchEvents extends Service {
|
|
|
372
372
|
*/
|
|
373
373
|
startReplay(callback?: (err: AWSError, data: CloudWatchEvents.Types.StartReplayResponse) => void): Request<CloudWatchEvents.Types.StartReplayResponse, AWSError>;
|
|
374
374
|
/**
|
|
375
|
-
* 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
|
|
375
|
+
* 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 Amazon Web Services 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.
|
|
376
376
|
*/
|
|
377
377
|
tagResource(params: CloudWatchEvents.Types.TagResourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.TagResourceResponse) => void): Request<CloudWatchEvents.Types.TagResourceResponse, AWSError>;
|
|
378
378
|
/**
|
|
379
|
-
* 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
|
|
379
|
+
* 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 Amazon Web Services 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.
|
|
380
380
|
*/
|
|
381
381
|
tagResource(callback?: (err: AWSError, data: CloudWatchEvents.Types.TagResourceResponse) => void): Request<CloudWatchEvents.Types.TagResourceResponse, AWSError>;
|
|
382
382
|
/**
|
|
383
|
-
* Tests whether the specified event pattern matches the provided event. Most services in
|
|
383
|
+
* Tests whether the specified event pattern matches the provided event. Most services in Amazon Web Services 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.
|
|
384
384
|
*/
|
|
385
385
|
testEventPattern(params: CloudWatchEvents.Types.TestEventPatternRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.TestEventPatternResponse) => void): Request<CloudWatchEvents.Types.TestEventPatternResponse, AWSError>;
|
|
386
386
|
/**
|
|
387
|
-
* Tests whether the specified event pattern matches the provided event. Most services in
|
|
387
|
+
* Tests whether the specified event pattern matches the provided event. Most services in Amazon Web Services 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.
|
|
388
388
|
*/
|
|
389
389
|
testEventPattern(callback?: (err: AWSError, data: CloudWatchEvents.Types.TestEventPatternResponse) => void): Request<CloudWatchEvents.Types.TestEventPatternResponse, AWSError>;
|
|
390
390
|
/**
|
|
@@ -539,19 +539,19 @@ declare namespace CloudWatchEvents {
|
|
|
539
539
|
}
|
|
540
540
|
export interface BatchParameters {
|
|
541
541
|
/**
|
|
542
|
-
* The ARN or name of the job definition to use if the event target is an
|
|
542
|
+
* The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
|
|
543
543
|
*/
|
|
544
544
|
JobDefinition: String;
|
|
545
545
|
/**
|
|
546
|
-
* The name to use for this execution of the job, if the target is an
|
|
546
|
+
* The name to use for this execution of the job, if the target is an Batch job.
|
|
547
547
|
*/
|
|
548
548
|
JobName: String;
|
|
549
549
|
/**
|
|
550
|
-
* The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an
|
|
550
|
+
* The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
|
|
551
551
|
*/
|
|
552
552
|
ArrayProperties?: BatchArrayProperties;
|
|
553
553
|
/**
|
|
554
|
-
* The retry strategy to use for failed jobs, if the target is an
|
|
554
|
+
* The retry strategy to use for failed jobs, if the target is an 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.
|
|
555
555
|
*/
|
|
556
556
|
RetryStrategy?: BatchRetryStrategy;
|
|
557
557
|
}
|
|
@@ -819,7 +819,7 @@ declare namespace CloudWatchEvents {
|
|
|
819
819
|
*/
|
|
820
820
|
ArchiveName: ArchiveName;
|
|
821
821
|
/**
|
|
822
|
-
* The ARN of the event
|
|
822
|
+
* The ARN of the event bus that sends events to the archive.
|
|
823
823
|
*/
|
|
824
824
|
EventSourceArn: Arn;
|
|
825
825
|
/**
|
|
@@ -977,11 +977,11 @@ declare namespace CloudWatchEvents {
|
|
|
977
977
|
}
|
|
978
978
|
export interface CreatePartnerEventSourceRequest {
|
|
979
979
|
/**
|
|
980
|
-
* The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The
|
|
980
|
+
* The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.
|
|
981
981
|
*/
|
|
982
982
|
Name: EventSourceName;
|
|
983
983
|
/**
|
|
984
|
-
* The
|
|
984
|
+
* The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.
|
|
985
985
|
*/
|
|
986
986
|
Account: AccountId;
|
|
987
987
|
}
|
|
@@ -1090,7 +1090,7 @@ declare namespace CloudWatchEvents {
|
|
|
1090
1090
|
*/
|
|
1091
1091
|
Name: EventSourceName;
|
|
1092
1092
|
/**
|
|
1093
|
-
* The
|
|
1093
|
+
* The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.
|
|
1094
1094
|
*/
|
|
1095
1095
|
Account: AccountId;
|
|
1096
1096
|
}
|
|
@@ -1104,7 +1104,7 @@ declare namespace CloudWatchEvents {
|
|
|
1104
1104
|
*/
|
|
1105
1105
|
EventBusName?: EventBusNameOrArn;
|
|
1106
1106
|
/**
|
|
1107
|
-
* If this is a managed rule, created by an
|
|
1107
|
+
* If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to delete the rule. 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.
|
|
1108
1108
|
*/
|
|
1109
1109
|
Force?: Boolean;
|
|
1110
1110
|
}
|
|
@@ -1424,7 +1424,7 @@ declare namespace CloudWatchEvents {
|
|
|
1424
1424
|
*/
|
|
1425
1425
|
RoleArn?: RoleArn;
|
|
1426
1426
|
/**
|
|
1427
|
-
* If this is a managed rule, created by an
|
|
1427
|
+
* If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
|
|
1428
1428
|
*/
|
|
1429
1429
|
ManagedBy?: ManagedBy;
|
|
1430
1430
|
/**
|
|
@@ -1456,15 +1456,15 @@ declare namespace CloudWatchEvents {
|
|
|
1456
1456
|
*/
|
|
1457
1457
|
TaskCount?: LimitMin1;
|
|
1458
1458
|
/**
|
|
1459
|
-
* Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where
|
|
1459
|
+
* Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
|
|
1460
1460
|
*/
|
|
1461
1461
|
LaunchType?: LaunchType;
|
|
1462
1462
|
/**
|
|
1463
|
-
* 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.
|
|
1463
|
+
* Use this structure if the Amazon 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.
|
|
1464
1464
|
*/
|
|
1465
1465
|
NetworkConfiguration?: NetworkConfiguration;
|
|
1466
1466
|
/**
|
|
1467
|
-
* Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0. This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see
|
|
1467
|
+
* Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0. This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
|
|
1468
1468
|
*/
|
|
1469
1469
|
PlatformVersion?: String;
|
|
1470
1470
|
/**
|
|
@@ -1526,7 +1526,7 @@ declare namespace CloudWatchEvents {
|
|
|
1526
1526
|
*/
|
|
1527
1527
|
Arn?: String;
|
|
1528
1528
|
/**
|
|
1529
|
-
* The permissions policy of the event bus, describing which other
|
|
1529
|
+
* The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus.
|
|
1530
1530
|
*/
|
|
1531
1531
|
Policy?: String;
|
|
1532
1532
|
}
|
|
@@ -1551,7 +1551,7 @@ declare namespace CloudWatchEvents {
|
|
|
1551
1551
|
*/
|
|
1552
1552
|
CreationTime?: Timestamp;
|
|
1553
1553
|
/**
|
|
1554
|
-
* The date and time that the event source will expire, if the
|
|
1554
|
+
* The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.
|
|
1555
1555
|
*/
|
|
1556
1556
|
ExpirationTime?: Timestamp;
|
|
1557
1557
|
/**
|
|
@@ -1588,7 +1588,7 @@ declare namespace CloudWatchEvents {
|
|
|
1588
1588
|
export type HttpsEndpoint = string;
|
|
1589
1589
|
export interface InputTransformer {
|
|
1590
1590
|
/**
|
|
1591
|
-
* 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 100 key-value pairs. You must use JSON dot notation, not bracket notation. The keys cannot start with "
|
|
1591
|
+
* 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 100 key-value pairs. You must use JSON dot notation, not bracket notation. The keys cannot start with "Amazon Web Services."
|
|
1592
1592
|
*/
|
|
1593
1593
|
InputPathsMap?: TransformerPaths;
|
|
1594
1594
|
/**
|
|
@@ -1604,7 +1604,7 @@ declare namespace CloudWatchEvents {
|
|
|
1604
1604
|
*/
|
|
1605
1605
|
PartitionKeyPath: TargetPartitionKeyPath;
|
|
1606
1606
|
}
|
|
1607
|
-
export type LaunchType = "EC2"|"FARGATE"|string;
|
|
1607
|
+
export type LaunchType = "EC2"|"FARGATE"|"EXTERNAL"|string;
|
|
1608
1608
|
export type LimitMax100 = number;
|
|
1609
1609
|
export type LimitMin1 = number;
|
|
1610
1610
|
export interface ListApiDestinationsRequest {
|
|
@@ -1801,7 +1801,7 @@ declare namespace CloudWatchEvents {
|
|
|
1801
1801
|
*/
|
|
1802
1802
|
State?: ReplayState;
|
|
1803
1803
|
/**
|
|
1804
|
-
* The ARN of the
|
|
1804
|
+
* The ARN of the archive from which the events are replayed.
|
|
1805
1805
|
*/
|
|
1806
1806
|
EventSourceArn?: Arn;
|
|
1807
1807
|
/**
|
|
@@ -1945,7 +1945,7 @@ declare namespace CloudWatchEvents {
|
|
|
1945
1945
|
}
|
|
1946
1946
|
export interface PartnerEventSourceAccount {
|
|
1947
1947
|
/**
|
|
1948
|
-
* The
|
|
1948
|
+
* The Amazon Web Services account ID that the partner event source was offered to.
|
|
1949
1949
|
*/
|
|
1950
1950
|
Account?: AccountId;
|
|
1951
1951
|
/**
|
|
@@ -1953,7 +1953,7 @@ declare namespace CloudWatchEvents {
|
|
|
1953
1953
|
*/
|
|
1954
1954
|
CreationTime?: Timestamp;
|
|
1955
1955
|
/**
|
|
1956
|
-
* The date and time that the event source will expire, if the
|
|
1956
|
+
* The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.
|
|
1957
1957
|
*/
|
|
1958
1958
|
ExpirationTime?: Timestamp;
|
|
1959
1959
|
/**
|
|
@@ -2010,7 +2010,7 @@ declare namespace CloudWatchEvents {
|
|
|
2010
2010
|
*/
|
|
2011
2011
|
Source?: String;
|
|
2012
2012
|
/**
|
|
2013
|
-
*
|
|
2013
|
+
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
|
|
2014
2014
|
*/
|
|
2015
2015
|
Resources?: EventResourceList;
|
|
2016
2016
|
/**
|
|
@@ -2026,7 +2026,7 @@ declare namespace CloudWatchEvents {
|
|
|
2026
2026
|
*/
|
|
2027
2027
|
EventBusName?: NonPartnerEventBusNameOrArn;
|
|
2028
2028
|
/**
|
|
2029
|
-
* An
|
|
2029
|
+
* An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event. To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
|
|
2030
2030
|
*/
|
|
2031
2031
|
TraceHeader?: TraceHeader;
|
|
2032
2032
|
}
|
|
@@ -2068,11 +2068,11 @@ declare namespace CloudWatchEvents {
|
|
|
2068
2068
|
*/
|
|
2069
2069
|
Time?: EventTime;
|
|
2070
2070
|
/**
|
|
2071
|
-
* The event source that is generating the
|
|
2071
|
+
* The event source that is generating the entry.
|
|
2072
2072
|
*/
|
|
2073
2073
|
Source?: EventSourceName;
|
|
2074
2074
|
/**
|
|
2075
|
-
*
|
|
2075
|
+
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
|
|
2076
2076
|
*/
|
|
2077
2077
|
Resources?: EventResourceList;
|
|
2078
2078
|
/**
|
|
@@ -2116,11 +2116,11 @@ declare namespace CloudWatchEvents {
|
|
|
2116
2116
|
*/
|
|
2117
2117
|
EventBusName?: NonPartnerEventBusName;
|
|
2118
2118
|
/**
|
|
2119
|
-
* The action that you are enabling the other account to perform.
|
|
2119
|
+
* The action that you are enabling the other account to perform.
|
|
2120
2120
|
*/
|
|
2121
2121
|
Action?: Action;
|
|
2122
2122
|
/**
|
|
2123
|
-
* The 12-digit
|
|
2123
|
+
* The 12-digit Amazon Web Services 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.
|
|
2124
2124
|
*/
|
|
2125
2125
|
Principal?: Principal;
|
|
2126
2126
|
/**
|
|
@@ -2128,7 +2128,7 @@ declare namespace CloudWatchEvents {
|
|
|
2128
2128
|
*/
|
|
2129
2129
|
StatementId?: StatementId;
|
|
2130
2130
|
/**
|
|
2131
|
-
* This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain
|
|
2131
|
+
* This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide. If you specify Condition with an Amazon Web Services 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.
|
|
2132
2132
|
*/
|
|
2133
2133
|
Condition?: Condition;
|
|
2134
2134
|
/**
|
|
@@ -2158,7 +2158,7 @@ declare namespace CloudWatchEvents {
|
|
|
2158
2158
|
*/
|
|
2159
2159
|
Description?: RuleDescription;
|
|
2160
2160
|
/**
|
|
2161
|
-
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
|
|
2161
|
+
* The Amazon Resource Name (ARN) of the IAM role associated with the rule. 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, instead of here in this parameter.
|
|
2162
2162
|
*/
|
|
2163
2163
|
RoleArn?: RoleArn;
|
|
2164
2164
|
/**
|
|
@@ -2220,7 +2220,7 @@ declare namespace CloudWatchEvents {
|
|
|
2220
2220
|
export type QueryStringValue = string;
|
|
2221
2221
|
export interface RedshiftDataParameters {
|
|
2222
2222
|
/**
|
|
2223
|
-
* The name or ARN of the secret that enables access to the database. Required when authenticating using
|
|
2223
|
+
* The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
|
|
2224
2224
|
*/
|
|
2225
2225
|
SecretManagerArn?: RedshiftSecretManagerArn;
|
|
2226
2226
|
/**
|
|
@@ -2274,7 +2274,7 @@ declare namespace CloudWatchEvents {
|
|
|
2274
2274
|
*/
|
|
2275
2275
|
Ids: TargetIdList;
|
|
2276
2276
|
/**
|
|
2277
|
-
* If this is a managed rule, created by an
|
|
2277
|
+
* If this is a managed rule, created by an Amazon Web Services 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.
|
|
2278
2278
|
*/
|
|
2279
2279
|
Force?: Boolean;
|
|
2280
2280
|
}
|
|
@@ -2393,15 +2393,15 @@ declare namespace CloudWatchEvents {
|
|
|
2393
2393
|
*/
|
|
2394
2394
|
Description?: RuleDescription;
|
|
2395
2395
|
/**
|
|
2396
|
-
* The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
|
|
2396
|
+
* The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
|
|
2397
2397
|
*/
|
|
2398
2398
|
ScheduleExpression?: ScheduleExpression;
|
|
2399
2399
|
/**
|
|
2400
|
-
* The Amazon Resource Name (ARN) of the role that is used for target invocation.
|
|
2400
|
+
* The Amazon Resource Name (ARN) of the role that is used for target invocation. 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, instead of here in this parameter.
|
|
2401
2401
|
*/
|
|
2402
2402
|
RoleArn?: RoleArn;
|
|
2403
2403
|
/**
|
|
2404
|
-
* If the rule was created on behalf of your account by an
|
|
2404
|
+
* If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.
|
|
2405
2405
|
*/
|
|
2406
2406
|
ManagedBy?: ManagedBy;
|
|
2407
2407
|
/**
|
|
@@ -2539,7 +2539,7 @@ declare namespace CloudWatchEvents {
|
|
|
2539
2539
|
export type TagValue = string;
|
|
2540
2540
|
export interface Target {
|
|
2541
2541
|
/**
|
|
2542
|
-
* The ID of the target.
|
|
2542
|
+
* The ID of the target. We recommend using a memorable and unique string.
|
|
2543
2543
|
*/
|
|
2544
2544
|
Id: TargetId;
|
|
2545
2545
|
/**
|
|
@@ -2575,7 +2575,7 @@ declare namespace CloudWatchEvents {
|
|
|
2575
2575
|
*/
|
|
2576
2576
|
EcsParameters?: EcsParameters;
|
|
2577
2577
|
/**
|
|
2578
|
-
* If the event target is an
|
|
2578
|
+
* If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the Batch User Guide.
|
|
2579
2579
|
*/
|
|
2580
2580
|
BatchParameters?: BatchParameters;
|
|
2581
2581
|
/**
|
|
@@ -2587,7 +2587,7 @@ declare namespace CloudWatchEvents {
|
|
|
2587
2587
|
*/
|
|
2588
2588
|
HttpParameters?: HttpParameters;
|
|
2589
2589
|
/**
|
|
2590
|
-
* Contains the Redshift Data API parameters to use when the target is a Redshift cluster. If you specify a Redshift Cluster as a Target, you can use this to specify parameters to invoke the Redshift Data API ExecuteStatement based on EventBridge events.
|
|
2590
|
+
* Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster. If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
|
|
2591
2591
|
*/
|
|
2592
2592
|
RedshiftDataParameters?: RedshiftDataParameters;
|
|
2593
2593
|
/**
|
|
@@ -2616,7 +2616,7 @@ declare namespace CloudWatchEvents {
|
|
|
2616
2616
|
*/
|
|
2617
2617
|
EventPattern: EventPattern;
|
|
2618
2618
|
/**
|
|
2619
|
-
* The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in
|
|
2619
|
+
* The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in Amazon Web Services Events, and the following fields are mandatory: id account source time region resources detail-type
|
|
2620
2620
|
*/
|
|
2621
2621
|
Event: String;
|
|
2622
2622
|
}
|