@aws-sdk/client-eventbridge 3.258.0 → 3.259.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/dist-cjs/endpoint/ruleset.js +2 -2
- package/dist-es/endpoint/ruleset.js +2 -2
- package/dist-types/EventBridge.d.ts +4 -33
- package/dist-types/commands/DeleteRuleCommand.d.ts +0 -3
- package/dist-types/commands/DisableRuleCommand.d.ts +0 -1
- package/dist-types/commands/EnableRuleCommand.d.ts +0 -1
- package/dist-types/commands/ListRulesCommand.d.ts +0 -1
- package/dist-types/commands/PutPermissionCommand.d.ts +0 -3
- package/dist-types/commands/PutRuleCommand.d.ts +0 -7
- package/dist-types/commands/PutTargetsCommand.d.ts +4 -14
- package/dist-types/commands/RemoveTargetsCommand.d.ts +0 -3
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +36 -31
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +8 -8
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
4
|
const B = "required", C = "type", D = "fn", E = "argv", F = "ref";
|
|
5
|
-
const a =
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
5
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "isSet", g = "booleanEquals", h = "endpoint", i = "error", j = "stringEquals", k = { [B]: true, "default": false, [C]: "Boolean" }, l = { [B]: false, [C]: c }, m = { [F]: "Region" }, n = { [F]: "EndpointId" }, o = { [F]: "UseFIPS" }, p = { [F]: "Endpoint" }, q = { "authSchemes": [{ "name": "sigv4a", "signingName": "events", "signingRegionSet": ["*"] }] }, r = {}, s = { [D]: g, [E]: [{ [F]: "UseDualStack" }, true] }, t = { [D]: g, [E]: [true, { [D]: "getAttr", [E]: [{ [F]: d }, "supportsDualStack"] }] }, u = { [i]: "DualStack is enabled but this partition does not support DualStack", [C]: i }, v = { [D]: g, [E]: [o, true] }, w = { [D]: g, [E]: [true, { [D]: "getAttr", [E]: [{ [F]: d }, "supportsFIPS"] }] }, x = [{ [D]: f, [E]: [p] }], y = [s], z = [t], A = [v];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: { [B]: a, [C]: c }, UseDualStack: k, UseFIPS: k, Endpoint: l, EndpointId: l }, rules: [{ conditions: [{ [D]: "aws.partition", [E]: [m], assign: d }], [C]: e, rules: [{ conditions: [{ [D]: f, [E]: [n] }], [C]: e, rules: [{ conditions: [{ [D]: "isValidHostLabel", [E]: [n, a] }], [C]: e, rules: [{ [C]: e, rules: [{ conditions: [{ [D]: g, [E]: [o, b] }], [C]: e, rules: [{ [C]: e, rules: [{ conditions: x, endpoint: { url: p, properties: q, headers: r }, [C]: h }, { conditions: y, [C]: e, rules: [{ conditions: z, [C]: e, rules: [{ endpoint: { url: "https://{EndpointId}.endpoint.events.{PartitionResult#dualStackDnsSuffix}", properties: q, headers: r }, [C]: h }] }, u] }, { endpoint: { url: "https://{EndpointId}.endpoint.events.{PartitionResult#dnsSuffix}", properties: q, headers: r }, [C]: h }] }] }, { error: "Invalid Configuration: FIPS is not supported with EventBridge multi-region endpoints.", [C]: i }] }] }, { error: "EndpointId must be a valid host label.", [C]: i }] }, { conditions: x, [C]: e, rules: [{ conditions: A, error: "Invalid Configuration: FIPS and custom endpoint are not supported", [C]: i }, { [C]: e, rules: [{ conditions: y, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", [C]: i }, { endpoint: { url: p, properties: r, headers: r }, [C]: h }] }] }, { conditions: [v, s], [C]: e, rules: [{ conditions: [w, t], [C]: e, rules: [{ endpoint: { url: "https://events-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, [C]: h }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", [C]: i }] }, { conditions: A, [C]: e, rules: [{ conditions: [w], [C]: e, rules: [{ [C]: e, rules: [{ conditions: [{ [D]: j, [E]: [m, "us-gov-east-1"] }], endpoint: { url: "https://events.us-gov-east-1.amazonaws.com", properties: r, headers: r }, [C]: h }, { conditions: [{ [D]: j, [E]: [m, "us-gov-west-1"] }], endpoint: { url: "https://events.us-gov-west-1.amazonaws.com", properties: r, headers: r }, [C]: h }, { endpoint: { url: "https://events-fips.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, [C]: h }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", [C]: i }] }, { conditions: y, [C]: e, rules: [{ conditions: z, [C]: e, rules: [{ endpoint: { url: "https://events.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, [C]: h }] }, u] }, { endpoint: { url: "https://events.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, [C]: h }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
const B = "required", C = "type", D = "fn", E = "argv", F = "ref";
|
|
2
|
-
const a =
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
2
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "isSet", g = "booleanEquals", h = "endpoint", i = "error", j = "stringEquals", k = { [B]: true, "default": false, [C]: "Boolean" }, l = { [B]: false, [C]: c }, m = { [F]: "Region" }, n = { [F]: "EndpointId" }, o = { [F]: "UseFIPS" }, p = { [F]: "Endpoint" }, q = { "authSchemes": [{ "name": "sigv4a", "signingName": "events", "signingRegionSet": ["*"] }] }, r = {}, s = { [D]: g, [E]: [{ [F]: "UseDualStack" }, true] }, t = { [D]: g, [E]: [true, { [D]: "getAttr", [E]: [{ [F]: d }, "supportsDualStack"] }] }, u = { [i]: "DualStack is enabled but this partition does not support DualStack", [C]: i }, v = { [D]: g, [E]: [o, true] }, w = { [D]: g, [E]: [true, { [D]: "getAttr", [E]: [{ [F]: d }, "supportsFIPS"] }] }, x = [{ [D]: f, [E]: [p] }], y = [s], z = [t], A = [v];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: { [B]: a, [C]: c }, UseDualStack: k, UseFIPS: k, Endpoint: l, EndpointId: l }, rules: [{ conditions: [{ [D]: "aws.partition", [E]: [m], assign: d }], [C]: e, rules: [{ conditions: [{ [D]: f, [E]: [n] }], [C]: e, rules: [{ conditions: [{ [D]: "isValidHostLabel", [E]: [n, a] }], [C]: e, rules: [{ [C]: e, rules: [{ conditions: [{ [D]: g, [E]: [o, b] }], [C]: e, rules: [{ [C]: e, rules: [{ conditions: x, endpoint: { url: p, properties: q, headers: r }, [C]: h }, { conditions: y, [C]: e, rules: [{ conditions: z, [C]: e, rules: [{ endpoint: { url: "https://{EndpointId}.endpoint.events.{PartitionResult#dualStackDnsSuffix}", properties: q, headers: r }, [C]: h }] }, u] }, { endpoint: { url: "https://{EndpointId}.endpoint.events.{PartitionResult#dnsSuffix}", properties: q, headers: r }, [C]: h }] }] }, { error: "Invalid Configuration: FIPS is not supported with EventBridge multi-region endpoints.", [C]: i }] }] }, { error: "EndpointId must be a valid host label.", [C]: i }] }, { conditions: x, [C]: e, rules: [{ conditions: A, error: "Invalid Configuration: FIPS and custom endpoint are not supported", [C]: i }, { [C]: e, rules: [{ conditions: y, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", [C]: i }, { endpoint: { url: p, properties: r, headers: r }, [C]: h }] }] }, { conditions: [v, s], [C]: e, rules: [{ conditions: [w, t], [C]: e, rules: [{ endpoint: { url: "https://events-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, [C]: h }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", [C]: i }] }, { conditions: A, [C]: e, rules: [{ conditions: [w], [C]: e, rules: [{ [C]: e, rules: [{ conditions: [{ [D]: j, [E]: [m, "us-gov-east-1"] }], endpoint: { url: "https://events.us-gov-east-1.amazonaws.com", properties: r, headers: r }, [C]: h }, { conditions: [{ [D]: j, [E]: [m, "us-gov-west-1"] }], endpoint: { url: "https://events.us-gov-west-1.amazonaws.com", properties: r, headers: r }, [C]: h }, { endpoint: { url: "https://events-fips.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, [C]: h }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", [C]: i }] }, { conditions: y, [C]: e, rules: [{ conditions: z, [C]: e, rules: [{ endpoint: { url: "https://events.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, [C]: h }] }, u] }, { endpoint: { url: "https://events.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, [C]: h }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -223,14 +223,11 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
223
223
|
/**
|
|
224
224
|
* <p>Deletes the specified rule.</p>
|
|
225
225
|
* <p>Before you can delete the rule, you must remove all targets, using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html">RemoveTargets</a>.</p>
|
|
226
|
-
*
|
|
227
226
|
* <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow
|
|
228
227
|
* a short period of time for changes to take effect.</p>
|
|
229
|
-
*
|
|
230
228
|
* <p>If you call delete rule multiple times for the same rule, all calls will succeed. When you
|
|
231
229
|
* call delete rule for a non-existent custom eventbus, <code>ResourceNotFoundException</code> is
|
|
232
230
|
* returned.</p>
|
|
233
|
-
*
|
|
234
231
|
* <p>Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These
|
|
235
232
|
* rules are created by those other Amazon Web Services services to support functionality in those services. You
|
|
236
233
|
* can delete these rules using the <code>Force</code> option, but you should do so only if you
|
|
@@ -316,7 +313,6 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
316
313
|
/**
|
|
317
314
|
* <p>Disables the specified rule. A disabled rule won't match any events, and won't
|
|
318
315
|
* self-trigger if it has a schedule expression.</p>
|
|
319
|
-
*
|
|
320
316
|
* <p>When you disable a rule, incoming events might continue to match to the disabled rule.
|
|
321
317
|
* Allow a short period of time for changes to take effect.</p>
|
|
322
318
|
*/
|
|
@@ -325,7 +321,6 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
325
321
|
disableRule(args: DisableRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableRuleCommandOutput) => void): void;
|
|
326
322
|
/**
|
|
327
323
|
* <p>Enables the specified rule. If the rule does not exist, the operation fails.</p>
|
|
328
|
-
*
|
|
329
324
|
* <p>When you enable a rule, incoming events might not immediately start matching to a newly
|
|
330
325
|
* enabled rule. Allow a short period of time for changes to take effect.</p>
|
|
331
326
|
*/
|
|
@@ -403,7 +398,6 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
403
398
|
/**
|
|
404
399
|
* <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide
|
|
405
400
|
* a prefix to match to the rule names.</p>
|
|
406
|
-
*
|
|
407
401
|
* <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
|
|
408
402
|
* use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
|
|
409
403
|
*/
|
|
@@ -446,19 +440,16 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
446
440
|
* account. </p>
|
|
447
441
|
* <p>For another account to send events to your account, that external account must have an
|
|
448
442
|
* EventBridge rule with your account's event bus as a target.</p>
|
|
449
|
-
*
|
|
450
443
|
* <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run
|
|
451
444
|
* <code>PutPermission</code> once for each of these accounts. Or, if all the accounts are
|
|
452
445
|
* members of the same Amazon Web Services organization, you can run <code>PutPermission</code> once specifying
|
|
453
446
|
* <code>Principal</code> as "*" and specifying the Amazon Web Services organization ID in
|
|
454
447
|
* <code>Condition</code>, to grant permissions to all accounts in that organization.</p>
|
|
455
|
-
*
|
|
456
448
|
* <p>If you grant permissions using an organization, then accounts in that organization must
|
|
457
449
|
* specify a <code>RoleArn</code> with proper permissions when they use <code>PutTarget</code> to
|
|
458
450
|
* 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
|
|
459
451
|
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
|
|
460
452
|
* Guide</i>.</p>
|
|
461
|
-
*
|
|
462
453
|
* <p>The permission policy on the event bus cannot exceed 10 KB in size.</p>
|
|
463
454
|
*/
|
|
464
455
|
putPermission(args: PutPermissionCommandInput, options?: __HttpHandlerOptions): Promise<PutPermissionCommandOutput>;
|
|
@@ -467,26 +458,21 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
467
458
|
/**
|
|
468
459
|
* <p>Creates or updates the specified rule. Rules are enabled by default, or based on value of
|
|
469
460
|
* the state. You can disable a rule using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html">DisableRule</a>.</p>
|
|
470
|
-
*
|
|
471
461
|
* <p>A single rule watches for events from a single event bus. Events generated by Amazon Web Services services
|
|
472
462
|
* go to your account's default event bus. Events generated by SaaS partner services or
|
|
473
463
|
* applications go to the matching partner event bus. If you have custom applications or
|
|
474
464
|
* services, you can specify whether their events go to your default event bus or a custom event
|
|
475
465
|
* 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>
|
|
476
|
-
*
|
|
477
466
|
* <p>If you are updating an existing rule, the rule is replaced with what you specify in this
|
|
478
467
|
* <code>PutRule</code> command. If you omit arguments in <code>PutRule</code>, the old values
|
|
479
468
|
* for those arguments are not kept. Instead, they are replaced with null values.</p>
|
|
480
|
-
*
|
|
481
469
|
* <p>When you create or update a rule, incoming events might not immediately start matching to
|
|
482
470
|
* new or updated rules. Allow a short period of time for changes to take effect.</p>
|
|
483
|
-
*
|
|
484
471
|
* <p>A rule must contain at least an EventPattern or ScheduleExpression. Rules with
|
|
485
472
|
* EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions
|
|
486
473
|
* self-trigger based on the given schedule. A rule can have both an EventPattern and a
|
|
487
474
|
* ScheduleExpression, in which case the rule triggers on matching events as well as on a
|
|
488
475
|
* schedule.</p>
|
|
489
|
-
*
|
|
490
476
|
* <p>When you initially create a rule, you can optionally assign one or more tags to the rule.
|
|
491
477
|
* Tags can help you organize and categorize your resources. You can also use them to scope user
|
|
492
478
|
* permissions, by granting a user permission to access or change only rules with certain tag
|
|
@@ -494,12 +480,10 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
494
480
|
* <code>events:PutRule</code> and <code>events:TagResource</code> permissions.</p>
|
|
495
481
|
* <p>If you are updating an existing rule, any tags you specify in the <code>PutRule</code>
|
|
496
482
|
* 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>
|
|
497
|
-
*
|
|
498
483
|
* <p>Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).
|
|
499
484
|
* However, EventBridge uses an exact match in event patterns and rules. Be sure to use the
|
|
500
485
|
* correct ARN characters when creating event patterns so that they match the ARN syntax in the
|
|
501
486
|
* event you want to match.</p>
|
|
502
|
-
*
|
|
503
487
|
* <p>In EventBridge, it is possible to create rules that lead to infinite loops, where a rule
|
|
504
488
|
* is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,
|
|
505
489
|
* and trigger software to change them to the desired state. If the rule is not written
|
|
@@ -524,7 +508,6 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
524
508
|
* <p>Each rule can have up to five (5) targets associated with it at one time.</p>
|
|
525
509
|
* </note>
|
|
526
510
|
* <p>You can configure the following as targets for Events:</p>
|
|
527
|
-
*
|
|
528
511
|
* <ul>
|
|
529
512
|
* <li>
|
|
530
513
|
* <p>
|
|
@@ -602,6 +585,9 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
602
585
|
* <p>Redshift cluster</p>
|
|
603
586
|
* </li>
|
|
604
587
|
* <li>
|
|
588
|
+
* <p>Redshift Serverless workgroup</p>
|
|
589
|
+
* </li>
|
|
590
|
+
* <li>
|
|
605
591
|
* <p>SageMaker Pipeline</p>
|
|
606
592
|
* </li>
|
|
607
593
|
* <li>
|
|
@@ -623,25 +609,21 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
623
609
|
* <p>Systems Manager Run Command</p>
|
|
624
610
|
* </li>
|
|
625
611
|
* </ul>
|
|
626
|
-
*
|
|
627
612
|
* <p>Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
|
|
628
613
|
* built-in targets are <code>EC2 CreateSnapshot API call</code>, <code>EC2 RebootInstances API
|
|
629
614
|
* call</code>, <code>EC2 StopInstances API call</code>, and <code>EC2 TerminateInstances API
|
|
630
615
|
* call</code>. </p>
|
|
631
|
-
*
|
|
632
616
|
* <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the
|
|
633
617
|
* target is a Kinesis data stream, you can optionally specify which shard the event goes to by
|
|
634
618
|
* using the <code>KinesisParameters</code> argument. To invoke a command on multiple EC2
|
|
635
619
|
* instances with one rule, you can use the <code>RunCommandParameters</code> field.</p>
|
|
636
|
-
*
|
|
637
620
|
* <p>To be able to make API calls against the resources that you own, Amazon EventBridge
|
|
638
621
|
* needs the appropriate permissions. For Lambda and Amazon SNS
|
|
639
622
|
* resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams,
|
|
640
|
-
* Step Functions state machines and API Gateway
|
|
623
|
+
* Step Functions state machines and API Gateway APIs, EventBridge relies on
|
|
641
624
|
* IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>.
|
|
642
625
|
* For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html">Authentication
|
|
643
626
|
* and Access Control</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
644
|
-
*
|
|
645
627
|
* <p>If another Amazon Web Services account is in the same region and has granted you permission (using
|
|
646
628
|
* <code>PutPermission</code>), you can send events to that account. Set that account's event
|
|
647
629
|
* bus as a target of the rules in your account. To send the matched events to the other account,
|
|
@@ -650,28 +632,23 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
650
632
|
* charged for each sent event. Each event sent to another account is charged as a custom event.
|
|
651
633
|
* The account receiving the event is not charged. For more information, see <a href="http://aws.amazon.com/eventbridge/pricing/">Amazon EventBridge
|
|
652
634
|
* Pricing</a>.</p>
|
|
653
|
-
*
|
|
654
635
|
* <note>
|
|
655
636
|
* <p>
|
|
656
637
|
* <code>Input</code>, <code>InputPath</code>, and <code>InputTransformer</code> are not
|
|
657
638
|
* available with <code>PutTarget</code> if the target is an event bus of a different Amazon Web Services
|
|
658
639
|
* account.</p>
|
|
659
640
|
* </note>
|
|
660
|
-
*
|
|
661
641
|
* <p>If you are setting the event bus of another account as the target, and that account
|
|
662
642
|
* granted permission to your account through an organization instead of directly by the account
|
|
663
643
|
* ID, then you must specify a <code>RoleArn</code> with proper permissions in the
|
|
664
644
|
* <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
|
|
665
645
|
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
|
|
666
646
|
* Guide</i>.</p>
|
|
667
|
-
*
|
|
668
647
|
* <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>
|
|
669
|
-
*
|
|
670
648
|
* <p>
|
|
671
649
|
* <b>Input</b>, <b>InputPath</b>, and
|
|
672
650
|
* <b>InputTransformer</b> are mutually exclusive and optional
|
|
673
651
|
* parameters of a target. When a rule is triggered due to a matched event:</p>
|
|
674
|
-
*
|
|
675
652
|
* <ul>
|
|
676
653
|
* <li>
|
|
677
654
|
* <p>If none of the following arguments are specified for a target, then the entire event
|
|
@@ -694,14 +671,11 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
694
671
|
* specify as the input to the target.</p>
|
|
695
672
|
* </li>
|
|
696
673
|
* </ul>
|
|
697
|
-
*
|
|
698
674
|
* <p>When you specify <code>InputPath</code> or <code>InputTransformer</code>, you must use
|
|
699
675
|
* JSON dot notation, not bracket notation.</p>
|
|
700
|
-
*
|
|
701
676
|
* <p>When you add targets to a rule and the associated rule triggers soon after, new or updated
|
|
702
677
|
* targets might not be immediately invoked. Allow a short period of time for changes to take
|
|
703
678
|
* effect.</p>
|
|
704
|
-
*
|
|
705
679
|
* <p>This action can partially fail if too many requests are made at the same time. If that
|
|
706
680
|
* happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in
|
|
707
681
|
* <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>
|
|
@@ -721,14 +695,11 @@ export declare class EventBridge extends EventBridgeClient {
|
|
|
721
695
|
/**
|
|
722
696
|
* <p>Removes the specified targets from the specified rule. When the rule is triggered, those
|
|
723
697
|
* targets are no longer be invoked.</p>
|
|
724
|
-
*
|
|
725
698
|
* <note>
|
|
726
699
|
* <p>A successful execution of <code>RemoveTargets</code> doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.</p>
|
|
727
700
|
* </note>
|
|
728
|
-
*
|
|
729
701
|
* <p>When you remove a target, when the associated rule triggers, removed targets might
|
|
730
702
|
* continue to be invoked. Allow a short period of time for changes to take effect.</p>
|
|
731
|
-
*
|
|
732
703
|
* <p>This action can partially fail if too many requests are made at the same time. If that
|
|
733
704
|
* happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in
|
|
734
705
|
* <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>
|
|
@@ -10,14 +10,11 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified rule.</p>
|
|
12
12
|
* <p>Before you can delete the rule, you must remove all targets, using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html">RemoveTargets</a>.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow
|
|
15
14
|
* a short period of time for changes to take effect.</p>
|
|
16
|
-
*
|
|
17
15
|
* <p>If you call delete rule multiple times for the same rule, all calls will succeed. When you
|
|
18
16
|
* call delete rule for a non-existent custom eventbus, <code>ResourceNotFoundException</code> is
|
|
19
17
|
* returned.</p>
|
|
20
|
-
*
|
|
21
18
|
* <p>Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These
|
|
22
19
|
* rules are created by those other Amazon Web Services services to support functionality in those services. You
|
|
23
20
|
* can delete these rules using the <code>Force</code> option, but you should do so only if you
|
|
@@ -10,7 +10,6 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Disables the specified rule. A disabled rule won't match any events, and won't
|
|
12
12
|
* self-trigger if it has a schedule expression.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>When you disable a rule, incoming events might continue to match to the disabled rule.
|
|
15
14
|
* Allow a short period of time for changes to take effect.</p>
|
|
16
15
|
* @example
|
|
@@ -9,7 +9,6 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Enables the specified rule. If the rule does not exist, the operation fails.</p>
|
|
12
|
-
*
|
|
13
12
|
* <p>When you enable a rule, incoming events might not immediately start matching to a newly
|
|
14
13
|
* enabled rule. Allow a short period of time for changes to take effect.</p>
|
|
15
14
|
* @example
|
|
@@ -10,7 +10,6 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide
|
|
12
12
|
* a prefix to match to the rule names.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
|
|
15
14
|
* use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
|
|
16
15
|
* @example
|
|
@@ -14,19 +14,16 @@ export interface PutPermissionCommandOutput extends __MetadataBearer {
|
|
|
14
14
|
* account. </p>
|
|
15
15
|
* <p>For another account to send events to your account, that external account must have an
|
|
16
16
|
* EventBridge rule with your account's event bus as a target.</p>
|
|
17
|
-
*
|
|
18
17
|
* <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run
|
|
19
18
|
* <code>PutPermission</code> once for each of these accounts. Or, if all the accounts are
|
|
20
19
|
* members of the same Amazon Web Services organization, you can run <code>PutPermission</code> once specifying
|
|
21
20
|
* <code>Principal</code> as "*" and specifying the Amazon Web Services organization ID in
|
|
22
21
|
* <code>Condition</code>, to grant permissions to all accounts in that organization.</p>
|
|
23
|
-
*
|
|
24
22
|
* <p>If you grant permissions using an organization, then accounts in that organization must
|
|
25
23
|
* specify a <code>RoleArn</code> with proper permissions when they use <code>PutTarget</code> to
|
|
26
24
|
* 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
|
|
27
25
|
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
|
|
28
26
|
* Guide</i>.</p>
|
|
29
|
-
*
|
|
30
27
|
* <p>The permission policy on the event bus cannot exceed 10 KB in size.</p>
|
|
31
28
|
* @example
|
|
32
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,26 +10,21 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates or updates the specified rule. Rules are enabled by default, or based on value of
|
|
12
12
|
* the state. You can disable a rule using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html">DisableRule</a>.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>A single rule watches for events from a single event bus. Events generated by Amazon Web Services services
|
|
15
14
|
* go to your account's default event bus. Events generated by SaaS partner services or
|
|
16
15
|
* applications go to the matching partner event bus. If you have custom applications or
|
|
17
16
|
* services, you can specify whether their events go to your default event bus or a custom event
|
|
18
17
|
* 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>
|
|
19
|
-
*
|
|
20
18
|
* <p>If you are updating an existing rule, the rule is replaced with what you specify in this
|
|
21
19
|
* <code>PutRule</code> command. If you omit arguments in <code>PutRule</code>, the old values
|
|
22
20
|
* for those arguments are not kept. Instead, they are replaced with null values.</p>
|
|
23
|
-
*
|
|
24
21
|
* <p>When you create or update a rule, incoming events might not immediately start matching to
|
|
25
22
|
* new or updated rules. Allow a short period of time for changes to take effect.</p>
|
|
26
|
-
*
|
|
27
23
|
* <p>A rule must contain at least an EventPattern or ScheduleExpression. Rules with
|
|
28
24
|
* EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions
|
|
29
25
|
* self-trigger based on the given schedule. A rule can have both an EventPattern and a
|
|
30
26
|
* ScheduleExpression, in which case the rule triggers on matching events as well as on a
|
|
31
27
|
* schedule.</p>
|
|
32
|
-
*
|
|
33
28
|
* <p>When you initially create a rule, you can optionally assign one or more tags to the rule.
|
|
34
29
|
* Tags can help you organize and categorize your resources. You can also use them to scope user
|
|
35
30
|
* permissions, by granting a user permission to access or change only rules with certain tag
|
|
@@ -37,12 +32,10 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer
|
|
|
37
32
|
* <code>events:PutRule</code> and <code>events:TagResource</code> permissions.</p>
|
|
38
33
|
* <p>If you are updating an existing rule, any tags you specify in the <code>PutRule</code>
|
|
39
34
|
* 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>
|
|
40
|
-
*
|
|
41
35
|
* <p>Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).
|
|
42
36
|
* However, EventBridge uses an exact match in event patterns and rules. Be sure to use the
|
|
43
37
|
* correct ARN characters when creating event patterns so that they match the ARN syntax in the
|
|
44
38
|
* event you want to match.</p>
|
|
45
|
-
*
|
|
46
39
|
* <p>In EventBridge, it is possible to create rules that lead to infinite loops, where a rule
|
|
47
40
|
* is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,
|
|
48
41
|
* and trigger software to change them to the desired state. If the rule is not written
|
|
@@ -15,7 +15,6 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
|
|
|
15
15
|
* <p>Each rule can have up to five (5) targets associated with it at one time.</p>
|
|
16
16
|
* </note>
|
|
17
17
|
* <p>You can configure the following as targets for Events:</p>
|
|
18
|
-
*
|
|
19
18
|
* <ul>
|
|
20
19
|
* <li>
|
|
21
20
|
* <p>
|
|
@@ -93,6 +92,9 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
|
|
|
93
92
|
* <p>Redshift cluster</p>
|
|
94
93
|
* </li>
|
|
95
94
|
* <li>
|
|
95
|
+
* <p>Redshift Serverless workgroup</p>
|
|
96
|
+
* </li>
|
|
97
|
+
* <li>
|
|
96
98
|
* <p>SageMaker Pipeline</p>
|
|
97
99
|
* </li>
|
|
98
100
|
* <li>
|
|
@@ -114,25 +116,21 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
|
|
|
114
116
|
* <p>Systems Manager Run Command</p>
|
|
115
117
|
* </li>
|
|
116
118
|
* </ul>
|
|
117
|
-
*
|
|
118
119
|
* <p>Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
|
|
119
120
|
* built-in targets are <code>EC2 CreateSnapshot API call</code>, <code>EC2 RebootInstances API
|
|
120
121
|
* call</code>, <code>EC2 StopInstances API call</code>, and <code>EC2 TerminateInstances API
|
|
121
122
|
* call</code>. </p>
|
|
122
|
-
*
|
|
123
123
|
* <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the
|
|
124
124
|
* target is a Kinesis data stream, you can optionally specify which shard the event goes to by
|
|
125
125
|
* using the <code>KinesisParameters</code> argument. To invoke a command on multiple EC2
|
|
126
126
|
* instances with one rule, you can use the <code>RunCommandParameters</code> field.</p>
|
|
127
|
-
*
|
|
128
127
|
* <p>To be able to make API calls against the resources that you own, Amazon EventBridge
|
|
129
128
|
* needs the appropriate permissions. For Lambda and Amazon SNS
|
|
130
129
|
* resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams,
|
|
131
|
-
* Step Functions state machines and API Gateway
|
|
130
|
+
* Step Functions state machines and API Gateway APIs, EventBridge relies on
|
|
132
131
|
* IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>.
|
|
133
132
|
* For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html">Authentication
|
|
134
133
|
* and Access Control</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
135
|
-
*
|
|
136
134
|
* <p>If another Amazon Web Services account is in the same region and has granted you permission (using
|
|
137
135
|
* <code>PutPermission</code>), you can send events to that account. Set that account's event
|
|
138
136
|
* bus as a target of the rules in your account. To send the matched events to the other account,
|
|
@@ -141,28 +139,23 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
|
|
|
141
139
|
* charged for each sent event. Each event sent to another account is charged as a custom event.
|
|
142
140
|
* The account receiving the event is not charged. For more information, see <a href="http://aws.amazon.com/eventbridge/pricing/">Amazon EventBridge
|
|
143
141
|
* Pricing</a>.</p>
|
|
144
|
-
*
|
|
145
142
|
* <note>
|
|
146
143
|
* <p>
|
|
147
144
|
* <code>Input</code>, <code>InputPath</code>, and <code>InputTransformer</code> are not
|
|
148
145
|
* available with <code>PutTarget</code> if the target is an event bus of a different Amazon Web Services
|
|
149
146
|
* account.</p>
|
|
150
147
|
* </note>
|
|
151
|
-
*
|
|
152
148
|
* <p>If you are setting the event bus of another account as the target, and that account
|
|
153
149
|
* granted permission to your account through an organization instead of directly by the account
|
|
154
150
|
* ID, then you must specify a <code>RoleArn</code> with proper permissions in the
|
|
155
151
|
* <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
|
|
156
152
|
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
|
|
157
153
|
* Guide</i>.</p>
|
|
158
|
-
*
|
|
159
154
|
* <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>
|
|
160
|
-
*
|
|
161
155
|
* <p>
|
|
162
156
|
* <b>Input</b>, <b>InputPath</b>, and
|
|
163
157
|
* <b>InputTransformer</b> are mutually exclusive and optional
|
|
164
158
|
* parameters of a target. When a rule is triggered due to a matched event:</p>
|
|
165
|
-
*
|
|
166
159
|
* <ul>
|
|
167
160
|
* <li>
|
|
168
161
|
* <p>If none of the following arguments are specified for a target, then the entire event
|
|
@@ -185,14 +178,11 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
|
|
|
185
178
|
* specify as the input to the target.</p>
|
|
186
179
|
* </li>
|
|
187
180
|
* </ul>
|
|
188
|
-
*
|
|
189
181
|
* <p>When you specify <code>InputPath</code> or <code>InputTransformer</code>, you must use
|
|
190
182
|
* JSON dot notation, not bracket notation.</p>
|
|
191
|
-
*
|
|
192
183
|
* <p>When you add targets to a rule and the associated rule triggers soon after, new or updated
|
|
193
184
|
* targets might not be immediately invoked. Allow a short period of time for changes to take
|
|
194
185
|
* effect.</p>
|
|
195
|
-
*
|
|
196
186
|
* <p>This action can partially fail if too many requests are made at the same time. If that
|
|
197
187
|
* happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in
|
|
198
188
|
* <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>
|
|
@@ -10,14 +10,11 @@ export interface RemoveTargetsCommandOutput extends RemoveTargetsResponse, __Met
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes the specified targets from the specified rule. When the rule is triggered, those
|
|
12
12
|
* targets are no longer be invoked.</p>
|
|
13
|
-
*
|
|
14
13
|
* <note>
|
|
15
14
|
* <p>A successful execution of <code>RemoveTargets</code> doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.</p>
|
|
16
15
|
* </note>
|
|
17
|
-
*
|
|
18
16
|
* <p>When you remove a target, when the associated rule triggers, removed targets might
|
|
19
17
|
* continue to be invoked. Allow a short period of time for changes to take effect.</p>
|
|
20
|
-
*
|
|
21
18
|
* <p>This action can partially fail if too many requests are made at the same time. If that
|
|
22
19
|
* happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in
|
|
23
20
|
* <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|
|
@@ -509,6 +509,9 @@ export interface CreateConnectionRequest {
|
|
|
509
509
|
Description?: string;
|
|
510
510
|
/**
|
|
511
511
|
* <p>The type of authorization to use for the connection.</p>
|
|
512
|
+
* <note>
|
|
513
|
+
* <p>OAUTH tokens are refreshed when a 401 or 407 response is returned.</p>
|
|
514
|
+
* </note>
|
|
512
515
|
*/
|
|
513
516
|
AuthorizationType: ConnectionAuthorizationType | string | undefined;
|
|
514
517
|
/**
|
|
@@ -620,7 +623,8 @@ export interface CreateEndpointRequest {
|
|
|
620
623
|
*/
|
|
621
624
|
RoutingConfig: RoutingConfig | undefined;
|
|
622
625
|
/**
|
|
623
|
-
* <p>Enable or disable event replication
|
|
626
|
+
* <p>Enable or disable event replication. The default state is <code>ENABLED</code> which means you must supply a <code>RoleArn</code>. If you don't have a
|
|
627
|
+
* <code>RoleArn</code> or you don't want event replication enabled, set the state to <code>DISABLED</code>.</p>
|
|
624
628
|
*/
|
|
625
629
|
ReplicationConfig?: ReplicationConfig;
|
|
626
630
|
/**
|
|
@@ -692,11 +696,10 @@ export interface Tag {
|
|
|
692
696
|
export interface CreateEventBusRequest {
|
|
693
697
|
/**
|
|
694
698
|
* <p>The name of the new event bus. </p>
|
|
695
|
-
* <p>
|
|
696
|
-
* <code>default</code> for a custom event bus, as this name is already used for your account's
|
|
697
|
-
* default event bus.</p>
|
|
698
|
-
* <p>If this is a partner event bus, the name must exactly match the name of the partner event
|
|
699
|
+
* <p>Custom event bus names can't contain the <code>/</code> character, but you can use the <code>/</code> character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event
|
|
699
700
|
* source that this event bus is matched to.</p>
|
|
701
|
+
* <p>You can't use the name <code>default</code> for a custom event bus, as this name is already used for your account's
|
|
702
|
+
* default event bus.</p>
|
|
700
703
|
*/
|
|
701
704
|
Name: string | undefined;
|
|
702
705
|
/**
|
|
@@ -1511,6 +1514,9 @@ export interface Connection {
|
|
|
1511
1514
|
StateReason?: string;
|
|
1512
1515
|
/**
|
|
1513
1516
|
* <p>The authorization type specified for the connection.</p>
|
|
1517
|
+
* <note>
|
|
1518
|
+
* <p>OAUTH tokens are refreshed when a 401 or 407 response is returned.</p>
|
|
1519
|
+
* </note>
|
|
1514
1520
|
*/
|
|
1515
1521
|
AuthorizationType?: ConnectionAuthorizationType | string;
|
|
1516
1522
|
/**
|
|
@@ -1546,7 +1552,7 @@ export interface ListEndpointsRequest {
|
|
|
1546
1552
|
*/
|
|
1547
1553
|
HomeRegion?: string;
|
|
1548
1554
|
/**
|
|
1549
|
-
* <p>If <code>nextToken</code> is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
|
|
1555
|
+
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
1550
1556
|
* Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
|
|
1551
1557
|
* token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.</p>
|
|
1552
1558
|
*/
|
|
@@ -1557,7 +1563,7 @@ export interface ListEndpointsRequest {
|
|
|
1557
1563
|
MaxResults?: number;
|
|
1558
1564
|
}
|
|
1559
1565
|
/**
|
|
1560
|
-
* <p>
|
|
1566
|
+
* <p>A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide.</p>
|
|
1561
1567
|
*/
|
|
1562
1568
|
export interface Endpoint {
|
|
1563
1569
|
/**
|
|
@@ -1577,7 +1583,8 @@ export interface Endpoint {
|
|
|
1577
1583
|
*/
|
|
1578
1584
|
RoutingConfig?: RoutingConfig;
|
|
1579
1585
|
/**
|
|
1580
|
-
* <p>Whether event replication was enabled or disabled for this endpoint
|
|
1586
|
+
* <p>Whether event replication was enabled or disabled for this endpoint. The default state is <code>ENABLED</code> which means you must supply a <code>RoleArn</code>.
|
|
1587
|
+
* If you don't have a <code>RoleArn</code> or you don't want event replication enabled, set the state to <code>DISABLED</code>.</p>
|
|
1581
1588
|
*/
|
|
1582
1589
|
ReplicationConfig?: ReplicationConfig;
|
|
1583
1590
|
/**
|
|
@@ -1589,7 +1596,7 @@ export interface Endpoint {
|
|
|
1589
1596
|
*/
|
|
1590
1597
|
RoleArn?: string;
|
|
1591
1598
|
/**
|
|
1592
|
-
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
|
|
1599
|
+
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
|
|
1593
1600
|
*/
|
|
1594
1601
|
EndpointId?: string;
|
|
1595
1602
|
/**
|
|
@@ -1619,7 +1626,7 @@ export interface ListEndpointsResponse {
|
|
|
1619
1626
|
*/
|
|
1620
1627
|
Endpoints?: Endpoint[];
|
|
1621
1628
|
/**
|
|
1622
|
-
* <p>If <code>nextToken</code> is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
|
|
1629
|
+
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
1623
1630
|
* Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
|
|
1624
1631
|
* token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.</p>
|
|
1625
1632
|
*/
|
|
@@ -1643,8 +1650,8 @@ export interface ListEventBusesRequest {
|
|
|
1643
1650
|
Limit?: number;
|
|
1644
1651
|
}
|
|
1645
1652
|
/**
|
|
1646
|
-
* <p>An event bus receives events from a source and routes them to
|
|
1647
|
-
*
|
|
1653
|
+
* <p>An event bus receives events from a source, uses rules to evaluate them, applies any configured input transformation, and routes them to the appropriate target(s).
|
|
1654
|
+
* Your account's default event bus receives events from Amazon Web Services services. A custom event
|
|
1648
1655
|
* bus can receive events from your custom applications and services. A partner event bus
|
|
1649
1656
|
* receives events from an event source created by an SaaS partner. These events come from the
|
|
1650
1657
|
* partners services or applications.</p>
|
|
@@ -2311,25 +2318,25 @@ export interface EcsParameters {
|
|
|
2311
2318
|
Tags?: Tag[];
|
|
2312
2319
|
}
|
|
2313
2320
|
/**
|
|
2314
|
-
* <p>These are custom parameter to be used when the target is an API Gateway
|
|
2321
|
+
* <p>These are custom parameter to be used when the target is an API Gateway APIs or
|
|
2315
2322
|
* EventBridge ApiDestinations. In the latter case, these are merged with any
|
|
2316
2323
|
* InvocationParameters specified on the Connection, with any values from the Connection taking
|
|
2317
2324
|
* precedence.</p>
|
|
2318
2325
|
*/
|
|
2319
2326
|
export interface HttpParameters {
|
|
2320
2327
|
/**
|
|
2321
|
-
* <p>The path parameter values to be used to populate API Gateway
|
|
2328
|
+
* <p>The path parameter values to be used to populate API Gateway API or EventBridge
|
|
2322
2329
|
* ApiDestination path wildcards ("*").</p>
|
|
2323
2330
|
*/
|
|
2324
2331
|
PathParameterValues?: string[];
|
|
2325
2332
|
/**
|
|
2326
|
-
* <p>The headers that need to be sent as part of request invoking the API Gateway
|
|
2333
|
+
* <p>The headers that need to be sent as part of request invoking the API Gateway API or
|
|
2327
2334
|
* EventBridge ApiDestination.</p>
|
|
2328
2335
|
*/
|
|
2329
2336
|
HeaderParameters?: Record<string, string>;
|
|
2330
2337
|
/**
|
|
2331
2338
|
* <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
|
|
2332
|
-
*
|
|
2339
|
+
* API or EventBridge ApiDestination.</p>
|
|
2333
2340
|
*/
|
|
2334
2341
|
QueryStringParameters?: Record<string, string>;
|
|
2335
2342
|
}
|
|
@@ -2352,9 +2359,8 @@ export interface InputTransformer {
|
|
|
2352
2359
|
/**
|
|
2353
2360
|
* <p>Input template where you specify placeholders that will be filled with the values of the
|
|
2354
2361
|
* keys from <code>InputPathsMap</code> to customize the data sent to the target. Enclose each
|
|
2355
|
-
* <code>InputPathsMaps</code> value in brackets: <<i>value</i>>
|
|
2356
|
-
*
|
|
2357
|
-
*
|
|
2362
|
+
* <code>InputPathsMaps</code> value in brackets: <<i>value</i>>
|
|
2363
|
+
* </p>
|
|
2358
2364
|
* <p>If <code>InputTemplate</code> is a JSON object (surrounded by curly braces), the following
|
|
2359
2365
|
* restrictions apply:</p>
|
|
2360
2366
|
* <ul>
|
|
@@ -2435,7 +2441,7 @@ export interface KinesisParameters {
|
|
|
2435
2441
|
PartitionKeyPath: string | undefined;
|
|
2436
2442
|
}
|
|
2437
2443
|
/**
|
|
2438
|
-
* <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
|
|
2444
|
+
* <p>These are custom parameters to be used when the target is a Amazon Redshift cluster or Redshift Serverless workgroup to invoke the
|
|
2439
2445
|
* Amazon Redshift Data API ExecuteStatement based on EventBridge events.</p>
|
|
2440
2446
|
*/
|
|
2441
2447
|
export interface RedshiftDataParameters {
|
|
@@ -2450,6 +2456,7 @@ export interface RedshiftDataParameters {
|
|
|
2450
2456
|
Database: string | undefined;
|
|
2451
2457
|
/**
|
|
2452
2458
|
* <p>The database user name. Required when authenticating using temporary credentials.</p>
|
|
2459
|
+
* <p>Do not provide this parameter when connecting to a Redshift Serverless workgroup.</p>
|
|
2453
2460
|
*/
|
|
2454
2461
|
DbUser?: string;
|
|
2455
2462
|
/**
|
|
@@ -2551,7 +2558,6 @@ export interface SqsParameters {
|
|
|
2551
2558
|
/**
|
|
2552
2559
|
* <p>Targets are the resources to be invoked when a rule is triggered. For a complete list of
|
|
2553
2560
|
* services and resources that can be set as a target, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html">PutTargets</a>.</p>
|
|
2554
|
-
*
|
|
2555
2561
|
* <p>If you are setting the event bus of another account as the target, and that account
|
|
2556
2562
|
* granted permission to your account through an organization instead of directly by the account
|
|
2557
2563
|
* ID, then you must specify a <code>RoleArn</code> with proper permissions in the
|
|
@@ -2582,7 +2588,7 @@ export interface Target {
|
|
|
2582
2588
|
Input?: string;
|
|
2583
2589
|
/**
|
|
2584
2590
|
* <p>The value of the JSONPath that is used for extracting part of the matched event when
|
|
2585
|
-
* passing it to the target. You
|
|
2591
|
+
* passing it to the target. You may use JSON dot notation or bracket notation. For more
|
|
2586
2592
|
* information about JSON paths, see <a href="http://goessner.net/articles/JsonPath/">JSONPath</a>.</p>
|
|
2587
2593
|
*/
|
|
2588
2594
|
InputPath?: string;
|
|
@@ -2622,9 +2628,9 @@ export interface Target {
|
|
|
2622
2628
|
*/
|
|
2623
2629
|
SqsParameters?: SqsParameters;
|
|
2624
2630
|
/**
|
|
2625
|
-
* <p>Contains the HTTP parameters to use when the target is a API Gateway
|
|
2631
|
+
* <p>Contains the HTTP parameters to use when the target is a API Gateway endpoint or
|
|
2626
2632
|
* EventBridge ApiDestination.</p>
|
|
2627
|
-
* <p>If you specify an API Gateway
|
|
2633
|
+
* <p>If you specify an API Gateway API or EventBridge ApiDestination as a target, you can
|
|
2628
2634
|
* use this parameter to specify headers, path parameters, and query string keys/values as part
|
|
2629
2635
|
* of your target invoking request. If you're using ApiDestinations, the corresponding Connection
|
|
2630
2636
|
* can also have these values configured. In case of any conflicting keys, values from the
|
|
@@ -2685,7 +2691,7 @@ export interface PutEventsRequestEntry {
|
|
|
2685
2691
|
*/
|
|
2686
2692
|
Resources?: string[];
|
|
2687
2693
|
/**
|
|
2688
|
-
* <p>Free-form string used to decide what fields to expect in the event detail.</p>
|
|
2694
|
+
* <p>Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
|
|
2689
2695
|
*/
|
|
2690
2696
|
DetailType?: string;
|
|
2691
2697
|
/**
|
|
@@ -2719,7 +2725,7 @@ export interface PutEventsRequest {
|
|
|
2719
2725
|
*/
|
|
2720
2726
|
Entries: PutEventsRequestEntry[] | undefined;
|
|
2721
2727
|
/**
|
|
2722
|
-
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
|
|
2728
|
+
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
|
|
2723
2729
|
* <important>
|
|
2724
2730
|
* <p>When using Java, you must include <code>auth-crt</code> on the class path.</p>
|
|
2725
2731
|
* </important>
|
|
@@ -2753,6 +2759,7 @@ export interface PutEventsResponse {
|
|
|
2753
2759
|
* <p>The successfully and unsuccessfully ingested events results. If the ingestion was
|
|
2754
2760
|
* successful, the entry has the event ID in it. Otherwise, you can use the error code and error
|
|
2755
2761
|
* message to identify the problem with the entry.</p>
|
|
2762
|
+
* <p>For each record, the index of the response element is the same as the index in the request array.</p>
|
|
2756
2763
|
*/
|
|
2757
2764
|
Entries?: PutEventsResultEntry[];
|
|
2758
2765
|
}
|
|
@@ -2774,7 +2781,7 @@ export interface PutPartnerEventsRequestEntry {
|
|
|
2774
2781
|
*/
|
|
2775
2782
|
Resources?: string[];
|
|
2776
2783
|
/**
|
|
2777
|
-
* <p>A free-form string used to decide what fields to expect in the event detail.</p>
|
|
2784
|
+
* <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
|
|
2778
2785
|
*/
|
|
2779
2786
|
DetailType?: string;
|
|
2780
2787
|
/**
|
|
@@ -2870,7 +2877,6 @@ export interface PutPermissionRequest {
|
|
|
2870
2877
|
/**
|
|
2871
2878
|
* <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event
|
|
2872
2879
|
* bus. Specify "*" to permit any account to put events to your default event bus.</p>
|
|
2873
|
-
*
|
|
2874
2880
|
* <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that
|
|
2875
2881
|
* may match undesirable events. To create more secure rules, make sure that the event pattern
|
|
2876
2882
|
* for each rule contains an <code>account</code> field with a specific account ID from which to
|
|
@@ -2895,7 +2901,6 @@ export interface PutPermissionRequest {
|
|
|
2895
2901
|
* <p>If you specify <code>Condition</code> with an Amazon Web Services organization ID, and specify "*" as the
|
|
2896
2902
|
* value for <code>Principal</code>, you grant permission to all the accounts in the named
|
|
2897
2903
|
* organization.</p>
|
|
2898
|
-
*
|
|
2899
2904
|
* <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>,
|
|
2900
2905
|
* <code>Key</code>, and <code>Value</code> fields.</p>
|
|
2901
2906
|
*/
|
|
@@ -2917,7 +2922,7 @@ export interface PutRuleRequest {
|
|
|
2917
2922
|
*/
|
|
2918
2923
|
ScheduleExpression?: string;
|
|
2919
2924
|
/**
|
|
2920
|
-
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
|
|
2925
|
+
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event
|
|
2921
2926
|
* patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2922
2927
|
*/
|
|
2923
2928
|
EventPattern?: string;
|
|
@@ -3410,7 +3415,7 @@ export interface UpdateEndpointRequest {
|
|
|
3410
3415
|
*/
|
|
3411
3416
|
Description?: string;
|
|
3412
3417
|
/**
|
|
3413
|
-
* <p>Configure the routing policy, including the health check and secondary Region
|
|
3418
|
+
* <p>Configure the routing policy, including the health check and secondary Region.</p>
|
|
3414
3419
|
*/
|
|
3415
3420
|
RoutingConfig?: RoutingConfig;
|
|
3416
3421
|
/**
|
|
@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
27
27
|
defaultSigningName: string;
|
|
28
28
|
};
|
|
29
29
|
export interface EndpointParameters extends __EndpointParameters {
|
|
30
|
-
Region
|
|
30
|
+
Region: string;
|
|
31
31
|
UseDualStack?: boolean;
|
|
32
32
|
UseFIPS?: boolean;
|
|
33
33
|
Endpoint?: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-eventbridge",
|
|
3
3
|
"description": "AWS SDK for JavaScript Eventbridge Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.259.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -22,9 +22,9 @@
|
|
|
22
22
|
"dependencies": {
|
|
23
23
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
24
24
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
25
|
-
"@aws-sdk/client-sts": "3.
|
|
26
|
-
"@aws-sdk/config-resolver": "3.
|
|
27
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
25
|
+
"@aws-sdk/client-sts": "3.259.0",
|
|
26
|
+
"@aws-sdk/config-resolver": "3.259.0",
|
|
27
|
+
"@aws-sdk/credential-provider-node": "3.259.0",
|
|
28
28
|
"@aws-sdk/fetch-http-handler": "3.257.0",
|
|
29
29
|
"@aws-sdk/hash-node": "3.257.0",
|
|
30
30
|
"@aws-sdk/invalid-dependency": "3.257.0",
|
|
@@ -33,12 +33,12 @@
|
|
|
33
33
|
"@aws-sdk/middleware-host-header": "3.257.0",
|
|
34
34
|
"@aws-sdk/middleware-logger": "3.257.0",
|
|
35
35
|
"@aws-sdk/middleware-recursion-detection": "3.257.0",
|
|
36
|
-
"@aws-sdk/middleware-retry": "3.
|
|
36
|
+
"@aws-sdk/middleware-retry": "3.259.0",
|
|
37
37
|
"@aws-sdk/middleware-serde": "3.257.0",
|
|
38
38
|
"@aws-sdk/middleware-signing": "3.257.0",
|
|
39
39
|
"@aws-sdk/middleware-stack": "3.257.0",
|
|
40
40
|
"@aws-sdk/middleware-user-agent": "3.257.0",
|
|
41
|
-
"@aws-sdk/node-config-provider": "3.
|
|
41
|
+
"@aws-sdk/node-config-provider": "3.259.0",
|
|
42
42
|
"@aws-sdk/node-http-handler": "3.257.0",
|
|
43
43
|
"@aws-sdk/protocol-http": "3.257.0",
|
|
44
44
|
"@aws-sdk/signature-v4-multi-region": "3.257.0",
|
|
@@ -49,11 +49,11 @@
|
|
|
49
49
|
"@aws-sdk/util-body-length-browser": "3.188.0",
|
|
50
50
|
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
51
51
|
"@aws-sdk/util-defaults-mode-browser": "3.257.0",
|
|
52
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
52
|
+
"@aws-sdk/util-defaults-mode-node": "3.259.0",
|
|
53
53
|
"@aws-sdk/util-endpoints": "3.257.0",
|
|
54
54
|
"@aws-sdk/util-retry": "3.257.0",
|
|
55
55
|
"@aws-sdk/util-user-agent-browser": "3.257.0",
|
|
56
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
56
|
+
"@aws-sdk/util-user-agent-node": "3.259.0",
|
|
57
57
|
"@aws-sdk/util-utf8": "3.254.0",
|
|
58
58
|
"tslib": "^2.3.1"
|
|
59
59
|
},
|