@aws-sdk/client-eventbridge 3.451.0 → 3.458.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/README.md +56 -56
  2. package/dist-cjs/models/models_0.js +1 -0
  3. package/dist-es/models/models_0.js +1 -0
  4. package/dist-types/commands/CreateApiDestinationCommand.d.ts +2 -0
  5. package/dist-types/commands/CreatePartnerEventSourceCommand.d.ts +21 -7
  6. package/dist-types/commands/DeleteEndpointCommand.d.ts +1 -1
  7. package/dist-types/commands/DescribeEndpointCommand.d.ts +1 -1
  8. package/dist-types/commands/DescribeRuleCommand.d.ts +1 -1
  9. package/dist-types/commands/ListEndpointsCommand.d.ts +1 -1
  10. package/dist-types/commands/ListRuleNamesByTargetCommand.d.ts +1 -0
  11. package/dist-types/commands/ListRulesCommand.d.ts +2 -1
  12. package/dist-types/commands/ListTargetsByRuleCommand.d.ts +1 -0
  13. package/dist-types/commands/PutEventsCommand.d.ts +7 -0
  14. package/dist-types/commands/PutPartnerEventsCommand.d.ts +3 -0
  15. package/dist-types/commands/PutRuleCommand.d.ts +1 -1
  16. package/dist-types/commands/PutTargetsCommand.d.ts +29 -94
  17. package/dist-types/commands/RemoveTargetsCommand.d.ts +1 -0
  18. package/dist-types/commands/UpdateEndpointCommand.d.ts +1 -1
  19. package/dist-types/models/models_0.d.ts +185 -18
  20. package/dist-types/ts3.4/models/models_0.d.ts +1 -0
  21. package/package.json +3 -3
package/dist-types/commands/CreatePartnerEventSourceCommand.d.ts CHANGED
@@ -39,13 +39,27 @@ export interface CreatePartnerEventSourceCommandOutput extends CreatePartnerEven
39
39
  * <i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i>
40
40
  * </code>
41
41
  * </p>
42
- * <p>
43
- * <i>partner_name</i> is determined during partner registration and identifies
44
- * the partner to Amazon Web Services customers. <i>event_namespace</i> is determined by the
45
- * partner and is a way for the partner to categorize their events.
46
- * <i>event_name</i> is determined by the partner, and should uniquely identify
47
- * an event-generating resource within the partner system. The combination of
48
- * <i>event_namespace</i> and <i>event_name</i> should help Amazon Web Services
42
+ * <ul>
43
+ * <li>
44
+ * <p>
45
+ * <i>partner_name</i> is determined during partner registration, and
46
+ * identifies the partner to Amazon Web Services customers. </p>
47
+ * </li>
48
+ * <li>
49
+ * <p>
50
+ * <i>event_namespace</i> is determined by the partner, and is a way for
51
+ * the partner to categorize their events.</p>
52
+ * </li>
53
+ * <li>
54
+ * <p>
55
+ * <i>event_name</i> is determined by the partner, and should uniquely identify
56
+ * an event-generating resource within the partner system. </p>
57
+ * <p>The <i>event_name</i> must be unique across all Amazon Web Services customers. This is because the event source is a shared resource
58
+ * between the partner and customer accounts, and each partner event source unique in the partner account.</p>
59
+ * </li>
60
+ * </ul>
61
+ * <p>The combination of
62
+ * <i>event_namespace</i> and <i>event_name</i> should help Amazon Web Services
49
63
  * customers decide whether to create an event bus to receive these events.</p>
50
64
  * @example
51
65
  * Use a bare-bones client and the command you need to make an API call.
package/dist-types/commands/DeleteEndpointCommand.d.ts CHANGED
@@ -23,7 +23,7 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Delete an existing global endpoint. 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>
26
+ * <p>Delete an existing global endpoint. 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 <i>Amazon EventBridge User Guide</i>.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
package/dist-types/commands/DescribeEndpointCommand.d.ts CHANGED
@@ -23,7 +23,7 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Get the information about an existing global endpoint. 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>
26
+ * <p>Get the information about an existing global endpoint. 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 <i>Amazon EventBridge User Guide</i>.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
package/dist-types/commands/DescribeRuleCommand.d.ts CHANGED
@@ -43,7 +43,7 @@ export interface DescribeRuleCommandOutput extends DescribeRuleResponse, __Metad
43
43
  * // Arn: "STRING_VALUE",
44
44
  * // EventPattern: "STRING_VALUE",
45
45
  * // ScheduleExpression: "STRING_VALUE",
46
- * // State: "ENABLED" || "DISABLED",
46
+ * // State: "ENABLED" || "DISABLED" || "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS",
47
47
  * // Description: "STRING_VALUE",
48
48
  * // RoleArn: "STRING_VALUE",
49
49
  * // ManagedBy: "STRING_VALUE",
package/dist-types/commands/ListEndpointsCommand.d.ts CHANGED
@@ -23,7 +23,7 @@ export interface ListEndpointsCommandOutput extends ListEndpointsResponse, __Met
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>List the global endpoints associated with this account. 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>
26
+ * <p>List the global endpoints associated with this account. 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 <i>Amazon EventBridge User Guide</i>.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
package/dist-types/commands/ListRuleNamesByTargetCommand.d.ts CHANGED
@@ -25,6 +25,7 @@ export interface ListRuleNamesByTargetCommandOutput extends ListRuleNamesByTarge
25
25
  * @public
26
26
  * <p>Lists the rules for the specified target. You can see which of the rules in Amazon
27
27
  * EventBridge can invoke a specific target in your account.</p>
28
+ * <p>The maximum number of results per page for requests is 100.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
30
31
  * ```javascript
package/dist-types/commands/ListRulesCommand.d.ts CHANGED
@@ -25,6 +25,7 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea
25
25
  * @public
26
26
  * <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide
27
27
  * a prefix to match to the rule names.</p>
28
+ * <p>The maximum number of results per page for requests is 100.</p>
28
29
  * <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
29
30
  * use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
30
31
  * @example
@@ -47,7 +48,7 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea
47
48
  * // Name: "STRING_VALUE",
48
49
  * // Arn: "STRING_VALUE",
49
50
  * // EventPattern: "STRING_VALUE",
50
- * // State: "ENABLED" || "DISABLED",
51
+ * // State: "ENABLED" || "DISABLED" || "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS",
51
52
  * // Description: "STRING_VALUE",
52
53
  * // ScheduleExpression: "STRING_VALUE",
53
54
  * // RoleArn: "STRING_VALUE",
package/dist-types/commands/ListTargetsByRuleCommand.d.ts CHANGED
@@ -24,6 +24,7 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the targets assigned to the specified rule.</p>
27
+ * <p>The maximum number of results per page for requests is 100.</p>
27
28
  * @example
28
29
  * Use a bare-bones client and the command you need to make an API call.
29
30
  * ```javascript
package/dist-types/commands/PutEventsCommand.d.ts CHANGED
@@ -24,6 +24,13 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea
24
24
  /**
25
25
  * @public
26
26
  * <p>Sends custom events to Amazon EventBridge so that they can be matched to rules.</p>
27
+ * <p>The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event.
28
+ * To learn more, see
29
+ * <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html">Calculating PutEvents event entry size</a> in the <i>Amazon EventBridge User Guide</i>
30
+ * </p>
31
+ * <p>PutEvents accepts the data in JSON format. For the JSON number
32
+ * (integer) data type, the constraints are: a minimum value of
33
+ * -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.</p>
27
34
  * <note>
28
35
  * <p>PutEvents will only process nested JSON up to 1100 levels deep.</p>
29
36
  * </note>
package/dist-types/commands/PutPartnerEventsCommand.d.ts CHANGED
@@ -25,6 +25,9 @@ export interface PutPartnerEventsCommandOutput extends PutPartnerEventsResponse,
25
25
  * @public
26
26
  * <p>This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services
27
27
  * customers do not use this operation.</p>
28
+ * <p>For information on calculating event batch size, see
29
+ * <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html">Calculating EventBridge PutEvents event entry size</a>
30
+ * in the <i>EventBridge User Guide</i>.</p>
28
31
  * @example
29
32
  * Use a bare-bones client and the command you need to make an API call.
30
33
  * ```javascript
package/dist-types/commands/PutRuleCommand.d.ts CHANGED
@@ -73,7 +73,7 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer
73
73
  * Name: "STRING_VALUE", // required
74
74
  * ScheduleExpression: "STRING_VALUE",
75
75
  * EventPattern: "STRING_VALUE",
76
- * State: "ENABLED" || "DISABLED",
76
+ * State: "ENABLED" || "DISABLED" || "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS",
77
77
  * Description: "STRING_VALUE",
78
78
  * RoleArn: "STRING_VALUE",
79
79
  * Tags: [ // TagList
package/dist-types/commands/PutTargetsCommand.d.ts CHANGED
@@ -26,126 +26,57 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
26
26
  * <p>Adds the specified targets to the specified rule, or updates the targets if they are
27
27
  * already associated with the rule.</p>
28
28
  * <p>Targets are the resources that are invoked when a rule is triggered.</p>
29
+ * <p>The maximum number of entries per request is 10.</p>
29
30
  * <note>
30
31
  * <p>Each rule can have up to five (5) targets associated with it at one time.</p>
31
32
  * </note>
32
- * <p>You can configure the following as targets for Events:</p>
33
+ * <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>
34
+ * in the <i>Amazon EventBridge User Guide</i>.</p>
35
+ * <p>Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
36
+ * built-in targets are:</p>
33
37
  * <ul>
34
38
  * <li>
35
39
  * <p>
36
- * <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html">API destination</a>
40
+ * <code>Amazon EBS CreateSnapshot API call</code>
37
41
  * </p>
38
42
  * </li>
39
43
  * <li>
40
44
  * <p>
41
- * <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html">API Gateway</a>
45
+ * <code>Amazon EC2 RebootInstances API call</code>
42
46
  * </p>
43
47
  * </li>
44
48
  * <li>
45
- * <p>Batch job queue</p>
46
- * </li>
47
- * <li>
48
- * <p>CloudWatch group</p>
49
- * </li>
50
- * <li>
51
- * <p>CodeBuild project</p>
52
- * </li>
53
- * <li>
54
- * <p>CodePipeline</p>
55
- * </li>
56
- * <li>
57
- * <p>EC2 <code>CreateSnapshot</code> API call</p>
58
- * </li>
59
- * <li>
60
- * <p>EC2 Image Builder</p>
61
- * </li>
62
- * <li>
63
- * <p>EC2 <code>RebootInstances</code> API call</p>
64
- * </li>
65
- * <li>
66
- * <p>EC2 <code>StopInstances</code> API call</p>
67
- * </li>
68
- * <li>
69
- * <p>EC2 <code>TerminateInstances</code> API call</p>
70
- * </li>
71
- * <li>
72
- * <p>ECS task</p>
73
- * </li>
74
- * <li>
75
49
  * <p>
76
- * <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html">Event bus in a different account or
77
- * Region</a>
50
+ * <code>Amazon EC2 StopInstances API call</code>
78
51
  * </p>
79
52
  * </li>
80
53
  * <li>
81
54
  * <p>
82
- * <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html">Event bus in the same account and
83
- * Region</a>
55
+ * <code>Amazon EC2 TerminateInstances API
56
+ * call</code>
84
57
  * </p>
85
58
  * </li>
86
- * <li>
87
- * <p>Firehose delivery stream</p>
88
- * </li>
89
- * <li>
90
- * <p>Glue workflow</p>
91
- * </li>
92
- * <li>
93
- * <p>
94
- * <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge">Incident Manager response plan</a>
95
- * </p>
96
- * </li>
97
- * <li>
98
- * <p>Inspector assessment template</p>
99
- * </li>
100
- * <li>
101
- * <p>Kinesis stream</p>
102
- * </li>
103
- * <li>
104
- * <p>Lambda function</p>
105
- * </li>
106
- * <li>
107
- * <p>Redshift cluster</p>
108
- * </li>
109
- * <li>
110
- * <p>Redshift Serverless workgroup</p>
111
- * </li>
112
- * <li>
113
- * <p>SageMaker Pipeline</p>
114
- * </li>
115
- * <li>
116
- * <p>SNS topic</p>
117
- * </li>
118
- * <li>
119
- * <p>SQS queue</p>
120
- * </li>
121
- * <li>
122
- * <p>Step Functions state machine</p>
123
- * </li>
124
- * <li>
125
- * <p>Systems Manager Automation</p>
126
- * </li>
127
- * <li>
128
- * <p>Systems Manager OpsItem</p>
129
- * </li>
130
- * <li>
131
- * <p>Systems Manager Run Command</p>
132
- * </li>
133
59
  * </ul>
134
- * <p>Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
135
- * built-in targets are <code>EC2 CreateSnapshot API call</code>, <code>EC2 RebootInstances API
136
- * call</code>, <code>EC2 StopInstances API call</code>, and <code>EC2 TerminateInstances API
137
- * call</code>. </p>
138
60
  * <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the
139
61
  * target is a Kinesis data stream, you can optionally specify which shard the event goes to by
140
62
  * using the <code>KinesisParameters</code> argument. To invoke a command on multiple EC2
141
63
  * instances with one rule, you can use the <code>RunCommandParameters</code> field.</p>
142
64
  * <p>To be able to make API calls against the resources that you own, Amazon EventBridge
143
- * needs the appropriate permissions. For Lambda and Amazon SNS
144
- * resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams,
145
- * Step Functions state machines and API Gateway APIs, EventBridge relies on
146
- * IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>.
147
- * For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html">Authentication
148
- * and Access Control</a> in the <i>Amazon EventBridge User Guide</i>.</p>
65
+ * needs the appropriate permissions:
66
+ * </p>
67
+ * <ul>
68
+ * <li>
69
+ * <p>For Lambda and Amazon SNS
70
+ * resources, EventBridge relies on resource-based policies.</p>
71
+ * </li>
72
+ * <li>
73
+ * <p>For EC2 instances, Kinesis Data Streams,
74
+ * Step Functions state machines and API Gateway APIs, EventBridge relies on
75
+ * IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>.</p>
76
+ * </li>
77
+ * </ul>
78
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html">Authentication
79
+ * and Access Control</a> in the <i>Amazon EventBridge User Guide</i>.</p>
149
80
  * <p>If another Amazon Web Services account is in the same region and has granted you permission (using
150
81
  * <code>PutPermission</code>), you can send events to that account. Set that account's event
151
82
  * bus as a target of the rules in your account. To send the matched events to the other account,
@@ -166,6 +97,10 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
166
97
  * <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
167
98
  * Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
168
99
  * Guide</i>.</p>
100
+ * <note>
101
+ * <p>If you have an IAM role on a cross-account event bus target,
102
+ * a <code>PutTargets</code> call without a role on the same target (same <code>Id</code> and <code>Arn</code>) will not remove the role.</p>
103
+ * </note>
169
104
  * <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>
170
105
  * <p>
171
106
  * <b>Input</b>, <b>InputPath</b>, and
package/dist-types/commands/RemoveTargetsCommand.d.ts CHANGED
@@ -33,6 +33,7 @@ export interface RemoveTargetsCommandOutput extends RemoveTargetsResponse, __Met
33
33
  * <p>This action can partially fail if too many requests are made at the same time. If that
34
34
  * happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in
35
35
  * <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>
36
+ * <p>The maximum number of entries per request is 10.</p>
36
37
  * @example
37
38
  * Use a bare-bones client and the command you need to make an API call.
38
39
  * ```javascript
package/dist-types/commands/UpdateEndpointCommand.d.ts CHANGED
@@ -23,7 +23,7 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <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 applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
26
+ * <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 applications Regional-fault tolerant with global endpoints and event replication</a> in the <i>Amazon EventBridge User Guide</i>.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript