@aws-sdk/client-eventbridge 3.451.0 → 3.454.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 (20) hide show
  1. package/dist-cjs/models/models_0.js +1 -0
  2. package/dist-es/models/models_0.js +1 -0
  3. package/dist-types/commands/CreateApiDestinationCommand.d.ts +2 -0
  4. package/dist-types/commands/CreatePartnerEventSourceCommand.d.ts +21 -7
  5. package/dist-types/commands/DeleteEndpointCommand.d.ts +1 -1
  6. package/dist-types/commands/DescribeEndpointCommand.d.ts +1 -1
  7. package/dist-types/commands/DescribeRuleCommand.d.ts +1 -1
  8. package/dist-types/commands/ListEndpointsCommand.d.ts +1 -1
  9. package/dist-types/commands/ListRuleNamesByTargetCommand.d.ts +1 -0
  10. package/dist-types/commands/ListRulesCommand.d.ts +2 -1
  11. package/dist-types/commands/ListTargetsByRuleCommand.d.ts +1 -0
  12. package/dist-types/commands/PutEventsCommand.d.ts +7 -0
  13. package/dist-types/commands/PutPartnerEventsCommand.d.ts +3 -0
  14. package/dist-types/commands/PutRuleCommand.d.ts +1 -1
  15. package/dist-types/commands/PutTargetsCommand.d.ts +29 -94
  16. package/dist-types/commands/RemoveTargetsCommand.d.ts +1 -0
  17. package/dist-types/commands/UpdateEndpointCommand.d.ts +1 -1
  18. package/dist-types/models/models_0.d.ts +185 -18
  19. package/dist-types/ts3.4/models/models_0.d.ts +1 -0
  20. package/package.json +2 -2
package/dist-cjs/models/models_0.js CHANGED
@@ -206,6 +206,7 @@ exports.EventSourceState = {
206
206
  exports.RuleState = {
207
207
  DISABLED: "DISABLED",
208
208
  ENABLED: "ENABLED",
209
+ ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS",
209
210
  };
210
211
  exports.LaunchType = {
211
212
  EC2: "EC2",
package/dist-es/models/models_0.js CHANGED
@@ -193,6 +193,7 @@ export const EventSourceState = {
193
193
  export const RuleState = {
194
194
  DISABLED: "DISABLED",
195
195
  ENABLED: "ENABLED",
196
+ ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS",
196
197
  };
197
198
  export const LaunchType = {
198
199
  EC2: "EC2",
package/dist-types/commands/CreateApiDestinationCommand.d.ts CHANGED
@@ -25,6 +25,8 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR
25
25
  * @public
26
26
  * <p>Creates an API destination, which is an HTTP invocation endpoint configured as a target
27
27
  * for events.</p>
28
+ * <p>API destinations do not support private destinations, such as interface VPC endpoints.</p>
29
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html">API destinations</a> in the <i>EventBridge User Guide</i>.</p>
28
30
  * @example
29
31
  * Use a bare-bones client and the command you need to make an API call.
30
32
  * ```javascript
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
package/dist-types/models/models_0.d.ts CHANGED
@@ -1821,6 +1821,7 @@ export interface DescribeRuleRequest {
1821
1821
  export declare const RuleState: {
1822
1822
  readonly DISABLED: "DISABLED";
1823
1823
  readonly ENABLED: "ENABLED";
1824
+ readonly ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS";
1824
1825
  };
1825
1826
  /**
1826
1827
  * @public
@@ -1843,7 +1844,7 @@ export interface DescribeRuleResponse {
1843
1844
  /**
1844
1845
  * @public
1845
1846
  * <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
1846
- * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
1847
+ * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
1847
1848
  */
1848
1849
  EventPattern?: string;
1849
1850
  /**
@@ -2126,7 +2127,7 @@ export interface ListEndpointsRequest {
2126
2127
  }
2127
2128
  /**
2128
2129
  * @public
2129
- * <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>
2130
+ * <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 <i>Amazon EventBridge User Guide</i>.</p>
2130
2131
  */
2131
2132
  export interface Endpoint {
2132
2133
  /**
@@ -2667,12 +2668,37 @@ export interface Rule {
2667
2668
  /**
2668
2669
  * @public
2669
2670
  * <p>The event pattern of the rule. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
2670
- * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
2671
+ * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
2671
2672
  */
2672
2673
  EventPattern?: string;
2673
2674
  /**
2674
2675
  * @public
2675
2676
  * <p>The state of the rule.</p>
2677
+ * <p>Valid values include:</p>
2678
+ * <ul>
2679
+ * <li>
2680
+ * <p>
2681
+ * <code>DISABLED</code>: The rule is disabled. EventBridge does not match any events against the rule.</p>
2682
+ * </li>
2683
+ * <li>
2684
+ * <p>
2685
+ * <code>ENABLED</code>: The rule is enabled.
2686
+ * EventBridge matches events against the rule, <i>except</i> for Amazon Web Services management events delivered through CloudTrail.</p>
2687
+ * </li>
2688
+ * <li>
2689
+ * <p>
2690
+ * <code>ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS</code>: The rule is enabled for all
2691
+ * events, including Amazon Web Services management events delivered through CloudTrail.</p>
2692
+ * <p>Management events provide visibility into management operations that are performed on
2693
+ * resources in your Amazon Web Services account. These are also known as control plane
2694
+ * operations. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events">Logging management events</a> in the <i>CloudTrail User
2695
+ * Guide</i>, and <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail">Filtering management events from Amazon Web Services services</a> in the
2696
+ * <i>Amazon EventBridge User Guide</i>.</p>
2697
+ * <p>This value is only valid for rules on the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses">default</a> event bus
2698
+ * or <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html">custom event buses</a>.
2699
+ * It does not apply to <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html">partner event buses</a>.</p>
2700
+ * </li>
2701
+ * </ul>
2676
2702
  */
2677
2703
  State?: RuleState;
2678
2704
  /**
@@ -3241,7 +3267,7 @@ export interface KinesisParameters {
3241
3267
  }
3242
3268
  /**
3243
3269
  * @public
3244
- * <p>These are custom parameters to be used when the target is a Amazon Redshift cluster or Redshift Serverless workgroup to invoke the
3270
+ * <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
3245
3271
  * Amazon Redshift Data API ExecuteStatement based on EventBridge events.</p>
3246
3272
  */
3247
3273
  export interface RedshiftDataParameters {
@@ -3259,7 +3285,6 @@ export interface RedshiftDataParameters {
3259
3285
  /**
3260
3286
  * @public
3261
3287
  * <p>The database user name. Required when authenticating using temporary credentials.</p>
3262
- * <p>Do not provide this parameter when connecting to a Redshift Serverless workgroup.</p>
3263
3288
  */
3264
3289
  DbUser?: string;
3265
3290
  /**
@@ -3281,7 +3306,9 @@ export interface RedshiftDataParameters {
3281
3306
  WithEvent?: boolean;
3282
3307
  /**
3283
3308
  * @public
3284
- * A list of SQLs.
3309
+ * <p>One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array.
3310
+ * Subsequent SQL statements don't start until the previous statement in the array completes.
3311
+ * If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
3285
3312
  */
3286
3313
  Sqls?: string[];
3287
3314
  }
@@ -3534,6 +3561,13 @@ export interface PutEventsRequestEntry {
3534
3561
  /**
3535
3562
  * @public
3536
3563
  * <p>The source of the event.</p>
3564
+ * <note>
3565
+ * <p>
3566
+ * <code>Detail</code>, <code>DetailType</code>, and <code>Source</code> are required for EventBridge to successfully send an event to an event bus.
3567
+ * If you include event entries in a request that do not include each of those properties, EventBridge fails that entry.
3568
+ * If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
3569
+ * </p>
3570
+ * </note>
3537
3571
  */
3538
3572
  Source?: string;
3539
3573
  /**
@@ -3545,12 +3579,26 @@ export interface PutEventsRequestEntry {
3545
3579
  /**
3546
3580
  * @public
3547
3581
  * <p>Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
3582
+ * <note>
3583
+ * <p>
3584
+ * <code>Detail</code>, <code>DetailType</code>, and <code>Source</code> are required for EventBridge to successfully send an event to an event bus.
3585
+ * If you include event entries in a request that do not include each of those properties, EventBridge fails that entry.
3586
+ * If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
3587
+ * </p>
3588
+ * </note>
3548
3589
  */
3549
3590
  DetailType?: string;
3550
3591
  /**
3551
3592
  * @public
3552
3593
  * <p>A valid JSON object. There is no other schema imposed. The JSON object may contain fields
3553
- * and nested subobjects.</p>
3594
+ * and nested sub-objects.</p>
3595
+ * <note>
3596
+ * <p>
3597
+ * <code>Detail</code>, <code>DetailType</code>, and <code>Source</code> are required for EventBridge to successfully send an event to an event bus.
3598
+ * If you include event entries in a request that do not include each of those properties, EventBridge fails that entry.
3599
+ * If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
3600
+ * </p>
3601
+ * </note>
3554
3602
  */
3555
3603
  Detail?: string;
3556
3604
  /**
@@ -3559,9 +3607,9 @@ export interface PutEventsRequestEntry {
3559
3607
  * with this event bus are used to match the event. If you omit this, the default event bus is
3560
3608
  * used.</p>
3561
3609
  * <note>
3562
- * <p>If you're using a global endpoint with a custom bus, you must enter the name, not the ARN, of the event bus in either
3563
- * the primary or secondary Region here and the corresponding event bus in the
3564
- * other Region will be determined based on the endpoint referenced by the <code>EndpointId</code>.</p>
3610
+ * <p>If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus
3611
+ * in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the
3612
+ * other Region based on the endpoint referenced by the <code>EndpointId</code>. Specifying the event bus ARN is preferred.</p>
3565
3613
  * </note>
3566
3614
  */
3567
3615
  EventBusName?: string;
@@ -3595,7 +3643,10 @@ export interface PutEventsRequest {
3595
3643
  }
3596
3644
  /**
3597
3645
  * @public
3598
- * <p>Represents an event that failed to be submitted. For information about the errors that are common to all actions, see
3646
+ * <p>Represents the results of an event submitted to an event bus.</p>
3647
+ * <p>If the submission was successful, the entry has the event ID in it.
3648
+ * Otherwise, you can use the error code and error message to identify the problem with the entry.</p>
3649
+ * <p>For information about the errors that are common to all actions, see
3599
3650
  * <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
3600
3651
  */
3601
3652
  export interface PutEventsResultEntry {
@@ -3607,6 +3658,72 @@ export interface PutEventsResultEntry {
3607
3658
  /**
3608
3659
  * @public
3609
3660
  * <p>The error code that indicates why the event submission failed.</p>
3661
+ * <p>Retryable errors include:</p>
3662
+ * <ul>
3663
+ * <li>
3664
+ * <p>
3665
+ * <code>
3666
+ * <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html">InternalFailure</a>
3667
+ * </code>
3668
+ * </p>
3669
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
3670
+ * </li>
3671
+ * <li>
3672
+ * <p>
3673
+ * <code>
3674
+ * <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html">ThrottlingException</a>
3675
+ * </code>
3676
+ * </p>
3677
+ * <p>The request was denied due to request throttling.</p>
3678
+ * </li>
3679
+ * </ul>
3680
+ * <p>Non-retryable errors include:</p>
3681
+ * <ul>
3682
+ * <li>
3683
+ * <p>
3684
+ * <code>
3685
+ * <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html">AccessDeniedException</a>
3686
+ * </code>
3687
+ * </p>
3688
+ * <p>You do not have sufficient access to perform this action.</p>
3689
+ * </li>
3690
+ * <li>
3691
+ * <p>
3692
+ * <code>InvalidAccountIdException</code>
3693
+ * </p>
3694
+ * <p>The account ID provided is not valid.</p>
3695
+ * </li>
3696
+ * <li>
3697
+ * <p>
3698
+ * <code>InvalidArgument</code>
3699
+ * </p>
3700
+ * <p>A specified parameter is not valid.</p>
3701
+ * </li>
3702
+ * <li>
3703
+ * <p>
3704
+ * <code>MalformedDetail</code>
3705
+ * </p>
3706
+ * <p>The JSON provided is not valid.</p>
3707
+ * </li>
3708
+ * <li>
3709
+ * <p>
3710
+ * <code>RedactionFailure</code>
3711
+ * </p>
3712
+ * <p>Redacting the CloudTrail event failed.</p>
3713
+ * </li>
3714
+ * <li>
3715
+ * <p>
3716
+ * <code>NotAuthorizedForSourceException</code>
3717
+ * </p>
3718
+ * <p>You do not have permissions to publish events with this source onto this event bus.</p>
3719
+ * </li>
3720
+ * <li>
3721
+ * <p>
3722
+ * <code>NotAuthorizedForDetailTypeException</code>
3723
+ * </p>
3724
+ * <p>You do not have permissions to publish events with this detail type onto this event bus.</p>
3725
+ * </li>
3726
+ * </ul>
3610
3727
  */
3611
3728
  ErrorCode?: string;
3612
3729
  /**
@@ -3646,6 +3763,13 @@ export interface PutPartnerEventsRequestEntry {
3646
3763
  /**
3647
3764
  * @public
3648
3765
  * <p>The event source that is generating the entry.</p>
3766
+ * <note>
3767
+ * <p>
3768
+ * <code>Detail</code>, <code>DetailType</code>, and <code>Source</code> are required for EventBridge to successfully send an event to an event bus.
3769
+ * If you include event entries in a request that do not include each of those properties, EventBridge fails that entry.
3770
+ * If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
3771
+ * </p>
3772
+ * </note>
3649
3773
  */
3650
3774
  Source?: string;
3651
3775
  /**
@@ -3657,12 +3781,26 @@ export interface PutPartnerEventsRequestEntry {
3657
3781
  /**
3658
3782
  * @public
3659
3783
  * <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
3784
+ * <note>
3785
+ * <p>
3786
+ * <code>Detail</code>, <code>DetailType</code>, and <code>Source</code> are required for EventBridge to successfully send an event to an event bus.
3787
+ * If you include event entries in a request that do not include each of those properties, EventBridge fails that entry.
3788
+ * If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
3789
+ * </p>
3790
+ * </note>
3660
3791
  */
3661
3792
  DetailType?: string;
3662
3793
  /**
3663
3794
  * @public
3664
3795
  * <p>A valid JSON string. There is no other schema imposed. The JSON string may contain fields
3665
- * and nested subobjects.</p>
3796
+ * and nested sub-objects.</p>
3797
+ * <note>
3798
+ * <p>
3799
+ * <code>Detail</code>, <code>DetailType</code>, and <code>Source</code> are required for EventBridge to successfully send an event to an event bus.
3800
+ * If you include event entries in a request that do not include each of those properties, EventBridge fails that entry.
3801
+ * If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
3802
+ * </p>
3803
+ * </note>
3666
3804
  */
3667
3805
  Detail?: string;
3668
3806
  }
@@ -3678,7 +3816,9 @@ export interface PutPartnerEventsRequest {
3678
3816
  }
3679
3817
  /**
3680
3818
  * @public
3681
- * <p>Represents an event that a partner tried to generate, but failed.</p>
3819
+ * <p>The result of an event entry the partner submitted in this request.
3820
+ * If the event was successfully submitted, the entry has the event ID in it.
3821
+ * Otherwise, you can use the error code and error message to identify the problem with the entry.</p>
3682
3822
  */
3683
3823
  export interface PutPartnerEventsResultEntry {
3684
3824
  /**
@@ -3709,8 +3849,10 @@ export interface PutPartnerEventsResponse {
3709
3849
  FailedEntryCount?: number;
3710
3850
  /**
3711
3851
  * @public
3712
- * <p>The list of events from this operation that were successfully written to the partner event
3713
- * bus.</p>
3852
+ * <p>The results for each event entry the partner submitted in this request.
3853
+ * If the event was successfully submitted, the entry has the event ID in it.
3854
+ * Otherwise, you can use the error code and error message to identify the problem with the entry.</p>
3855
+ * <p>For each record, the index of the response element is the same as the index in the request array.</p>
3714
3856
  */
3715
3857
  Entries?: PutPartnerEventsResultEntry[];
3716
3858
  }
@@ -3832,12 +3974,37 @@ export interface PutRuleRequest {
3832
3974
  /**
3833
3975
  * @public
3834
3976
  * <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
3835
- * patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
3977
+ * patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
3836
3978
  */
3837
3979
  EventPattern?: string;
3838
3980
  /**
3839
3981
  * @public
3840
- * <p>Indicates whether the rule is enabled or disabled.</p>
3982
+ * <p>The state of the rule.</p>
3983
+ * <p>Valid values include:</p>
3984
+ * <ul>
3985
+ * <li>
3986
+ * <p>
3987
+ * <code>DISABLED</code>: The rule is disabled. EventBridge does not match any events against the rule.</p>
3988
+ * </li>
3989
+ * <li>
3990
+ * <p>
3991
+ * <code>ENABLED</code>: The rule is enabled.
3992
+ * EventBridge matches events against the rule, <i>except</i> for Amazon Web Services management events delivered through CloudTrail.</p>
3993
+ * </li>
3994
+ * <li>
3995
+ * <p>
3996
+ * <code>ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS</code>: The rule is enabled for all
3997
+ * events, including Amazon Web Services management events delivered through CloudTrail.</p>
3998
+ * <p>Management events provide visibility into management operations that are performed on
3999
+ * resources in your Amazon Web Services account. These are also known as control plane
4000
+ * operations. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events">Logging management events</a> in the <i>CloudTrail User
4001
+ * Guide</i>, and <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail">Filtering management events from Amazon Web Services services</a> in the
4002
+ * <i>Amazon EventBridge User Guide</i>.</p>
4003
+ * <p>This value is only valid for rules on the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses">default</a> event bus
4004
+ * or <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html">custom event buses</a>.
4005
+ * It does not apply to <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html">partner event buses</a>.</p>
4006
+ * </li>
4007
+ * </ul>
3841
4008
  */
3842
4009
  State?: RuleState;
3843
4010
  /**
@@ -4115,7 +4282,7 @@ export interface TestEventPatternRequest {
4115
4282
  /**
4116
4283
  * @public
4117
4284
  * <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
4118
- * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
4285
+ * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
4119
4286
  */
4120
4287
  EventPattern: string | undefined;
4121
4288
  /**
package/dist-types/ts3.4/models/models_0.d.ts CHANGED
@@ -518,6 +518,7 @@ export interface DescribeRuleRequest {
518
518
  export declare const RuleState: {
519
519
  readonly DISABLED: "DISABLED";
520
520
  readonly ENABLED: "ENABLED";
521
+ readonly ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS";
521
522
  };
522
523
  export type RuleState = (typeof RuleState)[keyof typeof RuleState];
523
524
  export interface DescribeRuleResponse {
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.451.0",
4
+ "version": "3.454.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",
@@ -23,7 +23,7 @@
23
23
  "dependencies": {
24
24
  "@aws-crypto/sha256-browser": "3.0.0",
25
25
  "@aws-crypto/sha256-js": "3.0.0",
26
- "@aws-sdk/client-sts": "3.451.0",
26
+ "@aws-sdk/client-sts": "3.454.0",
27
27
  "@aws-sdk/core": "3.451.0",
28
28
  "@aws-sdk/credential-provider-node": "3.451.0",
29
29
  "@aws-sdk/middleware-host-header": "3.451.0",