@aws-sdk/client-eventbridge 3.574.0 → 3.575.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/README.md +17 -9
- package/dist-cjs/index.js +76 -3
- package/dist-es/EventBridge.js +2 -0
- package/dist-es/commands/UpdateEventBusCommand.js +24 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +57 -2
- package/dist-types/EventBridge.d.ts +17 -9
- package/dist-types/EventBridgeClient.d.ts +12 -11
- package/dist-types/commands/CreateApiDestinationCommand.d.ts +4 -2
- package/dist-types/commands/CreateArchiveCommand.d.ts +23 -0
- package/dist-types/commands/CreateEndpointCommand.d.ts +6 -3
- package/dist-types/commands/CreateEventBusCommand.d.ts +10 -0
- package/dist-types/commands/CreatePartnerEventSourceCommand.d.ts +16 -14
- package/dist-types/commands/DeleteEndpointCommand.d.ts +5 -1
- package/dist-types/commands/DeletePartnerEventSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRuleCommand.d.ts +7 -6
- package/dist-types/commands/DescribeEndpointCommand.d.ts +6 -1
- package/dist-types/commands/DescribeEventBusCommand.d.ts +10 -4
- package/dist-types/commands/DescribePartnerEventSourceCommand.d.ts +2 -3
- package/dist-types/commands/DisableRuleCommand.d.ts +2 -2
- package/dist-types/commands/EnableRuleCommand.d.ts +2 -2
- package/dist-types/commands/ListEndpointsCommand.d.ts +6 -1
- package/dist-types/commands/ListEventBusesCommand.d.ts +3 -0
- package/dist-types/commands/ListEventSourcesCommand.d.ts +2 -2
- package/dist-types/commands/ListPartnerEventSourceAccountsCommand.d.ts +2 -3
- package/dist-types/commands/ListRulesCommand.d.ts +2 -2
- package/dist-types/commands/PutEventsCommand.d.ts +9 -6
- package/dist-types/commands/PutPartnerEventsCommand.d.ts +3 -5
- package/dist-types/commands/PutPermissionCommand.d.ts +9 -9
- package/dist-types/commands/PutRuleCommand.d.ts +10 -11
- package/dist-types/commands/PutTargetsCommand.d.ts +28 -28
- package/dist-types/commands/RemovePermissionCommand.d.ts +4 -4
- package/dist-types/commands/RemoveTargetsCommand.d.ts +4 -3
- package/dist-types/commands/TagResourceCommand.d.ts +4 -4
- package/dist-types/commands/TestEventPatternCommand.d.ts +4 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateEndpointCommand.d.ts +5 -1
- package/dist-types/commands/UpdateEventBusCommand.d.ts +82 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +9 -9
- package/dist-types/models/models_0.d.ts +524 -200
- package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/ts3.4/EventBridge.d.ts +18 -0
- package/dist-types/ts3.4/EventBridgeClient.d.ts +8 -2
- package/dist-types/ts3.4/commands/UpdateEventBusCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +30 -3
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +12 -0
- package/package.json +40 -40
|
@@ -33,10 +33,11 @@ declare const DeleteRuleCommand_base: {
|
|
|
33
33
|
* <p>If you call delete rule multiple times for the same rule, all calls will succeed. When you
|
|
34
34
|
* call delete rule for a non-existent custom eventbus, <code>ResourceNotFoundException</code> is
|
|
35
35
|
* returned.</p>
|
|
36
|
-
* <p>Managed rules are rules created and managed by another Amazon Web Services service on your
|
|
37
|
-
* rules are created by those other Amazon Web Services services to support
|
|
38
|
-
* can delete these rules using the <code>Force</code>
|
|
39
|
-
* are sure the other service is not still using that
|
|
36
|
+
* <p>Managed rules are rules created and managed by another Amazon Web Services service on your
|
|
37
|
+
* behalf. These rules are created by those other Amazon Web Services services to support
|
|
38
|
+
* functionality in those services. You can delete these rules using the <code>Force</code>
|
|
39
|
+
* option, but you should do so only if you are sure the other service is not still using that
|
|
40
|
+
* rule.</p>
|
|
40
41
|
* @example
|
|
41
42
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
43
|
* ```javascript
|
|
@@ -67,8 +68,8 @@ declare const DeleteRuleCommand_base: {
|
|
|
67
68
|
* <p>This exception occurs due to unexpected causes.</p>
|
|
68
69
|
*
|
|
69
70
|
* @throws {@link ManagedRuleException} (client fault)
|
|
70
|
-
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
71
|
-
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
71
|
+
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
72
|
+
* managed by that service. If you see this error in response to <code>DeleteRule</code> or
|
|
72
73
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
73
74
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
74
75
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
@@ -26,7 +26,12 @@ declare const DescribeEndpointCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Get the information about an existing global endpoint. For more information about global
|
|
29
|
+
* <p>Get the information about an existing global endpoint. For more information about global
|
|
30
|
+
* endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications
|
|
31
|
+
* Regional-fault tolerant with global endpoints and event replication</a> in the
|
|
32
|
+
* <i>
|
|
33
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
34
|
+
* </i>.</p>
|
|
30
35
|
* @example
|
|
31
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
37
|
* ```javascript
|
|
@@ -26,10 +26,9 @@ declare const DescribeEventBusCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Displays details about an event bus in your account. This can include the external Amazon Web Services
|
|
30
|
-
*
|
|
31
|
-
* policy
|
|
32
|
-
* state, and creation time.</p>
|
|
29
|
+
* <p>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
|
|
30
|
+
* associated policy. For custom event buses and partner event buses, it displays the name, ARN,
|
|
31
|
+
* policy, state, and creation time.</p>
|
|
33
32
|
* <p> To enable your account to receive events from other accounts on its default event bus,
|
|
34
33
|
* use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html">PutPermission</a>.</p>
|
|
35
34
|
* <p>For more information about partner event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
|
|
@@ -47,7 +46,14 @@ declare const DescribeEventBusCommand_base: {
|
|
|
47
46
|
* // { // DescribeEventBusResponse
|
|
48
47
|
* // Name: "STRING_VALUE",
|
|
49
48
|
* // Arn: "STRING_VALUE",
|
|
49
|
+
* // Description: "STRING_VALUE",
|
|
50
|
+
* // KmsKeyIdentifier: "STRING_VALUE",
|
|
51
|
+
* // DeadLetterConfig: { // DeadLetterConfig
|
|
52
|
+
* // Arn: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
50
54
|
* // Policy: "STRING_VALUE",
|
|
55
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
56
|
+
* // LastModifiedTime: new Date("TIMESTAMP"),
|
|
51
57
|
* // };
|
|
52
58
|
*
|
|
53
59
|
* ```
|
|
@@ -27,9 +27,8 @@ declare const DescribePartnerEventSourceCommand_base: {
|
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
29
|
* <p>An SaaS partner can use this operation to list details about a partner event source that
|
|
30
|
-
* they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html">DescribeEventSource</a>
|
|
31
|
-
*
|
|
32
|
-
* shared with them.</p>
|
|
30
|
+
* they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html">DescribeEventSource</a> to see details about a partner event source that is shared with
|
|
31
|
+
* them.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -59,8 +59,8 @@ declare const DisableRuleCommand_base: {
|
|
|
59
59
|
* <p>This exception occurs due to unexpected causes.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ManagedRuleException} (client fault)
|
|
62
|
-
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
63
|
-
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
62
|
+
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
63
|
+
* managed by that service. If you see this error in response to <code>DeleteRule</code> or
|
|
64
64
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
65
65
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
66
66
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
@@ -58,8 +58,8 @@ declare const EnableRuleCommand_base: {
|
|
|
58
58
|
* <p>This exception occurs due to unexpected causes.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ManagedRuleException} (client fault)
|
|
61
|
-
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
62
|
-
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
61
|
+
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
62
|
+
* managed by that service. If you see this error in response to <code>DeleteRule</code> or
|
|
63
63
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
64
64
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
65
65
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
@@ -26,7 +26,12 @@ declare const ListEndpointsCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>List the global endpoints associated with this account. For more information about global
|
|
29
|
+
* <p>List the global endpoints associated with this account. For more information about global
|
|
30
|
+
* endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications
|
|
31
|
+
* Regional-fault tolerant with global endpoints and event replication</a> in the
|
|
32
|
+
* <i>
|
|
33
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
34
|
+
* </i>.</p>
|
|
30
35
|
* @example
|
|
31
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
37
|
* ```javascript
|
|
@@ -46,7 +46,10 @@ declare const ListEventBusesCommand_base: {
|
|
|
46
46
|
* // { // EventBus
|
|
47
47
|
* // Name: "STRING_VALUE",
|
|
48
48
|
* // Arn: "STRING_VALUE",
|
|
49
|
+
* // Description: "STRING_VALUE",
|
|
49
50
|
* // Policy: "STRING_VALUE",
|
|
51
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
52
|
+
* // LastModifiedTime: new Date("TIMESTAMP"),
|
|
50
53
|
* // },
|
|
51
54
|
* // ],
|
|
52
55
|
* // NextToken: "STRING_VALUE",
|
|
@@ -26,8 +26,8 @@ declare const ListEventSourcesCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>You can use this to see all the partner event sources that have been shared with your
|
|
30
|
-
*
|
|
29
|
+
* <p>You can use this to see all the partner event sources that have been shared with your
|
|
30
|
+
* Amazon Web Services account. For more information about partner event sources, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -26,9 +26,8 @@ declare const ListPartnerEventSourceAccountsCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>An SaaS partner can use this operation to display the Amazon Web Services account ID that a
|
|
30
|
-
* partner event source name is associated with. This operation is not used by Amazon Web Services
|
|
31
|
-
* customers.</p>
|
|
29
|
+
* <p>An SaaS partner can use this operation to display the Amazon Web Services account ID that a
|
|
30
|
+
* particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -26,8 +26,8 @@ declare const ListRulesCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can
|
|
30
|
-
* a prefix to match to the rule names.</p>
|
|
29
|
+
* <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can
|
|
30
|
+
* provide a prefix to match to the rule names.</p>
|
|
31
31
|
* <p>The maximum number of results per page for requests is 100.</p>
|
|
32
32
|
* <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
|
|
33
33
|
* use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
|
|
@@ -27,13 +27,16 @@ declare const PutEventsCommand_base: {
|
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
29
|
* <p>Sends custom events to Amazon EventBridge so that they can be matched to rules.</p>
|
|
30
|
-
* <p>The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including
|
|
31
|
-
*
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html">Calculating PutEvents event entry
|
|
30
|
+
* <p>The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including
|
|
31
|
+
* the event and any necessary characters and keys of the JSON representation of the event. To
|
|
32
|
+
* learn more, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html">Calculating PutEvents event entry
|
|
33
|
+
* size</a> in the <i>
|
|
34
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
35
|
+
* </i>
|
|
33
36
|
* </p>
|
|
34
|
-
* <p>PutEvents accepts the data in JSON format. For the JSON number
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
+
* <p>PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the
|
|
38
|
+
* constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of
|
|
39
|
+
* 9,223,372,036,854,775,807.</p>
|
|
37
40
|
* <note>
|
|
38
41
|
* <p>PutEvents will only process nested JSON up to 1100 levels deep.</p>
|
|
39
42
|
* </note>
|
|
@@ -26,11 +26,9 @@ declare const PutPartnerEventsCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html">Calculating EventBridge PutEvents event entry size</a>
|
|
33
|
-
* in the <i>EventBridge User Guide</i>.</p>
|
|
29
|
+
* <p>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.</p>
|
|
30
|
+
* <p>For information on calculating event batch size, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html">Calculating EventBridge PutEvents event
|
|
31
|
+
* entry size</a> in the <i>EventBridge User Guide</i>.</p>
|
|
34
32
|
* @example
|
|
35
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
34
|
* ```javascript
|
|
@@ -26,22 +26,22 @@ declare const PutPermissionCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Running <code>PutPermission</code> permits the specified Amazon Web Services account or
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* account. </p>
|
|
29
|
+
* <p>Running <code>PutPermission</code> permits the specified Amazon Web Services account or
|
|
30
|
+
* Amazon Web Services organization to put events to the specified <i>event
|
|
31
|
+
* bus</i>. Amazon EventBridge (CloudWatch Events) rules in your account are
|
|
32
|
+
* triggered by these events arriving to an event bus in your account. </p>
|
|
33
33
|
* <p>For another account to send events to your account, that external account must have an
|
|
34
34
|
* EventBridge rule with your account's event bus as a target.</p>
|
|
35
35
|
* <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run
|
|
36
36
|
* <code>PutPermission</code> once for each of these accounts. Or, if all the accounts are
|
|
37
|
-
* members of the same Amazon Web Services organization, you can run <code>PutPermission</code>
|
|
38
|
-
*
|
|
39
|
-
*
|
|
37
|
+
* members of the same Amazon Web Services organization, you can run <code>PutPermission</code>
|
|
38
|
+
* once specifying <code>Principal</code> as "*" and specifying the Amazon Web Services
|
|
39
|
+
* organization ID in <code>Condition</code>, to grant permissions to all accounts in that
|
|
40
|
+
* organization.</p>
|
|
40
41
|
* <p>If you grant permissions using an organization, then accounts in that organization must
|
|
41
42
|
* specify a <code>RoleArn</code> with proper permissions when they use <code>PutTarget</code> to
|
|
42
43
|
* add your account's event bus as a target. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
|
|
43
|
-
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
|
|
44
|
-
* Guide</i>.</p>
|
|
44
|
+
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
45
45
|
* <p>The permission policy on the event bus cannot exceed 10 KB in size.</p>
|
|
46
46
|
* @example
|
|
47
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -28,11 +28,10 @@ declare const PutRuleCommand_base: {
|
|
|
28
28
|
/**
|
|
29
29
|
* <p>Creates or updates the specified rule. Rules are enabled by default, or based on value of
|
|
30
30
|
* the state. You can disable a rule using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html">DisableRule</a>.</p>
|
|
31
|
-
* <p>A single rule watches for events from a single event bus. Events generated by Amazon Web Services services
|
|
32
|
-
* go to
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* bus that you have created. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
|
|
31
|
+
* <p>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
|
|
32
|
+
* services or applications go to the matching partner event bus. If you have custom applications
|
|
33
|
+
* or services, you can specify whether their events go to your default event bus or a custom
|
|
34
|
+
* event bus that you have created. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
|
|
36
35
|
* <p>If you are updating an existing rule, the rule is replaced with what you specify in this
|
|
37
36
|
* <code>PutRule</code> command. If you omit arguments in <code>PutRule</code>, the old values
|
|
38
37
|
* for those arguments are not kept. Instead, they are replaced with null values.</p>
|
|
@@ -50,10 +49,10 @@ declare const PutRuleCommand_base: {
|
|
|
50
49
|
* <code>events:PutRule</code> and <code>events:TagResource</code> permissions.</p>
|
|
51
50
|
* <p>If you are updating an existing rule, any tags you specify in the <code>PutRule</code>
|
|
52
51
|
* operation are ignored. To update the tags of an existing rule, use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html">TagResource</a> and <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
53
|
-
* <p>Most services in Amazon Web Services treat : or / as the same character in Amazon Resource
|
|
54
|
-
* However, EventBridge uses an exact match in event patterns and rules. Be sure to
|
|
55
|
-
* correct ARN characters when creating event patterns so that they match the ARN syntax
|
|
56
|
-
* event you want to match.</p>
|
|
52
|
+
* <p>Most services in Amazon Web Services treat : or / as the same character in Amazon Resource
|
|
53
|
+
* Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to
|
|
54
|
+
* use the correct ARN characters when creating event patterns so that they match the ARN syntax
|
|
55
|
+
* in the event you want to match.</p>
|
|
57
56
|
* <p>In EventBridge, it is possible to create rules that lead to infinite loops, where a rule
|
|
58
57
|
* is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,
|
|
59
58
|
* and trigger software to change them to the desired state. If the rule is not written
|
|
@@ -115,8 +114,8 @@ declare const PutRuleCommand_base: {
|
|
|
115
114
|
* quota.</p>
|
|
116
115
|
*
|
|
117
116
|
* @throws {@link ManagedRuleException} (client fault)
|
|
118
|
-
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
119
|
-
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
117
|
+
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
118
|
+
* managed by that service. If you see this error in response to <code>DeleteRule</code> or
|
|
120
119
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
121
120
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
122
121
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
@@ -34,7 +34,9 @@ declare const PutTargetsCommand_base: {
|
|
|
34
34
|
* <p>Each rule can have up to five (5) targets associated with it at one time.</p>
|
|
35
35
|
* </note>
|
|
36
36
|
* <p>For a list of services you can configure as targets for events, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html">EventBridge targets</a>
|
|
37
|
-
* in the <i>
|
|
37
|
+
* in the <i>
|
|
38
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
39
|
+
* </i>.</p>
|
|
38
40
|
* <p>Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
|
|
39
41
|
* built-in targets are:</p>
|
|
40
42
|
* <ul>
|
|
@@ -55,54 +57,52 @@ declare const PutTargetsCommand_base: {
|
|
|
55
57
|
* </li>
|
|
56
58
|
* <li>
|
|
57
59
|
* <p>
|
|
58
|
-
* <code>Amazon EC2 TerminateInstances API
|
|
59
|
-
* call</code>
|
|
60
|
+
* <code>Amazon EC2 TerminateInstances API call</code>
|
|
60
61
|
* </p>
|
|
61
62
|
* </li>
|
|
62
63
|
* </ul>
|
|
63
64
|
* <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the
|
|
64
|
-
* target is a Kinesis data stream, you can optionally specify which shard the event
|
|
65
|
-
* using the <code>KinesisParameters</code> argument. To invoke a command on multiple
|
|
66
|
-
* instances with one rule, you can use the <code>RunCommandParameters</code> field.</p>
|
|
65
|
+
* target is a Kinesis data stream, you can optionally specify which shard the event
|
|
66
|
+
* goes to by using the <code>KinesisParameters</code> argument. To invoke a command on multiple
|
|
67
|
+
* EC2 instances with one rule, you can use the <code>RunCommandParameters</code> field.</p>
|
|
67
68
|
* <p>To be able to make API calls against the resources that you own, Amazon EventBridge
|
|
68
|
-
* needs the appropriate permissions:
|
|
69
|
-
* </p>
|
|
69
|
+
* needs the appropriate permissions: </p>
|
|
70
70
|
* <ul>
|
|
71
71
|
* <li>
|
|
72
|
-
* <p>For Lambda and Amazon SNS
|
|
73
|
-
*
|
|
72
|
+
* <p>For Lambda and Amazon SNS resources, EventBridge relies
|
|
73
|
+
* on resource-based policies.</p>
|
|
74
74
|
* </li>
|
|
75
75
|
* <li>
|
|
76
|
-
* <p>For EC2 instances, Kinesis Data Streams,
|
|
77
|
-
*
|
|
78
|
-
*
|
|
76
|
+
* <p>For EC2 instances, Kinesis Data Streams, Step Functions state machines and
|
|
77
|
+
* API Gateway APIs, EventBridge relies on IAM roles that you specify in the
|
|
78
|
+
* <code>RoleARN</code> argument in <code>PutTargets</code>.</p>
|
|
79
79
|
* </li>
|
|
80
80
|
* </ul>
|
|
81
81
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html">Authentication
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
82
|
+
* and Access Control</a> in the <i>
|
|
83
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
84
|
+
* </i>.</p>
|
|
85
|
+
* <p>If another Amazon Web Services account is in the same region and has granted you permission
|
|
86
|
+
* (using <code>PutPermission</code>), you can send events to that account. Set that account's
|
|
87
|
+
* event bus as a target of the rules in your account. To send the matched events to the other
|
|
88
|
+
* account, specify that account's event bus as the <code>Arn</code> value when you run
|
|
87
89
|
* <code>PutTargets</code>. If your account sends events to another account, your account is
|
|
88
90
|
* charged for each sent event. Each event sent to another account is charged as a custom event.
|
|
89
|
-
* The account receiving the event is not charged. For more information, see <a href="http://aws.amazon.com/eventbridge/pricing/">Amazon EventBridge
|
|
90
|
-
* Pricing</a>.</p>
|
|
91
|
+
* The account receiving the event is not charged. For more information, see <a href="http://aws.amazon.com/eventbridge/pricing/">Amazon EventBridge Pricing</a>.</p>
|
|
91
92
|
* <note>
|
|
92
93
|
* <p>
|
|
93
94
|
* <code>Input</code>, <code>InputPath</code>, and <code>InputTransformer</code> are not
|
|
94
|
-
* available with <code>PutTarget</code> if the target is an event bus of a different Amazon Web Services
|
|
95
|
-
* account.</p>
|
|
95
|
+
* available with <code>PutTarget</code> if the target is an event bus of a different Amazon Web Services account.</p>
|
|
96
96
|
* </note>
|
|
97
97
|
* <p>If you are setting the event bus of another account as the target, and that account
|
|
98
98
|
* granted permission to your account through an organization instead of directly by the account
|
|
99
99
|
* ID, then you must specify a <code>RoleArn</code> with proper permissions in the
|
|
100
100
|
* <code>Target</code> structure. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
|
|
101
|
-
*
|
|
102
|
-
* Guide</i>.</p>
|
|
101
|
+
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
103
102
|
* <note>
|
|
104
|
-
* <p>If you have an IAM role on a cross-account event bus target,
|
|
105
|
-
*
|
|
103
|
+
* <p>If you have an IAM role on a cross-account event bus target, a <code>PutTargets</code>
|
|
104
|
+
* call without a role on the same target (same <code>Id</code> and <code>Arn</code>) will not
|
|
105
|
+
* remove the role.</p>
|
|
106
106
|
* </note>
|
|
107
107
|
* <p>For more information about enabling cross-account events, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html">PutPermission</a>.</p>
|
|
108
108
|
* <p>
|
|
@@ -309,8 +309,8 @@ declare const PutTargetsCommand_base: {
|
|
|
309
309
|
* quota.</p>
|
|
310
310
|
*
|
|
311
311
|
* @throws {@link ManagedRuleException} (client fault)
|
|
312
|
-
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
313
|
-
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
312
|
+
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
313
|
+
* managed by that service. If you see this error in response to <code>DeleteRule</code> or
|
|
314
314
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
315
315
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
316
316
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
@@ -26,10 +26,10 @@ declare const RemovePermissionCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Revokes the permission of another Amazon Web Services account to be able to put events to
|
|
30
|
-
* event bus. Specify the account to revoke by the <code>StatementId</code> value
|
|
31
|
-
* associated with the account when you granted it permission with
|
|
32
|
-
*
|
|
29
|
+
* <p>Revokes the permission of another Amazon Web Services account to be able to put events to
|
|
30
|
+
* the specified event bus. Specify the account to revoke by the <code>StatementId</code> value
|
|
31
|
+
* that you associated with the account when you granted it permission with
|
|
32
|
+
* <code>PutPermission</code>. You can find the <code>StatementId</code> by using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html">DescribeEventBus</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -29,7 +29,8 @@ declare const RemoveTargetsCommand_base: {
|
|
|
29
29
|
* <p>Removes the specified targets from the specified rule. When the rule is triggered, those
|
|
30
30
|
* targets are no longer be invoked.</p>
|
|
31
31
|
* <note>
|
|
32
|
-
* <p>A successful execution of <code>RemoveTargets</code> doesn't guarantee all targets are
|
|
32
|
+
* <p>A successful execution of <code>RemoveTargets</code> doesn't guarantee all targets are
|
|
33
|
+
* removed from the rule, it means that the target(s) listed in the request are removed.</p>
|
|
33
34
|
* </note>
|
|
34
35
|
* <p>When you remove a target, when the associated rule triggers, removed targets might
|
|
35
36
|
* continue to be invoked. Allow a short period of time for changes to take effect.</p>
|
|
@@ -79,8 +80,8 @@ declare const RemoveTargetsCommand_base: {
|
|
|
79
80
|
* <p>This exception occurs due to unexpected causes.</p>
|
|
80
81
|
*
|
|
81
82
|
* @throws {@link ManagedRuleException} (client fault)
|
|
82
|
-
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
83
|
-
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
83
|
+
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
84
|
+
* managed by that service. If you see this error in response to <code>DeleteRule</code> or
|
|
84
85
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
85
86
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
86
87
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
@@ -30,8 +30,8 @@ declare const TagResourceCommand_base: {
|
|
|
30
30
|
* help you organize and categorize your resources. You can also use them to scope user
|
|
31
31
|
* permissions by granting a user permission to access or change only resources with certain tag
|
|
32
32
|
* values. In EventBridge, rules and event buses can be tagged.</p>
|
|
33
|
-
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as
|
|
34
|
-
* characters.</p>
|
|
33
|
+
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as
|
|
34
|
+
* strings of characters.</p>
|
|
35
35
|
* <p>You can use the <code>TagResource</code> action with a resource that already has tags. If
|
|
36
36
|
* you specify a new tag key, this tag is appended to the list of tags associated with the
|
|
37
37
|
* resource. If you specify a tag key that is already associated with the resource, the new tag
|
|
@@ -71,8 +71,8 @@ declare const TagResourceCommand_base: {
|
|
|
71
71
|
* <p>This exception occurs due to unexpected causes.</p>
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link ManagedRuleException} (client fault)
|
|
74
|
-
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
75
|
-
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
74
|
+
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
75
|
+
* managed by that service. If you see this error in response to <code>DeleteRule</code> or
|
|
76
76
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
77
77
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
78
78
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
@@ -27,10 +27,10 @@ declare const TestEventPatternCommand_base: {
|
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
29
|
* <p>Tests whether the specified event pattern matches the provided event.</p>
|
|
30
|
-
* <p>Most services in Amazon Web Services treat : or / as the same character in Amazon Resource
|
|
31
|
-
* However, EventBridge uses an exact match in event patterns and rules. Be
|
|
32
|
-
* correct ARN characters when creating event patterns so that they match the ARN
|
|
33
|
-
* event you want to match.</p>
|
|
30
|
+
* <p>Most services in Amazon Web Services treat : or / as the same character in Amazon Resource
|
|
31
|
+
* Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be
|
|
32
|
+
* sure to use the correct ARN characters when creating event patterns so that they match the ARN
|
|
33
|
+
* syntax in the event you want to match.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
36
|
* ```javascript
|
|
@@ -59,8 +59,8 @@ declare const UntagResourceCommand_base: {
|
|
|
59
59
|
* <p>This exception occurs due to unexpected causes.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ManagedRuleException} (client fault)
|
|
62
|
-
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
63
|
-
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
62
|
+
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
63
|
+
* managed by that service. If you see this error in response to <code>DeleteRule</code> or
|
|
64
64
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
65
65
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
66
66
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
@@ -26,7 +26,11 @@ declare const UpdateEndpointCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Update an existing endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making
|
|
29
|
+
* <p>Update an existing endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making
|
|
30
|
+
* applications Regional-fault tolerant with global endpoints and event replication</a> in
|
|
31
|
+
* the <i>
|
|
32
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
33
|
+
* </i>.</p>
|
|
30
34
|
* @example
|
|
31
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
36
|
* ```javascript
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
|
|
4
|
+
import { UpdateEventBusRequest, UpdateEventBusResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link UpdateEventBusCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface UpdateEventBusCommandInput extends UpdateEventBusRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link UpdateEventBusCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface UpdateEventBusCommandOutput extends UpdateEventBusResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const UpdateEventBusCommand_base: {
|
|
24
|
+
new (input: UpdateEventBusCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateEventBusCommandInput, UpdateEventBusCommandOutput, EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [UpdateEventBusCommandInput]): import("@smithy/smithy-client").CommandImpl<UpdateEventBusCommandInput, UpdateEventBusCommandOutput, EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Updates the specified event bus.</p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { EventBridgeClient, UpdateEventBusCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import
|
|
34
|
+
* // const { EventBridgeClient, UpdateEventBusCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import
|
|
35
|
+
* const client = new EventBridgeClient(config);
|
|
36
|
+
* const input = { // UpdateEventBusRequest
|
|
37
|
+
* Name: "STRING_VALUE",
|
|
38
|
+
* KmsKeyIdentifier: "STRING_VALUE",
|
|
39
|
+
* Description: "STRING_VALUE",
|
|
40
|
+
* DeadLetterConfig: { // DeadLetterConfig
|
|
41
|
+
* Arn: "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* };
|
|
44
|
+
* const command = new UpdateEventBusCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // UpdateEventBusResponse
|
|
47
|
+
* // Arn: "STRING_VALUE",
|
|
48
|
+
* // Name: "STRING_VALUE",
|
|
49
|
+
* // KmsKeyIdentifier: "STRING_VALUE",
|
|
50
|
+
* // Description: "STRING_VALUE",
|
|
51
|
+
* // DeadLetterConfig: { // DeadLetterConfig
|
|
52
|
+
* // Arn: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param UpdateEventBusCommandInput - {@link UpdateEventBusCommandInput}
|
|
59
|
+
* @returns {@link UpdateEventBusCommandOutput}
|
|
60
|
+
* @see {@link UpdateEventBusCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link UpdateEventBusCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ConcurrentModificationException} (client fault)
|
|
65
|
+
* <p>There is concurrent modification on a rule, target, archive, or replay.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalException} (server fault)
|
|
68
|
+
* <p>This exception occurs due to unexpected causes.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link OperationDisabledException} (client fault)
|
|
71
|
+
* <p>The operation you are attempting is not available in this region.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>An entity that you specified does not exist.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link EventBridgeServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from EventBridge service.</p>
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare class UpdateEventBusCommand extends UpdateEventBusCommand_base {
|
|
82
|
+
}
|