Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your -resources change state, they automatically send events to an event stream. You can create -rules that match selected events in the stream and route them to targets to take action. You -can also use rules to take action on a predetermined schedule. For example, you can configure -rules to:
+Amazon EventBridge helps you to respond to state changes in your Amazon Web Services +resources. When your resources change state, they automatically send events to an event +stream. You can create rules that match selected events in the stream and route them to +targets to take action. You can also use rules to take action on a predetermined schedule. For +example, you can configure rules to:
Automatically invoke an Lambda function to update DNS entries when an event -notifies you that Amazon EC2 instance enters the running state.
+Automatically invoke an Lambda function to update DNS entries when an +event notifies you that Amazon EC2 instance enters the running state.
Direct specific API records from CloudTrail to an Amazon Kinesis data stream for -detailed analysis of potential security or availability risks.
+Direct specific API records from CloudTrail to an Amazon Kinesis +data stream for detailed analysis of potential security or availability risks.
Periodically invoke a built-in target to create a snapshot of an Amazon EBS
@@ -671,3 +671,11 @@ UpdateEndpoint
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/eventbridge/command/UpdateEndpointCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-eventbridge/Interface/UpdateEndpointCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-eventbridge/Interface/UpdateEndpointCommandOutput/)
+ Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your
- * resources change state, they automatically send events to an event stream. You can create
- * rules that match selected events in the stream and route them to targets to take action. You
- * can also use rules to take action on a predetermined schedule. For example, you can configure
- * rules to: Amazon EventBridge helps you to respond to state changes in your Amazon Web Services
+ * resources. When your resources change state, they automatically send events to an event
+ * stream. You can create rules that match selected events in the stream and route them to
+ * targets to take action. You can also use rules to take action on a predetermined schedule. For
+ * example, you can configure rules to: Automatically invoke an Lambda function to update DNS entries when an event
- * notifies you that Amazon EC2 instance enters the running state. Automatically invoke an Lambda function to update DNS entries when an
+ * event notifies you that Amazon EC2 instance enters the running state. Direct specific API records from CloudTrail to an Amazon Kinesis data stream for
- * detailed analysis of potential security or availability risks. Direct specific API records from CloudTrail to an Amazon Kinesis
+ * data stream for detailed analysis of potential security or availability risks. Periodically invoke a built-in target to create a snapshot of an Amazon EBS
diff --git a/clients/client-eventbridge/src/EventBridgeClient.ts b/clients/client-eventbridge/src/EventBridgeClient.ts
index a28dc6c9d789d..691d6cc03a8a3 100644
--- a/clients/client-eventbridge/src/EventBridgeClient.ts
+++ b/clients/client-eventbridge/src/EventBridgeClient.ts
@@ -152,6 +152,7 @@ import {
import { UpdateArchiveCommandInput, UpdateArchiveCommandOutput } from "./commands/UpdateArchiveCommand";
import { UpdateConnectionCommandInput, UpdateConnectionCommandOutput } from "./commands/UpdateConnectionCommand";
import { UpdateEndpointCommandInput, UpdateEndpointCommandOutput } from "./commands/UpdateEndpointCommand";
+import { UpdateEventBusCommandInput, UpdateEventBusCommandOutput } from "./commands/UpdateEventBusCommand";
import {
ClientInputEndpointParameters,
ClientResolvedEndpointParameters,
@@ -222,7 +223,8 @@ export type ServiceInputTypes =
| UpdateApiDestinationCommandInput
| UpdateArchiveCommandInput
| UpdateConnectionCommandInput
- | UpdateEndpointCommandInput;
+ | UpdateEndpointCommandInput
+ | UpdateEventBusCommandInput;
/**
* @public
@@ -283,7 +285,8 @@ export type ServiceOutputTypes =
| UpdateApiDestinationCommandOutput
| UpdateArchiveCommandOutput
| UpdateConnectionCommandOutput
- | UpdateEndpointCommandOutput;
+ | UpdateEndpointCommandOutput
+ | UpdateEventBusCommandOutput;
/**
* @public
@@ -456,19 +459,19 @@ export type EventBridgeClientResolvedConfigType = __SmithyResolvedConfiguration<
export interface EventBridgeClientResolvedConfig extends EventBridgeClientResolvedConfigType {}
/**
- * Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your
- * resources change state, they automatically send events to an event stream. You can create
- * rules that match selected events in the stream and route them to targets to take action. You
- * can also use rules to take action on a predetermined schedule. For example, you can configure
- * rules to: Amazon EventBridge helps you to respond to state changes in your Amazon Web Services
+ * resources. When your resources change state, they automatically send events to an event
+ * stream. You can create rules that match selected events in the stream and route them to
+ * targets to take action. You can also use rules to take action on a predetermined schedule. For
+ * example, you can configure rules to: Automatically invoke an Lambda function to update DNS entries when an event
- * notifies you that Amazon EC2 instance enters the running state. Automatically invoke an Lambda function to update DNS entries when an
+ * event notifies you that Amazon EC2 instance enters the running state. Direct specific API records from CloudTrail to an Amazon Kinesis data stream for
- * detailed analysis of potential security or availability risks. Direct specific API records from CloudTrail to an Amazon Kinesis
+ * data stream for detailed analysis of potential security or availability risks. Periodically invoke a built-in target to create a snapshot of an Amazon EBS
diff --git a/clients/client-eventbridge/src/commands/CreateApiDestinationCommand.ts b/clients/client-eventbridge/src/commands/CreateApiDestinationCommand.ts
index 1f697537575f9..c7efc1d7cd809 100644
--- a/clients/client-eventbridge/src/commands/CreateApiDestinationCommand.ts
+++ b/clients/client-eventbridge/src/commands/CreateApiDestinationCommand.ts
@@ -29,8 +29,10 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR
/**
* Creates an API destination, which is an HTTP invocation endpoint configured as a target
* for events. API destinations do not support private destinations, such as interface VPC endpoints. For more information, see API destinations in the EventBridge User Guide. API destinations do not support private destinations, such as interface VPC
+ * endpoints. For more information, see API destinations in the
+ * EventBridge User Guide.
+UpdateEventBus
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/eventbridge/command/UpdateEventBusCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-eventbridge/Interface/UpdateEventBusCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-eventbridge/Interface/UpdateEventBusCommandOutput/)
+
+
*
*
Archives and schema discovery are not supported for event buses encrypted using a + * customer managed key. EventBridge returns an error if:
+ *You call
+ * CreateArchive
+ * on an event bus set to use a customer managed key for encryption.
You call
+ * CreateDiscoverer
+ * on an event bus set to use a customer managed key for encryption.
You call
+ * UpdatedEventBus
+ * to set a customer managed key on an event bus with an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to + * use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
+ *Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region - * with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state - * is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.
+ *Creates a global endpoint. Global endpoints improve your application's availability by + * making it regional-fault tolerant. To do this, you define a primary and secondary Region with + * event buses in each Region. You also create a Amazon Route 53 health check that will + * tell EventBridge to route events to the secondary Region when an "unhealthy" state is + * encountered and events will be routed back to the primary Region when the health check reports + * a "healthy" state.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/CreateEventBusCommand.ts b/clients/client-eventbridge/src/commands/CreateEventBusCommand.ts index 450cd8f5457b4..11bc24c046e60 100644 --- a/clients/client-eventbridge/src/commands/CreateEventBusCommand.ts +++ b/clients/client-eventbridge/src/commands/CreateEventBusCommand.ts @@ -39,6 +39,11 @@ export interface CreateEventBusCommandOutput extends CreateEventBusResponse, __M * const input = { // CreateEventBusRequest * Name: "STRING_VALUE", // required * EventSourceName: "STRING_VALUE", + * Description: "STRING_VALUE", + * KmsKeyIdentifier: "STRING_VALUE", + * DeadLetterConfig: { // DeadLetterConfig + * Arn: "STRING_VALUE", + * }, * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required @@ -50,6 +55,11 @@ export interface CreateEventBusCommandOutput extends CreateEventBusResponse, __M * const response = await client.send(command); * // { // CreateEventBusResponse * // EventBusArn: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // KmsKeyIdentifier: "STRING_VALUE", + * // DeadLetterConfig: { // DeadLetterConfig + * // Arn: "STRING_VALUE", + * // }, * // }; * * ``` diff --git a/clients/client-eventbridge/src/commands/CreatePartnerEventSourceCommand.ts b/clients/client-eventbridge/src/commands/CreatePartnerEventSourceCommand.ts index 2ea685cde7eef..ef4545f91bd31 100644 --- a/clients/client-eventbridge/src/commands/CreatePartnerEventSourceCommand.ts +++ b/clients/client-eventbridge/src/commands/CreatePartnerEventSourceCommand.ts @@ -28,15 +28,16 @@ export interface CreatePartnerEventSourceCommandOutput extends CreatePartnerEven /** *Called by an SaaS partner to create a partner event source. This operation is not used by - * Amazon Web Services customers.
- *Each partner event source can be used by one Amazon Web Services account to create a matching partner - * event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each - * Amazon Web Services account that wants to receive those event types.
+ * Amazon Web Services customers. + *Each partner event source can be used by one Amazon Web Services account to create a + * matching partner event bus in that Amazon Web Services account. A SaaS partner must create one + * partner event source for each Amazon Web Services account that wants to receive those event + * types.
*A partner event source creates events based on resources within the SaaS partner's service * or application.
- *An Amazon Web Services account that creates a partner event bus that matches the partner event source can - * use that event bus to receive events from the partner, and then process them using Amazon Web Services Events - * rules and targets.
+ *An Amazon Web Services account that creates a partner event bus that matches the partner + * event source can use that event bus to receive events from the partner, and then process them + * using Amazon Web Services Events rules and targets.
*Partner event source names follow this format:
*
*
@@ -56,15 +57,16 @@ export interface CreatePartnerEventSourceCommandOutput extends CreatePartnerEven
*
- * event_name is determined by the partner, and should uniquely identify - * an event-generating resource within the partner system.
- *The event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource - * between the partner and customer accounts, and each partner event source unique in the partner account.
+ * event_name is determined by the partner, and should uniquely + * identify an event-generating resource within the partner system. + *The event_name must be unique across all Amazon Web Services + * customers. This is because the event source is a shared resource between the partner and + * customer accounts, and each partner event source unique in the partner account.
*The combination of - * event_namespace and event_name should help Amazon Web Services - * customers decide whether to create an event bus to receive these events.
+ *The combination of event_namespace and + * event_name should help Amazon Web Services customers decide whether to + * create an event bus to receive these events.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/DeleteEndpointCommand.ts b/clients/client-eventbridge/src/commands/DeleteEndpointCommand.ts index cc3a2101622b0..15e83ff157c3e 100644 --- a/clients/client-eventbridge/src/commands/DeleteEndpointCommand.ts +++ b/clients/client-eventbridge/src/commands/DeleteEndpointCommand.ts @@ -27,7 +27,11 @@ export interface DeleteEndpointCommandInput extends DeleteEndpointRequest {} export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __MetadataBearer {} /** - *Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
+ *Delete an existing global endpoint. For more information about global endpoints, see + * Making applications Regional-fault tolerant with global endpoints and event + * replication in the + * Amazon EventBridge User Guide + * .
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/DeletePartnerEventSourceCommand.ts b/clients/client-eventbridge/src/commands/DeletePartnerEventSourceCommand.ts index d2f0c0a1e92ca..b782c937855e5 100644 --- a/clients/client-eventbridge/src/commands/DeletePartnerEventSourceCommand.ts +++ b/clients/client-eventbridge/src/commands/DeletePartnerEventSourceCommand.ts @@ -30,7 +30,7 @@ export interface DeletePartnerEventSourceCommandOutput extends __MetadataBearer *This operation is used by SaaS partners to delete a partner event source. This operation * is not used by Amazon Web Services customers.
*When you delete an event source, the status of the corresponding partner event bus in the - * Amazon Web Services customer account becomes DELETED.
+ * Amazon Web Services customer account becomes DELETED. * * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-eventbridge/src/commands/DeleteRuleCommand.ts b/clients/client-eventbridge/src/commands/DeleteRuleCommand.ts index 3475eef9e88af..581c55c9207a5 100644 --- a/clients/client-eventbridge/src/commands/DeleteRuleCommand.ts +++ b/clients/client-eventbridge/src/commands/DeleteRuleCommand.ts @@ -34,10 +34,11 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {} *If you call delete rule multiple times for the same rule, all calls will succeed. When you
* call delete rule for a non-existent custom eventbus, ResourceNotFoundException is
* returned.
Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These
- * rules are created by those other Amazon Web Services services to support functionality in those services. You
- * can delete these rules using the Force option, but you should do so only if you
- * are sure the other service is not still using that rule.
Managed rules are rules created and managed by another Amazon Web Services service on your
+ * behalf. These rules are created by those other Amazon Web Services services to support
+ * functionality in those services. You can delete these rules using the Force
+ * option, but you should do so only if you are sure the other service is not still using that
+ * rule.
This exception occurs due to unexpected causes.
* * @throws {@link ManagedRuleException} (client fault) - *This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
- * service. If you see this error in response to DeleteRule or
+ *
This rule was created by an Amazon Web Services service on behalf of your account. It is
+ * managed by that service. If you see this error in response to DeleteRule or
* RemoveTargets, you can use the Force parameter in those calls to
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
* using DisableRule, EnableRule, PutTargets,
diff --git a/clients/client-eventbridge/src/commands/DescribeEndpointCommand.ts b/clients/client-eventbridge/src/commands/DescribeEndpointCommand.ts
index b4eec94726da8..ab7130358dac9 100644
--- a/clients/client-eventbridge/src/commands/DescribeEndpointCommand.ts
+++ b/clients/client-eventbridge/src/commands/DescribeEndpointCommand.ts
@@ -27,7 +27,12 @@ export interface DescribeEndpointCommandInput extends DescribeEndpointRequest {}
export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse, __MetadataBearer {}
/**
- *
Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
+ *Get the information about an existing global endpoint. For more information about global + * endpoints, see Making applications + * Regional-fault tolerant with global endpoints and event replication in the + * + * Amazon EventBridge User Guide + * .
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/DescribeEventBusCommand.ts b/clients/client-eventbridge/src/commands/DescribeEventBusCommand.ts index 7e8120b8f6831..66c558ab613a2 100644 --- a/clients/client-eventbridge/src/commands/DescribeEventBusCommand.ts +++ b/clients/client-eventbridge/src/commands/DescribeEventBusCommand.ts @@ -27,10 +27,9 @@ export interface DescribeEventBusCommandInput extends DescribeEventBusRequest {} export interface DescribeEventBusCommandOutput extends DescribeEventBusResponse, __MetadataBearer {} /** - *Displays details about an event bus in your account. This can include the external Amazon Web Services - * accounts that are permitted to write events to your default event bus, and the associated - * policy. For custom event buses and partner event buses, it displays the name, ARN, policy, - * state, and creation time.
+ *Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the + * associated policy. For custom event buses and partner event buses, it displays the name, ARN, + * policy, state, and creation time.
*To enable your account to receive events from other accounts on its default event bus, * use PutPermission.
*For more information about partner event buses, see CreateEventBus.
@@ -48,7 +47,14 @@ export interface DescribeEventBusCommandOutput extends DescribeEventBusResponse, * // { // DescribeEventBusResponse * // Name: "STRING_VALUE", * // Arn: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // KmsKeyIdentifier: "STRING_VALUE", + * // DeadLetterConfig: { // DeadLetterConfig + * // Arn: "STRING_VALUE", + * // }, * // Policy: "STRING_VALUE", + * // CreationTime: new Date("TIMESTAMP"), + * // LastModifiedTime: new Date("TIMESTAMP"), * // }; * * ``` diff --git a/clients/client-eventbridge/src/commands/DescribePartnerEventSourceCommand.ts b/clients/client-eventbridge/src/commands/DescribePartnerEventSourceCommand.ts index ead9dde9b6f63..e1fda11d903ed 100644 --- a/clients/client-eventbridge/src/commands/DescribePartnerEventSourceCommand.ts +++ b/clients/client-eventbridge/src/commands/DescribePartnerEventSourceCommand.ts @@ -28,9 +28,8 @@ export interface DescribePartnerEventSourceCommandOutput extends DescribePartner /** *An SaaS partner can use this operation to list details about a partner event source that - * they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource - * to see details about a partner event source that is - * shared with them.
+ * they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with + * them. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/DisableRuleCommand.ts b/clients/client-eventbridge/src/commands/DisableRuleCommand.ts index 7ada66e4f5aac..cf49fdcbf9ed0 100644 --- a/clients/client-eventbridge/src/commands/DisableRuleCommand.ts +++ b/clients/client-eventbridge/src/commands/DisableRuleCommand.ts @@ -60,8 +60,8 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {} *This exception occurs due to unexpected causes.
* * @throws {@link ManagedRuleException} (client fault) - *This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
- * service. If you see this error in response to DeleteRule or
+ *
This rule was created by an Amazon Web Services service on behalf of your account. It is
+ * managed by that service. If you see this error in response to DeleteRule or
* RemoveTargets, you can use the Force parameter in those calls to
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
* using DisableRule, EnableRule, PutTargets,
diff --git a/clients/client-eventbridge/src/commands/EnableRuleCommand.ts b/clients/client-eventbridge/src/commands/EnableRuleCommand.ts
index 03d663c19b719..8fc3fea3e9705 100644
--- a/clients/client-eventbridge/src/commands/EnableRuleCommand.ts
+++ b/clients/client-eventbridge/src/commands/EnableRuleCommand.ts
@@ -59,8 +59,8 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {}
*
This exception occurs due to unexpected causes.
* * @throws {@link ManagedRuleException} (client fault) - *This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
- * service. If you see this error in response to DeleteRule or
+ *
This rule was created by an Amazon Web Services service on behalf of your account. It is
+ * managed by that service. If you see this error in response to DeleteRule or
* RemoveTargets, you can use the Force parameter in those calls to
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
* using DisableRule, EnableRule, PutTargets,
diff --git a/clients/client-eventbridge/src/commands/ListEndpointsCommand.ts b/clients/client-eventbridge/src/commands/ListEndpointsCommand.ts
index e97cc68d4f636..49b7bd5b44ffd 100644
--- a/clients/client-eventbridge/src/commands/ListEndpointsCommand.ts
+++ b/clients/client-eventbridge/src/commands/ListEndpointsCommand.ts
@@ -27,7 +27,12 @@ export interface ListEndpointsCommandInput extends ListEndpointsRequest {}
export interface ListEndpointsCommandOutput extends ListEndpointsResponse, __MetadataBearer {}
/**
- *
List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
+ *List the global endpoints associated with this account. For more information about global + * endpoints, see Making applications + * Regional-fault tolerant with global endpoints and event replication in the + * + * Amazon EventBridge User Guide + * .
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/ListEventBusesCommand.ts b/clients/client-eventbridge/src/commands/ListEventBusesCommand.ts index f2ce80ef3c400..76c0d5af14c88 100644 --- a/clients/client-eventbridge/src/commands/ListEventBusesCommand.ts +++ b/clients/client-eventbridge/src/commands/ListEventBusesCommand.ts @@ -47,7 +47,10 @@ export interface ListEventBusesCommandOutput extends ListEventBusesResponse, __M * // { // EventBus * // Name: "STRING_VALUE", * // Arn: "STRING_VALUE", + * // Description: "STRING_VALUE", * // Policy: "STRING_VALUE", + * // CreationTime: new Date("TIMESTAMP"), + * // LastModifiedTime: new Date("TIMESTAMP"), * // }, * // ], * // NextToken: "STRING_VALUE", diff --git a/clients/client-eventbridge/src/commands/ListEventSourcesCommand.ts b/clients/client-eventbridge/src/commands/ListEventSourcesCommand.ts index c82e57caf190c..faf01c63310f8 100644 --- a/clients/client-eventbridge/src/commands/ListEventSourcesCommand.ts +++ b/clients/client-eventbridge/src/commands/ListEventSourcesCommand.ts @@ -27,8 +27,8 @@ export interface ListEventSourcesCommandInput extends ListEventSourcesRequest {} export interface ListEventSourcesCommandOutput extends ListEventSourcesResponse, __MetadataBearer {} /** - *You can use this to see all the partner event sources that have been shared with your Amazon Web Services - * account. For more information about partner event sources, see CreateEventBus.
+ *You can use this to see all the partner event sources that have been shared with your + * Amazon Web Services account. For more information about partner event sources, see CreateEventBus.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/ListPartnerEventSourceAccountsCommand.ts b/clients/client-eventbridge/src/commands/ListPartnerEventSourceAccountsCommand.ts index c2171b3d98c1d..abfefbf48988c 100644 --- a/clients/client-eventbridge/src/commands/ListPartnerEventSourceAccountsCommand.ts +++ b/clients/client-eventbridge/src/commands/ListPartnerEventSourceAccountsCommand.ts @@ -32,9 +32,8 @@ export interface ListPartnerEventSourceAccountsCommandOutput __MetadataBearer {} /** - *An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular - * partner event source name is associated with. This operation is not used by Amazon Web Services - * customers.
+ *An SaaS partner can use this operation to display the Amazon Web Services account ID that a + * particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/ListRulesCommand.ts b/clients/client-eventbridge/src/commands/ListRulesCommand.ts index b46652042fc7a..5ee727bc9595f 100644 --- a/clients/client-eventbridge/src/commands/ListRulesCommand.ts +++ b/clients/client-eventbridge/src/commands/ListRulesCommand.ts @@ -27,8 +27,8 @@ export interface ListRulesCommandInput extends ListRulesRequest {} export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBearer {} /** - *Lists your Amazon EventBridge rules. You can either list all the rules or you can provide - * a prefix to match to the rule names.
+ *Lists your Amazon EventBridge rules. You can either list all the rules or you can + * provide a prefix to match to the rule names.
*The maximum number of results per page for requests is 100.
*ListRules does not list the targets of a rule. To see the targets associated with a rule, * use ListTargetsByRule.
diff --git a/clients/client-eventbridge/src/commands/PutEventsCommand.ts b/clients/client-eventbridge/src/commands/PutEventsCommand.ts index 7fc116c3d2018..1067384afe74e 100644 --- a/clients/client-eventbridge/src/commands/PutEventsCommand.ts +++ b/clients/client-eventbridge/src/commands/PutEventsCommand.ts @@ -28,13 +28,16 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea /** *Sends custom events to Amazon EventBridge so that they can be matched to rules.
- *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. - * To learn more, see - * Calculating PutEvents event entry size in the Amazon EventBridge User Guide + *
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. To + * learn more, see Calculating PutEvents event entry + * size in the + * Amazon EventBridge User Guide + * *
- *PutEvents accepts the data in JSON format. For the JSON number - * (integer) data type, the constraints are: a minimum value of - * -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.
+ *PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the + * constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of + * 9,223,372,036,854,775,807.
*PutEvents will only process nested JSON up to 1100 levels deep.
*This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services - * customers do not use this operation.
- *For information on calculating event batch size, see - * Calculating EventBridge PutEvents event entry size - * in the EventBridge User Guide.
+ *This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
+ *For information on calculating event batch size, see Calculating EventBridge PutEvents event + * entry size in the EventBridge User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/PutPermissionCommand.ts b/clients/client-eventbridge/src/commands/PutPermissionCommand.ts index 1fb37286bb4d2..1b6b4e2b26986 100644 --- a/clients/client-eventbridge/src/commands/PutPermissionCommand.ts +++ b/clients/client-eventbridge/src/commands/PutPermissionCommand.ts @@ -27,22 +27,22 @@ export interface PutPermissionCommandInput extends PutPermissionRequest {} export interface PutPermissionCommandOutput extends __MetadataBearer {} /** - *Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization
- * to put events to the specified event bus. Amazon EventBridge (CloudWatch
- * Events) rules in your account are triggered by these events arriving to an event bus in your
- * account.
Running PutPermission permits the specified Amazon Web Services account or
+ * Amazon Web Services organization to put events to the specified event
+ * bus. Amazon EventBridge (CloudWatch Events) rules in your account are
+ * triggered by these events arriving to an event bus in your account.
For another account to send events to your account, that external account must have an * EventBridge rule with your account's event bus as a target.
*To enable multiple Amazon Web Services accounts to put events to your event bus, run
* PutPermission once for each of these accounts. Or, if all the accounts are
- * members of the same Amazon Web Services organization, you can run PutPermission once specifying
- * Principal as "*" and specifying the Amazon Web Services organization ID in
- * Condition, to grant permissions to all accounts in that organization.
PutPermission
+ * once specifying Principal as "*" and specifying the Amazon Web Services
+ * organization ID in Condition, to grant permissions to all accounts in that
+ * organization.
* If you grant permissions using an organization, then accounts in that organization must
* specify a RoleArn with proper permissions when they use PutTarget to
* add your account's event bus as a target. For more information, see Sending and
- * Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User
- * Guide.
The permission policy on the event bus cannot exceed 10 KB in size.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-eventbridge/src/commands/PutRuleCommand.ts b/clients/client-eventbridge/src/commands/PutRuleCommand.ts index 311d6f60b2cca..216cc6a41ae49 100644 --- a/clients/client-eventbridge/src/commands/PutRuleCommand.ts +++ b/clients/client-eventbridge/src/commands/PutRuleCommand.ts @@ -29,11 +29,10 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer /** *Creates or updates the specified rule. Rules are enabled by default, or based on value of * the state. You can disable a rule using DisableRule.
- *A single rule watches for events from a single event bus. Events generated by Amazon Web Services services - * go to your account's default event bus. Events generated by SaaS partner services or - * applications go to the matching partner event bus. If you have custom applications or - * services, you can specify whether their events go to your default event bus or a custom event - * bus that you have created. For more information, see CreateEventBus.
+ *A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner + * services or applications go to the matching partner event bus. If you have custom applications + * or services, you can specify whether their events go to your default event bus or a custom + * event bus that you have created. For more information, see CreateEventBus.
*If you are updating an existing rule, the rule is replaced with what you specify in this
* PutRule command. If you omit arguments in PutRule, the old values
* for those arguments are not kept. Instead, they are replaced with null values.
events:PutRule and events:TagResource permissions.
* If you are updating an existing rule, any tags you specify in the PutRule
* operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). - * However, EventBridge uses an exact match in event patterns and rules. Be sure to use the - * correct ARN characters when creating event patterns so that they match the ARN syntax in the - * event you want to match.
+ *Most services in Amazon Web Services treat : or / as the same character in Amazon Resource + * Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to + * use the correct ARN characters when creating event patterns so that they match the ARN syntax + * in the event you want to match.
*In EventBridge, it is possible to create rules that lead to infinite loops, where a rule * is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, * and trigger software to change them to the desired state. If the rule is not written @@ -116,8 +115,8 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer * quota.
* * @throws {@link ManagedRuleException} (client fault) - *This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
- * service. If you see this error in response to DeleteRule or
+ *
This rule was created by an Amazon Web Services service on behalf of your account. It is
+ * managed by that service. If you see this error in response to DeleteRule or
* RemoveTargets, you can use the Force parameter in those calls to
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
* using DisableRule, EnableRule, PutTargets,
diff --git a/clients/client-eventbridge/src/commands/PutTargetsCommand.ts b/clients/client-eventbridge/src/commands/PutTargetsCommand.ts
index 9b5266fcca108..76291922e8117 100644
--- a/clients/client-eventbridge/src/commands/PutTargetsCommand.ts
+++ b/clients/client-eventbridge/src/commands/PutTargetsCommand.ts
@@ -35,7 +35,9 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB
*
Each rule can have up to five (5) targets associated with it at one time.
* *For a list of services you can configure as targets for events, see EventBridge targets - * in the Amazon EventBridge User Guide.
+ * in the + * Amazon EventBridge User Guide + * . *Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The * built-in targets are:
*
- * Amazon EC2 TerminateInstances API
- * call
+ * Amazon EC2 TerminateInstances API call
*
For some target types, PutTargets provides target-specific parameters. If the
- * target is a Kinesis data stream, you can optionally specify which shard the event goes to by
- * using the KinesisParameters argument. To invoke a command on multiple EC2
- * instances with one rule, you can use the RunCommandParameters field.
KinesisParameters argument. To invoke a command on multiple
+ * EC2 instances with one rule, you can use the RunCommandParameters field.
* To be able to make API calls against the resources that you own, Amazon EventBridge - * needs the appropriate permissions: - *
+ * needs the appropriate permissions: *For Lambda and Amazon SNS - * resources, EventBridge relies on resource-based policies.
+ *For Lambda and Amazon SNS resources, EventBridge relies + * on resource-based policies.
*For EC2 instances, Kinesis Data Streams,
- * Step Functions state machines and API Gateway APIs, EventBridge relies on
- * IAM roles that you specify in the RoleARN argument in PutTargets.
For EC2 instances, Kinesis Data Streams, Step Functions state machines and
+ * API Gateway APIs, EventBridge relies on IAM roles that you specify in the
+ * RoleARN argument in PutTargets.
For more information, see Authentication - * and Access Control in the Amazon EventBridge User Guide.
- *If another Amazon Web Services account is in the same region and has granted you permission (using
- * PutPermission), you can send events to that account. Set that account's event
- * bus as a target of the rules in your account. To send the matched events to the other account,
- * specify that account's event bus as the Arn value when you run
+ * and Access Control in the
+ * Amazon EventBridge User Guide
+ * .
If another Amazon Web Services account is in the same region and has granted you permission
+ * (using PutPermission), you can send events to that account. Set that account's
+ * event bus as a target of the rules in your account. To send the matched events to the other
+ * account, specify that account's event bus as the Arn value when you run
* PutTargets. If your account sends events to another account, your account is
* charged for each sent event. Each event sent to another account is charged as a custom event.
- * The account receiving the event is not charged. For more information, see Amazon EventBridge
- * Pricing.
* Input, InputPath, and InputTransformer are not
- * available with PutTarget if the target is an event bus of a different Amazon Web Services
- * account.
PutTarget if the target is an event bus of a different Amazon Web Services account.
* If you are setting the event bus of another account as the target, and that account
* granted permission to your account through an organization instead of directly by the account
* ID, then you must specify a RoleArn with proper permissions in the
* Target structure. For more information, see Sending and
- * Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User
- * Guide.
If you have an IAM role on a cross-account event bus target,
- * a PutTargets call without a role on the same target (same Id and Arn) will not remove the role.
If you have an IAM role on a cross-account event bus target, a PutTargets
+ * call without a role on the same target (same Id and Arn) will not
+ * remove the role.
For more information about enabling cross-account events, see PutPermission.
*@@ -310,8 +310,8 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB * quota.
* * @throws {@link ManagedRuleException} (client fault) - *This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
- * service. If you see this error in response to DeleteRule or
+ *
This rule was created by an Amazon Web Services service on behalf of your account. It is
+ * managed by that service. If you see this error in response to DeleteRule or
* RemoveTargets, you can use the Force parameter in those calls to
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
* using DisableRule, EnableRule, PutTargets,
diff --git a/clients/client-eventbridge/src/commands/RemovePermissionCommand.ts b/clients/client-eventbridge/src/commands/RemovePermissionCommand.ts
index 38b245bc6759a..6d72ab44d6d1f 100644
--- a/clients/client-eventbridge/src/commands/RemovePermissionCommand.ts
+++ b/clients/client-eventbridge/src/commands/RemovePermissionCommand.ts
@@ -27,10 +27,10 @@ export interface RemovePermissionCommandInput extends RemovePermissionRequest {}
export interface RemovePermissionCommandOutput extends __MetadataBearer {}
/**
- *
Revokes the permission of another Amazon Web Services account to be able to put events to the specified
- * event bus. Specify the account to revoke by the StatementId value that you
- * associated with the account when you granted it permission with PutPermission.
- * You can find the StatementId by using DescribeEventBus.
Revokes the permission of another Amazon Web Services account to be able to put events to
+ * the specified event bus. Specify the account to revoke by the StatementId value
+ * that you associated with the account when you granted it permission with
+ * PutPermission. You can find the StatementId by using DescribeEventBus.
Removes the specified targets from the specified rule. When the rule is triggered, those * targets are no longer be invoked.
*A successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.
A successful execution of RemoveTargets doesn't guarantee all targets are
+ * removed from the rule, it means that the target(s) listed in the request are removed.
When you remove a target, when the associated rule triggers, removed targets might * continue to be invoked. Allow a short period of time for changes to take effect.
@@ -80,8 +81,8 @@ export interface RemoveTargetsCommandOutput extends RemoveTargetsResponse, __Met *This exception occurs due to unexpected causes.
* * @throws {@link ManagedRuleException} (client fault) - *This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
- * service. If you see this error in response to DeleteRule or
+ *
This rule was created by an Amazon Web Services service on behalf of your account. It is
+ * managed by that service. If you see this error in response to DeleteRule or
* RemoveTargets, you can use the Force parameter in those calls to
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
* using DisableRule, EnableRule, PutTargets,
diff --git a/clients/client-eventbridge/src/commands/TagResourceCommand.ts b/clients/client-eventbridge/src/commands/TagResourceCommand.ts
index 40e39252e8a4f..50e7566b2f8f4 100644
--- a/clients/client-eventbridge/src/commands/TagResourceCommand.ts
+++ b/clients/client-eventbridge/src/commands/TagResourceCommand.ts
@@ -31,8 +31,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
* help you organize and categorize your resources. You can also use them to scope user
* permissions by granting a user permission to access or change only resources with certain tag
* values. In EventBridge, rules and event buses can be tagged.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of - * characters.
+ *Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as + * strings of characters.
*You can use the TagResource action with a resource that already has tags. If
* you specify a new tag key, this tag is appended to the list of tags associated with the
* resource. If you specify a tag key that is already associated with the resource, the new tag
@@ -72,8 +72,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
*
This exception occurs due to unexpected causes.
* * @throws {@link ManagedRuleException} (client fault) - *This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
- * service. If you see this error in response to DeleteRule or
+ *
This rule was created by an Amazon Web Services service on behalf of your account. It is
+ * managed by that service. If you see this error in response to DeleteRule or
* RemoveTargets, you can use the Force parameter in those calls to
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
* using DisableRule, EnableRule, PutTargets,
diff --git a/clients/client-eventbridge/src/commands/TestEventPatternCommand.ts b/clients/client-eventbridge/src/commands/TestEventPatternCommand.ts
index b2a3651622c8f..4a0a4dbce0843 100644
--- a/clients/client-eventbridge/src/commands/TestEventPatternCommand.ts
+++ b/clients/client-eventbridge/src/commands/TestEventPatternCommand.ts
@@ -28,10 +28,10 @@ export interface TestEventPatternCommandOutput extends TestEventPatternResponse,
/**
*
Tests whether the specified event pattern matches the provided event.
- *Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). - * However, EventBridge uses an exact match in event patterns and rules. Be sure to use the - * correct ARN characters when creating event patterns so that they match the ARN syntax in the - * event you want to match.
+ *Most services in Amazon Web Services treat : or / as the same character in Amazon Resource + * Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be + * sure to use the correct ARN characters when creating event patterns so that they match the ARN + * syntax in the event you want to match.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/UntagResourceCommand.ts b/clients/client-eventbridge/src/commands/UntagResourceCommand.ts index 9705f5b2ab354..d89d10ce149a2 100644 --- a/clients/client-eventbridge/src/commands/UntagResourceCommand.ts +++ b/clients/client-eventbridge/src/commands/UntagResourceCommand.ts @@ -60,8 +60,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *This exception occurs due to unexpected causes.
* * @throws {@link ManagedRuleException} (client fault) - *This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
- * service. If you see this error in response to DeleteRule or
+ *
This rule was created by an Amazon Web Services service on behalf of your account. It is
+ * managed by that service. If you see this error in response to DeleteRule or
* RemoveTargets, you can use the Force parameter in those calls to
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
* using DisableRule, EnableRule, PutTargets,
diff --git a/clients/client-eventbridge/src/commands/UpdateEndpointCommand.ts b/clients/client-eventbridge/src/commands/UpdateEndpointCommand.ts
index f1768a5132a6a..bf6a0e410918d 100644
--- a/clients/client-eventbridge/src/commands/UpdateEndpointCommand.ts
+++ b/clients/client-eventbridge/src/commands/UpdateEndpointCommand.ts
@@ -27,7 +27,11 @@ export interface UpdateEndpointCommandInput extends UpdateEndpointRequest {}
export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __MetadataBearer {}
/**
- *
Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
+ *Update an existing endpoint. For more information about global endpoints, see Making + * applications Regional-fault tolerant with global endpoints and event replication in + * the + * Amazon EventBridge User Guide + * .
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eventbridge/src/commands/UpdateEventBusCommand.ts b/clients/client-eventbridge/src/commands/UpdateEventBusCommand.ts new file mode 100644 index 0000000000000..943bd4d9d3890 --- /dev/null +++ b/clients/client-eventbridge/src/commands/UpdateEventBusCommand.ts @@ -0,0 +1,104 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient"; +import { UpdateEventBusRequest, UpdateEventBusResponse } from "../models/models_0"; +import { de_UpdateEventBusCommand, se_UpdateEventBusCommand } from "../protocols/Aws_json1_1"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UpdateEventBusCommand}. + */ +export interface UpdateEventBusCommandInput extends UpdateEventBusRequest {} +/** + * @public + * + * The output of {@link UpdateEventBusCommand}. + */ +export interface UpdateEventBusCommandOutput extends UpdateEventBusResponse, __MetadataBearer {} + +/** + *Updates the specified event bus.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, UpdateEventBusCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, UpdateEventBusCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const input = { // UpdateEventBusRequest + * Name: "STRING_VALUE", + * KmsKeyIdentifier: "STRING_VALUE", + * Description: "STRING_VALUE", + * DeadLetterConfig: { // DeadLetterConfig + * Arn: "STRING_VALUE", + * }, + * }; + * const command = new UpdateEventBusCommand(input); + * const response = await client.send(command); + * // { // UpdateEventBusResponse + * // Arn: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // KmsKeyIdentifier: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // DeadLetterConfig: { // DeadLetterConfig + * // Arn: "STRING_VALUE", + * // }, + * // }; + * + * ``` + * + * @param UpdateEventBusCommandInput - {@link UpdateEventBusCommandInput} + * @returns {@link UpdateEventBusCommandOutput} + * @see {@link UpdateEventBusCommandInput} for command's `input` shape. + * @see {@link UpdateEventBusCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape. + * + * @throws {@link ConcurrentModificationException} (client fault) + *There is concurrent modification on a rule, target, archive, or replay.
+ * + * @throws {@link InternalException} (server fault) + *This exception occurs due to unexpected causes.
+ * + * @throws {@link OperationDisabledException} (client fault) + *The operation you are attempting is not available in this region.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *An entity that you specified does not exist.
+ * + * @throws {@link EventBridgeServiceException} + *Base exception class for all service exceptions from EventBridge service.
+ * + * @public + */ +export class UpdateEventBusCommand extends $Command + .classBuilder< + UpdateEventBusCommandInput, + UpdateEventBusCommandOutput, + EventBridgeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: EventBridgeClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSEvents", "UpdateEventBus", {}) + .n("EventBridgeClient", "UpdateEventBusCommand") + .f(void 0, void 0) + .ser(se_UpdateEventBusCommand) + .de(de_UpdateEventBusCommand) + .build() {} diff --git a/clients/client-eventbridge/src/commands/index.ts b/clients/client-eventbridge/src/commands/index.ts index 515ed4d4cec3f..da06654cddd22 100644 --- a/clients/client-eventbridge/src/commands/index.ts +++ b/clients/client-eventbridge/src/commands/index.ts @@ -55,3 +55,4 @@ export * from "./UpdateApiDestinationCommand"; export * from "./UpdateArchiveCommand"; export * from "./UpdateConnectionCommand"; export * from "./UpdateEndpointCommand"; +export * from "./UpdateEventBusCommand"; diff --git a/clients/client-eventbridge/src/index.ts b/clients/client-eventbridge/src/index.ts index cb1a18472e874..8429e4b90be1a 100644 --- a/clients/client-eventbridge/src/index.ts +++ b/clients/client-eventbridge/src/index.ts @@ -1,19 +1,19 @@ // smithy-typescript generated code /* eslint-disable */ /** - *Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your - * resources change state, they automatically send events to an event stream. You can create - * rules that match selected events in the stream and route them to targets to take action. You - * can also use rules to take action on a predetermined schedule. For example, you can configure - * rules to:
+ *Amazon EventBridge helps you to respond to state changes in your Amazon Web Services + * resources. When your resources change state, they automatically send events to an event + * stream. You can create rules that match selected events in the stream and route them to + * targets to take action. You can also use rules to take action on a predetermined schedule. For + * example, you can configure rules to:
*Automatically invoke an Lambda function to update DNS entries when an event - * notifies you that Amazon EC2 instance enters the running state.
+ *Automatically invoke an Lambda function to update DNS entries when an + * event notifies you that Amazon EC2 instance enters the running state.
*Direct specific API records from CloudTrail to an Amazon Kinesis data stream for - * detailed analysis of potential security or availability risks.
+ *Direct specific API records from CloudTrail to an Amazon Kinesis + * data stream for detailed analysis of potential security or availability risks.
*Periodically invoke a built-in target to create a snapshot of an Amazon EBS diff --git a/clients/client-eventbridge/src/models/models_0.ts b/clients/client-eventbridge/src/models/models_0.ts index ffe552522152c..7a77b53250a69 100644 --- a/clients/client-eventbridge/src/models/models_0.ts +++ b/clients/client-eventbridge/src/models/models_0.ts @@ -208,12 +208,14 @@ export interface ApiDestination { } /** - *
Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
+ *Contains the GraphQL operation to be parsed and executed, if the event target is an + * AppSync API.
* @public */ export interface AppSyncParameters { /** - *The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.
+ *The GraphQL operation; that is, the query, mutation, or subscription to be parsed and + * executed by the GraphQL service.
*For more information, see Operations in the AppSync User Guide.
* @public */ @@ -957,14 +959,16 @@ export interface ReplicationConfig { */ export interface Primary { /** - *The ARN of the health check used by the endpoint to determine whether failover is triggered.
+ *The ARN of the health check used by the endpoint to determine whether failover is + * triggered.
* @public */ HealthCheck: string | undefined; } /** - *The secondary Region that processes events when failover is triggered or replication is enabled.
+ *The secondary Region that processes events when failover is triggered or replication is + * enabled.
* @public */ export interface Secondary { @@ -976,7 +980,8 @@ export interface Secondary { } /** - *The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
+ *The failover configuration for an endpoint. This includes what triggers failover and what + * happens when it's triggered.
* @public */ export interface FailoverConfig { @@ -987,7 +992,8 @@ export interface FailoverConfig { Primary: Primary | undefined; /** - *The Region that events are routed to when failover is triggered or event replication is enabled.
+ *The Region that events are routed to when failover is triggered or event replication is + * enabled.
* @public */ Secondary: Secondary | undefined; @@ -999,7 +1005,8 @@ export interface FailoverConfig { */ export interface RoutingConfig { /** - *The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
+ *The failover configuration for an endpoint. This includes what triggers failover and what + * happens when it's triggered.
* @public */ FailoverConfig: FailoverConfig | undefined; @@ -1010,7 +1017,8 @@ export interface RoutingConfig { */ export interface CreateEndpointRequest { /** - *The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".
The name of the global endpoint. For example,
+ * "Name":"us-east-2-custom_bus_A-endpoint".
Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a
- * RoleArn or you don't want event replication enabled, set the state to DISABLED.
Enable or disable event replication. The default state is ENABLED which means
+ * you must supply a RoleArn. If you don't have a RoleArn or you don't
+ * want event replication enabled, set the state to DISABLED.
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses - * support tagging.
+ *Configuration details of the Amazon SQS queue for EventBridge to use as a + * dead-letter queue (DLQ).
+ *For more information, see Event + * retry policy and using dead-letter queues in the EventBridge User + * Guide.
+ * @public + */ +export interface DeadLetterConfig { + /** + *The ARN of the SQS queue specified as the target for the dead-letter queue.
+ * @public + */ + Arn?: string; +} + +/** + *A key-value pair associated with an Amazon Web Services resource. In EventBridge, + * rules and event buses support tagging.
* @public */ export interface Tag { @@ -1142,10 +1167,12 @@ export interface Tag { export interface CreateEventBusRequest { /** *The name of the new event bus.
- *Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event
- * source that this event bus is matched to.
You can't use the name default for a custom event bus, as this name is already used for your account's
- * default event bus.
Custom event bus names can't contain the / character, but you can use the
+ * / character in partner event bus names. In addition, for partner event buses,
+ * the name must exactly match the name of the partner event source that this event bus is
+ * matched to.
You can't use the name default for a custom event bus, as this name is
+ * already used for your account's default event bus.
The event bus description.
+ * @public + */ + Description?: string; + + /** + *The identifier of the KMS + * customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key + * Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
+ *If you do not specify a customer managed key identifier, EventBridge uses an + * Amazon Web Services owned key to encrypt events on the event bus.
+ *For more information, see Managing keys in the Key Management Service + * Developer Guide.
+ *Archives and schema discovery are not supported for event buses encrypted using a + * customer managed key. EventBridge returns an error if:
+ *You call
+ * CreateArchive
+ * on an event bus set to use a customer managed key for encryption.
You call
+ * CreateDiscoverer
+ * on an event bus set to use a customer managed key for encryption.
You call
+ * UpdatedEventBus
+ * to set a customer managed key on an event bus with an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to + * use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
+ *Configuration details of the Amazon SQS queue for EventBridge to use as a + * dead-letter queue (DLQ).
+ *For more information, see Event + * retry policy and using dead-letter queues in the EventBridge User + * Guide.
+ * @public + */ + DeadLetterConfig?: DeadLetterConfig; + /** *Tags to associate with the event bus.
* @public @@ -1173,6 +1251,30 @@ export interface CreateEventBusResponse { * @public */ EventBusArn?: string; + + /** + *The event bus description.
+ * @public + */ + Description?: string; + + /** + *The identifier of the KMS + * customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.
+ *For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
+ * @public + */ + KmsKeyIdentifier?: string; + + /** + *Configuration details of the Amazon SQS queue for EventBridge to use as a + * dead-letter queue (DLQ).
+ *For more information, see Event + * retry policy and using dead-letter queues in the EventBridge User + * Guide.
+ * @public + */ + DeadLetterConfig?: DeadLetterConfig; } /** @@ -1184,15 +1286,15 @@ export interface CreatePartnerEventSourceRequest { *
* partner_name/event_namespace/event_name
* .
- * The Amazon Web Services account that wants to use this partner event source must create a partner event bus
- * with a name that matches the name of the partner event source.
+ * The Amazon Web Services account that wants to use this partner event source must create a
+ * partner event bus with a name that matches the name of the partner event source.
* @public
*/
Name: string | undefined;
/**
- * The Amazon Web Services account ID that is permitted to create a matching partner event bus for this - * partner event source.
+ *The Amazon Web Services account ID that is permitted to create a matching partner event bus + * for this partner event source.
* @public */ Account: string | undefined; @@ -1351,7 +1453,8 @@ export interface DeleteConnectionResponse { */ export interface DeleteEndpointRequest { /** - *The name of the endpoint you want to delete. For example, "Name":"us-east-2-custom_bus_A-endpoint"..
The name of the endpoint you want to delete. For example,
+ * "Name":"us-east-2-custom_bus_A-endpoint"..
The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.
+ *The Amazon Web Services account ID of the Amazon Web Services customer that the event source + * was created for.
* @public */ Account: string | undefined; @@ -1408,19 +1512,19 @@ export interface DeleteRuleRequest { EventBusName?: string; /** - *If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
- * Force as True to delete the rule. This parameter is ignored for
- * rules that are not managed rules. You can check whether a rule is a managed rule by using
- * DescribeRule or ListRules and checking the ManagedBy
- * field of the response.
If this is a managed rule, created by an Amazon Web Services service on your behalf, you
+ * must specify Force as True to delete the rule. This parameter is
+ * ignored for rules that are not managed rules. You can check whether a rule is a managed rule
+ * by using DescribeRule or ListRules and checking the
+ * ManagedBy field of the response.
This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
- * service. If you see this error in response to DeleteRule or
+ *
This rule was created by an Amazon Web Services service on behalf of your account. It is
+ * managed by that service. If you see this error in response to DeleteRule or
* RemoveTargets, you can use the Force parameter in those calls to
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
* using DisableRule, EnableRule, PutTargets,
@@ -1796,13 +1900,15 @@ export interface DescribeConnectionResponse {
*/
export interface DescribeEndpointRequest {
/**
- *
The name of the endpoint you want to get information about. For example, "Name":"us-east-2-custom_bus_A-endpoint".
The name of the endpoint you want to get information about. For example,
+ * "Name":"us-east-2-custom_bus_A-endpoint".
The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".
The primary Region of the endpoint you want to get information about. For example
+ * "HomeRegion": "us-east-1".
Whether replication is enabled or disabled for the endpoint you asked for information about.
+ *Whether replication is enabled or disabled for the endpoint you asked for information + * about.
* @public */ ReplicationConfig?: ReplicationConfig; @@ -1914,17 +2021,52 @@ export interface DescribeEventBusResponse { Name?: string; /** - *The Amazon Resource Name (ARN) of the account permitted to write events to the current - * account.
+ *The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
* @public */ Arn?: string; + /** + *The event bus description.
+ * @public + */ + Description?: string; + + /** + *The identifier of the KMS + * customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.
+ *For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
+ * @public + */ + KmsKeyIdentifier?: string; + + /** + *Configuration details of the Amazon SQS queue for EventBridge to use as a + * dead-letter queue (DLQ).
+ *For more information, see Event + * retry policy and using dead-letter queues in the EventBridge User + * Guide.
+ * @public + */ + DeadLetterConfig?: DeadLetterConfig; + /** *The policy that enables the external account to send events to your account.
* @public */ Policy?: string; + + /** + *The time the event bus was created.
+ * @public + */ + CreationTime?: Date; + + /** + *The time the event bus was last modified.
+ * @public + */ + LastModifiedTime?: Date; } /** @@ -2184,7 +2326,9 @@ export interface DescribeRuleResponse { /** *The event pattern. For more information, see Events and Event - * Patterns in the Amazon EventBridge User Guide.
+ * Patterns in the + * Amazon EventBridge User Guide + * . * @public */ EventPattern?: string; @@ -2214,8 +2358,9 @@ export interface DescribeRuleResponse { RoleArn?: string; /** - *If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays - * the principal name of the Amazon Web Services service that created the rule.
+ *If this is a managed rule, created by an Amazon Web Services service on your behalf, this + * field displays the principal name of the Amazon Web Services service that created the + * rule.
* @public */ ManagedBy?: string; @@ -2483,21 +2628,26 @@ export interface ListConnectionsResponse { */ export interface ListEndpointsRequest { /** - *A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.
A value that will return a subset of the endpoints associated with this account. For
+ * example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the
+ * name.
The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".
The primary Region of the endpoints associated with this account. For example
+ * "HomeRegion": "us-east-1".
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
- * Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
- * token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of
+ * nextToken is a unique pagination token for each page. Make the call again using
+ * the returned token to retrieve the next page. Keep all other arguments unchanged. Each
+ * pagination token expires after 24 hours. Using an expired pagination token will return an HTTP
+ * 400 InvalidToken error.
A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
+ *A global endpoint used to improve your application's availability by making it + * regional-fault tolerant. For more information about global endpoints, see Making + * applications Regional-fault tolerant with global endpoints and event replication in + * the + * Amazon EventBridge User Guide + * .
* @public */ export interface Endpoint { @@ -2539,8 +2694,10 @@ export interface Endpoint { RoutingConfig?: RoutingConfig; /** - *Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn.
- * If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.
Whether event replication was enabled or disabled for this endpoint. The default state is
+ * ENABLED which means you must supply a RoleArn. If you don't have a
+ * RoleArn or you don't want event replication enabled, set the state to
+ * DISABLED.
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 abcde.veo.
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
+ * abcde.veo.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
- * Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
- * token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of
+ * nextToken is a unique pagination token for each page. Make the call again using
+ * the returned token to retrieve the next page. Keep all other arguments unchanged. Each
+ * pagination token expires after 24 hours. Using an expired pagination token will return an HTTP
+ * 400 InvalidToken error.
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). - * Your account's default event bus receives events from Amazon Web Services services. A custom event - * bus can receive events from your custom applications and services. A partner event bus - * receives events from an event source created by an SaaS partner. These events come from the - * partners services or applications.
+ *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). Your account's + * default event bus receives events from Amazon Web Services services. A custom event bus can + * receive events from your custom applications and services. A partner event bus receives events + * from an event source created by an SaaS partner. These events come from the partners services + * or applications.
* @public */ export interface EventBus { @@ -2661,11 +2823,29 @@ export interface EventBus { Arn?: string; /** - *The permissions policy of the event bus, describing which other Amazon Web Services accounts can write - * events to this event bus.
+ *The event bus description.
+ * @public + */ + Description?: string; + + /** + *The permissions policy of the event bus, describing which other Amazon Web Services + * accounts can write events to this event bus.
* @public */ Policy?: string; + + /** + *The time the event bus was created.
+ * @public + */ + CreationTime?: Date; + + /** + *The time the event bus was last modified.
+ * @public + */ + LastModifiedTime?: Date; } /** @@ -2713,8 +2893,8 @@ export interface ListEventSourcesRequest { /** *A partner event source is created by an SaaS partner. If a customer creates a partner - * event bus that matches this event source, that Amazon Web Services account can receive events from the - * partner's applications or services.
+ * event bus that matches this event source, that Amazon Web Services account can receive events + * from the partner's applications or services. * @public */ export interface EventSource { @@ -2737,8 +2917,8 @@ export interface EventSource { CreationTime?: Date; /** - *The date and time that the event source will expire, if the Amazon Web Services account doesn't create a - * matching event bus for it.
+ *The date and time that the event source will expire, if the Amazon Web Services account + * doesn't create a matching event bus for it.
* @public */ ExpirationTime?: Date; @@ -2820,8 +3000,8 @@ export interface PartnerEventSourceAccount { CreationTime?: Date; /** - *The date and time that the event source will expire, if the Amazon Web Services account doesn't create a - * matching event bus for it.
+ *The date and time that the event source will expire, if the Amazon Web Services account + * doesn't create a matching event bus for it.
* @public */ ExpirationTime?: Date; @@ -2882,8 +3062,8 @@ export interface ListPartnerEventSourcesRequest { /** *A partner event source is created by an SaaS partner. If a customer creates a partner - * event bus that matches this event source, that Amazon Web Services account can receive events from the - * partner's applications or services.
+ * event bus that matches this event source, that Amazon Web Services account can receive events + * from the partner's applications or services. * @public */ export interface PartnerEventSource { @@ -3129,13 +3309,42 @@ export interface Rule { /** *The event pattern of the rule. For more information, see Events and Event - * Patterns in the Amazon EventBridge User Guide.
+ * Patterns in the + * Amazon EventBridge User Guide + * . * @public */ EventPattern?: string; /** *The state of the rule.
+ *Valid values include:
+ *
+ * DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
+ * ENABLED: The rule is enabled.
+ * EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
+ * ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all
+ * events, including Amazon Web Services management events delivered through CloudTrail.
Management events provide visibility into management operations that are performed on + * resources in your Amazon Web Services account. These are also known as control plane + * operations. For more information, see Logging management events in the CloudTrail User + * Guide, and Filtering management events from Amazon Web Services services in the + * + * Amazon EventBridge User Guide + * .
+ *This value is only valid for rules on the default event bus + * or custom event buses. + * It does not apply to partner event buses.
+ *The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
+ *The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more + * information, see Creating an Amazon EventBridge rule + * that runs on a schedule.
* @public */ ScheduleExpression?: string; @@ -3163,8 +3374,8 @@ export interface Rule { RoleArn?: string; /** - *If the rule was created on behalf of your account by an Amazon Web Services service, this field displays - * the principal name of the service that created the rule.
+ *If the rule was created on behalf of your account by an Amazon Web Services service, this + * field displays the principal name of the service that created the rule.
* @public */ ManagedBy?: string; @@ -3263,8 +3474,8 @@ export interface BatchArrayProperties { } /** - *The retry strategy to use for failed jobs, if the target is an Batch job. If you - * specify a retry strategy here, it overrides the retry strategy defined in the job + *
The retry strategy to use for failed jobs, if the target is an Batch job. + * If you specify a retry strategy here, it overrides the retry strategy defined in the job * definition.
* @public */ @@ -3282,14 +3493,14 @@ export interface BatchRetryStrategy { */ export interface BatchParameters { /** - *The ARN or name of the job definition to use if the event target is an Batch job. This - * job definition must already exist.
+ *The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
* @public */ JobDefinition: string | undefined; /** - *The name to use for this execution of the job, if the target is an Batch job.
+ *The name to use for this execution of the job, if the target is an Batch + * job.
* @public */ JobName: string | undefined; @@ -3303,28 +3514,15 @@ export interface BatchParameters { ArrayProperties?: BatchArrayProperties; /** - *The retry strategy to use for failed jobs, if the target is an Batch job. The retry - * strategy is the number of times to retry the failed job execution. Valid values are 1–10. When - * you specify a retry strategy here, it overrides the retry strategy defined in the job - * definition.
+ *The retry strategy to use for failed jobs, if the target is an Batch job. + * The retry strategy is the number of times to retry the failed job execution. Valid values are + * 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the + * job definition.
* @public */ RetryStrategy?: BatchRetryStrategy; } -/** - *A DeadLetterConfig object that contains information about a dead-letter queue
- * configuration.
The ARN of the SQS queue specified as the target for the dead-letter queue.
- * @public - */ - Arn?: string; -} - /** *The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
* @public @@ -3428,8 +3626,7 @@ export const PlacementConstraintType = { export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typeof PlacementConstraintType]; /** - *An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer - * Guide.
+ *An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
* @public */ export interface PlacementConstraint { @@ -3443,8 +3640,7 @@ export interface PlacementConstraint { /** *A cluster query language expression to apply to the constraint. You cannot specify an
- * expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
- *
distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
* @public
*/
expression?: string;
@@ -3527,19 +3723,19 @@ export interface EcsParameters {
/**
* Specifies the launch type on which your task is running. The launch type that you specify
* here must match one of the launch type (compatibilities) of the target task. The
- * FARGATE value is supported only in the Regions where Fargate with Amazon ECS
- * is supported. For more information, see Fargate on Amazon ECS in
- * the Amazon Elastic Container Service Developer Guide.
FARGATE value is supported only in the Regions where Fargate
+ * with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer
+ * Guide.
* @public
*/
LaunchType?: LaunchType;
/**
- * Use this structure if the Amazon ECS task uses the awsvpc network mode. This
- * structure specifies the VPC subnets and security groups associated with the task, and whether
- * a public IP address is to be used. This structure is required if LaunchType is
- * FARGATE because the awsvpc mode is required for Fargate
- * tasks.
Use this structure if the Amazon ECS task uses the awsvpc network
+ * mode. This structure specifies the VPC subnets and security groups associated with the task,
+ * and whether a public IP address is to be used. This structure is required if
+ * LaunchType is FARGATE because the awsvpc mode is
+ * required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the
* awsvpc network mode, the task fails.
Specifies the platform version for the task. Specify only the numeric portion of the
* platform version, such as 1.1.0.
This structure is used only if LaunchType is FARGATE. For more
- * information about valid platform versions, see Fargate Platform
- * Versions in the Amazon Elastic Container Service Developer
- * Guide.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, - * see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer - * Guide.
+ *Specifies whether to enable Amazon ECS managed tags for the task. For more + * information, see Tagging Your Amazon ECS + * Resources in the Amazon Elastic Container Service Developer Guide.
* @public */ EnableECSManagedTags?: boolean; @@ -3627,29 +3823,27 @@ export interface EcsParameters { /** *These are custom parameter to be used when the target is an API Gateway APIs or - * EventBridge ApiDestinations. In the latter case, these are merged with any + * EventBridge ApiDestinations. In the latter case, these are merged with any * InvocationParameters specified on the Connection, with any values from the Connection taking * precedence.
* @public */ export interface HttpParameters { /** - *The path parameter values to be used to populate API Gateway API or EventBridge - * ApiDestination path wildcards ("*").
+ *The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
* @public */ PathParameterValues?: string[]; /** *The headers that need to be sent as part of request invoking the API Gateway API or - * EventBridge ApiDestination.
+ * EventBridge ApiDestination. * @public */ HeaderParameters?: RecordThe query string keys/values that need to be sent as part of request invoking the API Gateway - * API or EventBridge ApiDestination.
+ *The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
* @public */ QueryStringParameters?: RecordInput template where you specify placeholders that will be filled with the values of the
* keys from InputPathsMap to customize the data sent to the target. Enclose each
- * InputPathsMaps value in brackets: <value>
- *
InputPathsMaps value in brackets: <value>
* If InputTemplate is a JSON object (surrounded by curly braces), the following
* restrictions apply:
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the - * Amazon Redshift Data API ExecuteStatement based on EventBridge events.
+ *These are custom parameters to be used when the target is a Amazon Redshift cluster + * to invoke the Amazon Redshift Data API + * ExecuteStatement based on EventBridge events.
* @public */ export interface RedshiftDataParameters { @@ -3809,9 +4003,10 @@ export interface RedshiftDataParameters { WithEvent?: boolean; /** - *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. - * Subsequent SQL statements don't start until the previous statement in the array completes. - * If any SQL statement fails, then because they are run as one transaction, all work is rolled back.
+ *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. Subsequent SQL statements don't start until the + * previous statement in the array completes. If any SQL statement fails, then because they are + * run as one transaction, all work is rolled back.
* @public */ Sqls?: string[]; @@ -3884,26 +4079,29 @@ export interface RunCommandParameters { */ export interface SageMakerPipelineParameter { /** - *Name of parameter to start execution of a SageMaker Model Building Pipeline.
+ *Name of parameter to start execution of a SageMaker Model Building + * Pipeline.
* @public */ Name: string | undefined; /** - *Value of parameter to start execution of a SageMaker Model Building Pipeline.
+ *Value of parameter to start execution of a SageMaker Model Building + * Pipeline.
* @public */ Value: string | undefined; } /** - *These are custom parameters to use when the target is a SageMaker Model Building Pipeline - * that starts based on EventBridge events.
+ *These are custom parameters to use when the target is a SageMaker Model Building + * Pipeline that starts based on EventBridge events.
* @public */ export interface SageMakerPipelineParameters { /** - *List of Parameter names and values for SageMaker Model Building Pipeline execution.
+ *List of Parameter names and values for SageMaker Model Building Pipeline + * execution.
* @public */ PipelineParameterList?: SageMakerPipelineParameter[]; @@ -3929,13 +4127,13 @@ export interface SqsParameters { * granted permission to your account through an organization instead of directly by the account * ID, then you must specify aRoleArn with proper permissions in the
* Target structure. For more information, see Sending and
- * Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User
- * Guide.
+ * Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.
* @public
*/
export interface Target {
/**
- * The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
+ *The ID of the target within the specified rule. Use this ID to reference the target when + * updating the rule. We recommend using a memorable and unique string.
* @public */ Id: string | undefined; @@ -3947,9 +4145,8 @@ export interface Target { Arn: string | undefined; /** - *The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is - * triggered. If one rule triggers multiple targets, you can use a different IAM role for each - * target.
+ *The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If + * one rule triggers multiple targets, you can use a different IAM role for each target.
* @public */ RoleArn?: string; @@ -4002,9 +4199,9 @@ export interface Target { EcsParameters?: EcsParameters; /** - *If the event target is an Batch job, this contains the job definition, job name, and - * other parameters. For more information, see Jobs in the Batch User - * Guide.
+ *If the event target is an Batch job, this contains the job definition, job + * name, and other parameters. For more information, see Jobs in the Batch + * User Guide.
* @public */ BatchParameters?: BatchParameters; @@ -4019,30 +4216,29 @@ export interface Target { /** *Contains the HTTP parameters to use when the target is a API Gateway endpoint or - * EventBridge ApiDestination.
- *If you specify an API Gateway API or EventBridge ApiDestination as a target, you can - * use this parameter to specify headers, path parameters, and query string keys/values as part - * of your target invoking request. If you're using ApiDestinations, the corresponding Connection - * can also have these values configured. In case of any conflicting keys, values from the - * Connection take precedence.
+ * EventBridge ApiDestination. + *If you specify an API Gateway API or EventBridge ApiDestination as a target, + * you can use this parameter to specify headers, path parameters, and query string keys/values + * as part of your target invoking request. If you're using ApiDestinations, the corresponding + * Connection can also have these values configured. In case of any conflicting keys, values from + * the Connection take precedence.
* @public */ HttpParameters?: HttpParameters; /** - *Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift - * cluster.
- *If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to - * invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
+ *Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
+ *If you specify a Amazon Redshift Cluster as a Target, you can use this to specify + * parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
* @public */ RedshiftDataParameters?: RedshiftDataParameters; /** *Contains the SageMaker Model Building Pipeline parameters to start execution of a - * SageMaker Model Building Pipeline.
- *If you specify a SageMaker Model Building Pipeline as a target, you can use this to - * specify parameters to start a pipeline execution based on EventBridge events.
+ * SageMaker Model Building Pipeline. + *If you specify a SageMaker Model Building Pipeline as a target, you can use this + * to specify parameters to start a pipeline execution based on EventBridge events.
* @public */ SageMakerPipelineParameters?: SageMakerPipelineParameters; @@ -4062,7 +4258,8 @@ export interface Target { RetryPolicy?: RetryPolicy; /** - *Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
+ *Contains the GraphQL operation to be parsed and executed, if the event target is an + * AppSync API.
* @public */ AppSyncParameters?: AppSyncParameters; @@ -4111,14 +4308,15 @@ export interface PutEventsRequestEntry { Source?: string; /** - *Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily - * concerns. Any number, including zero, may be present.
+ *Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. + * Any number, including zero, may be present.
* @public */ Resources?: string[]; /** - *Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
+ *Free-form string, with a maximum of 128 characters, used to decide what fields to expect + * in the event detail.
*
* Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus.
@@ -4149,18 +4347,20 @@ export interface PutEventsRequestEntry {
* with this event bus are used to match the event. If you omit this, the default event bus is
* used.
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
- * in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the
- * other Region based on the endpoint referenced by the EndpointId. Specifying the event bus ARN is preferred.
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 in either the primary or secondary Region here. EventBridge then
+ * determines the corresponding event bus in the other Region based on the endpoint referenced
+ * by the EndpointId. Specifying the event bus ARN is preferred.
An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the - * trace-id associated with the event.
- *To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
+ *An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that + * contains the trace-id associated with the event.
+ *To learn more about X-Ray trace headers, see Tracing + * header in the X-Ray Developer Guide.
* @public */ TraceHeader?: string; @@ -4179,7 +4379,9 @@ export interface PutEventsRequest { Entries: PutEventsRequestEntry[] | undefined; /** - *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 abcde.veo.
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
+ * abcde.veo.
When using Java, you must include auth-crt on the class path.
Represents the results of an event submitted to an event bus.
- *If the submission was successful, the entry has the event ID in it. - * Otherwise, you can use the error code and error message to identify the problem with the entry.
- *For information about the errors that are common to all actions, see - * Common Errors.
+ *If the submission was successful, the entry has the event ID in it. Otherwise, you can use + * the error code and error message to identify the problem with the entry.
+ *For information about the errors that are common to all actions, see Common + * Errors.
* @public */ export interface PutEventsResultEntry { @@ -4213,7 +4415,8 @@ export interface PutEventsResultEntry { * InternalFailure * * - *The request processing has failed because of an unknown error, exception or failure.
+ *The request processing has failed because of an unknown error, exception or + * failure.
*@@ -4262,13 +4465,15 @@ export interface PutEventsResultEntry { *
* NotAuthorizedForSourceException
*
You do not have permissions to publish events with this source onto this event bus.
+ *You do not have permissions to publish events with this source onto this event + * bus.
*
* NotAuthorizedForDetailTypeException
*
You do not have permissions to publish events with this detail type onto this event bus.
+ *You do not have permissions to publish events with this detail type onto this event + * bus.
*The successfully and unsuccessfully ingested events results. If the ingestion was * successful, the entry has the event ID in it. Otherwise, you can use the error code and error * message to identify the problem with the entry.
- *For each record, the index of the response element is the same as the index in the request array.
+ *For each record, the index of the response element is the same as the index in the request + * array.
* @public */ Entries?: PutEventsResultEntry[]; @@ -4327,14 +4533,15 @@ export interface PutPartnerEventsRequestEntry { Source?: string; /** - *Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily - * concerns. Any number, including zero, may be present.
+ *Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. + * Any number, including zero, may be present.
* @public */ Resources?: string[]; /** - *A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
+ *A free-form string, with a maximum of 128 characters, used to decide what fields to expect + * in the event detail.
*
* Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus.
@@ -4373,9 +4580,9 @@ export interface PutPartnerEventsRequest {
}
/**
- *
The result of an event entry the partner submitted in this request. - * If the event was successfully submitted, the entry has the event ID in it. - * Otherwise, you can use the error code and error message to identify the problem with the entry.
+ *The result of an event entry the partner submitted in this request. If the event was + * successfully submitted, the entry has the event ID in it. Otherwise, you can use the error + * code and error message to identify the problem with the entry.
* @public */ export interface PutPartnerEventsResultEntry { @@ -4410,10 +4617,11 @@ export interface PutPartnerEventsResponse { FailedEntryCount?: number; /** - *The results for each event entry the partner submitted in this request. - * If the event was successfully submitted, the entry has the event ID in it. - * Otherwise, you can use the error code and error message to identify the problem with the entry.
- *For each record, the index of the response element is the same as the index in the request array.
+ *The results for each event entry the partner submitted in this request. If the event was + * successfully submitted, the entry has the event ID in it. Otherwise, you can use the error + * code and error message to identify the problem with the entry.
+ *For each record, the index of the response element is the same as the index in the request + * array.
* @public */ Entries?: PutPartnerEventsResultEntry[]; @@ -4442,9 +4650,10 @@ export class PolicyLengthExceededException extends __BaseException { /** *A JSON string which you can use to limit the event bus permissions you are granting to
* only accounts that fulfill the condition. Currently, the only supported condition is
- * membership in a certain Amazon Web Services organization. The string must contain Type,
- * Key, and Value fields. The Value field specifies the
- * ID of the Amazon Web Services organization. Following is an example value for Condition:
Type, Key, and Value fields. The Value
+ * field specifies the ID of the Amazon Web Services organization. Following is an example value
+ * for Condition:
*
* '\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
* "o-1234567890"\}'
@@ -4492,8 +4701,9 @@ export interface PutPermissionRequest {
Action?: string;
/**
- *
The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event - * bus. Specify "*" to permit any account to put events to your default event bus.
+ *The 12-digit Amazon Web Services account ID that you are permitting to put events to your + * default event bus. Specify "*" to permit any account to put events to your default event + * bus.
*If you specify "*" without specifying Condition, avoid creating rules that
* may match undesirable events. To create more secure rules, make sure that the event pattern
* for each rule contains an account field with a specific account ID from which to
@@ -4506,7 +4716,7 @@ export interface PutPermissionRequest {
/**
*
An identifier string for the external account that you are granting permissions to. If you
* later want to revoke the permission for this external account, specify this
- * StatementId when you run RemovePermission.
StatementId when you run RemovePermission.
* Each StatementId must be unique.
This parameter enables you to limit the permission to accounts that fulfill a certain - * condition, such as being a member of a certain Amazon Web Services organization. For more information about - * Amazon Web Services Organizations, see What Is Amazon Web Services - * Organizations in the Amazon Web Services Organizations User Guide.
- *If you specify Condition with an Amazon Web Services organization ID, and specify "*" as the
- * value for Principal, you grant permission to all the accounts in the named
- * organization.
If you specify Condition with an Amazon Web Services organization ID, and
+ * specify "*" as the value for Principal, you grant permission to all the accounts
+ * in the named organization.
The Condition is a JSON string which must contain Type,
* Key, and Value fields.
The event pattern. For more information, see Amazon EventBridge event - * patterns in the Amazon EventBridge User Guide.
+ * patterns in the + * Amazon EventBridge User Guide + * . * @public */ EventPattern?: string; /** - *Indicates whether the rule is enabled or disabled.
+ *The state of the rule.
+ *Valid values include:
+ *
+ * DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
+ * ENABLED: The rule is enabled.
+ * EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
+ * ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all
+ * events, including Amazon Web Services management events delivered through CloudTrail.
Management events provide visibility into management operations that are performed on + * resources in your Amazon Web Services account. These are also known as control plane + * operations. For more information, see Logging management events in the CloudTrail User + * Guide, and Filtering management events from Amazon Web Services services in the + * + * Amazon EventBridge User Guide + * .
+ *This value is only valid for rules on the default event bus + * or custom event buses. + * It does not apply to partner event buses.
+ *If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
- * Force as True to remove targets. This parameter is ignored for
- * rules that are not managed rules. You can check whether a rule is a managed rule by using
- * DescribeRule or ListRules and checking the ManagedBy
- * field of the response.
If this is a managed rule, created by an Amazon Web Services service on your behalf, you
+ * must specify Force as True to remove targets. This parameter is
+ * ignored for rules that are not managed rules. You can check whether a rule is a managed rule
+ * by using DescribeRule or ListRules and checking the
+ * ManagedBy field of the response.
The event pattern. For more information, see Events and Event - * Patterns in the Amazon EventBridge User Guide.
+ * Patterns in the + * Amazon EventBridge User Guide + * . * @public */ EventPattern: string | undefined; /** *The event, in JSON format, to test against the event pattern. The JSON must follow the - * format specified in Amazon Web Services Events, and the following - * fields are mandatory:
+ * format specified in Amazon Web Services Events, and + * the following fields are mandatory: *@@ -5338,7 +5580,8 @@ export interface UpdateEndpointResponse { RoutingConfig?: RoutingConfig; /** - *
Whether event replication was enabled or disabled for the endpoint you updated in this request.
+ *Whether event replication was enabled or disabled for the endpoint you updated in this + * request.
* @public */ ReplicationConfig?: ReplicationConfig; @@ -5350,7 +5593,8 @@ export interface UpdateEndpointResponse { EventBuses?: EndpointEventBus[]; /** - *The ARN of the role used by event replication for the endpoint you updated in this request.
+ *The ARN of the role used by event replication for the endpoint you updated in this + * request.
* @public */ RoleArn?: string; @@ -5374,6 +5618,109 @@ export interface UpdateEndpointResponse { State?: EndpointState; } +/** + * @public + */ +export interface UpdateEventBusRequest { + /** + *The name of the event bus.
+ * @public + */ + Name?: string; + + /** + *The identifier of the KMS + * customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key + * Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
+ *If you do not specify a customer managed key identifier, EventBridge uses an + * Amazon Web Services owned key to encrypt events on the event bus.
+ *For more information, see Managing keys in the Key Management Service + * Developer Guide.
+ *Archives and schema discovery are not supported for event buses encrypted using a + * customer managed key. EventBridge returns an error if:
+ *You call
+ * CreateArchive
+ * on an event bus set to use a customer managed key for encryption.
You call
+ * CreateDiscoverer
+ * on an event bus set to use a customer managed key for encryption.
You call
+ * UpdatedEventBus
+ * to set a customer managed key on an event bus with an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to + * use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
+ *The event bus description.
+ * @public + */ + Description?: string; + + /** + *Configuration details of the Amazon SQS queue for EventBridge to use as a + * dead-letter queue (DLQ).
+ *For more information, see Event + * retry policy and using dead-letter queues in the EventBridge User + * Guide.
+ * @public + */ + DeadLetterConfig?: DeadLetterConfig; +} + +/** + * @public + */ +export interface UpdateEventBusResponse { + /** + *The event bus Amazon Resource Name (ARN).
+ * @public + */ + Arn?: string; + + /** + *The event bus name.
+ * @public + */ + Name?: string; + + /** + *The identifier of the KMS + * customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.
+ *For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
+ * @public + */ + KmsKeyIdentifier?: string; + + /** + *The event bus description.
+ * @public + */ + Description?: string; + + /** + *Configuration details of the Amazon SQS queue for EventBridge to use as a + * dead-letter queue (DLQ).
+ *For more information, see Event + * retry policy and using dead-letter queues in the EventBridge User + * Guide.
+ * @public + */ + DeadLetterConfig?: DeadLetterConfig; +} + /** * @internal */ diff --git a/clients/client-eventbridge/src/protocols/Aws_json1_1.ts b/clients/client-eventbridge/src/protocols/Aws_json1_1.ts index b564b55daa44c..28f1645b0ccb9 100644 --- a/clients/client-eventbridge/src/protocols/Aws_json1_1.ts +++ b/clients/client-eventbridge/src/protocols/Aws_json1_1.ts @@ -125,6 +125,7 @@ import { import { UpdateArchiveCommandInput, UpdateArchiveCommandOutput } from "../commands/UpdateArchiveCommand"; import { UpdateConnectionCommandInput, UpdateConnectionCommandOutput } from "../commands/UpdateConnectionCommand"; import { UpdateEndpointCommandInput, UpdateEndpointCommandOutput } from "../commands/UpdateEndpointCommand"; +import { UpdateEventBusCommandInput, UpdateEventBusCommandOutput } from "../commands/UpdateEventBusCommand"; import { EventBridgeServiceException as __BaseException } from "../models/EventBridgeServiceException"; import { ActivateEventSourceRequest, @@ -179,6 +180,7 @@ import { DescribeEndpointRequest, DescribeEndpointResponse, DescribeEventBusRequest, + DescribeEventBusResponse, DescribeEventSourceRequest, DescribeEventSourceResponse, DescribePartnerEventSourceRequest, @@ -190,6 +192,7 @@ import { EnableRuleRequest, Endpoint, EndpointEventBus, + EventBus, EventSource, FailoverConfig, HttpParameters, @@ -209,6 +212,7 @@ import { ListEndpointsRequest, ListEndpointsResponse, ListEventBusesRequest, + ListEventBusesResponse, ListEventSourcesRequest, ListEventSourcesResponse, ListPartnerEventSourceAccountsRequest, @@ -270,6 +274,7 @@ import { UpdateConnectionRequest, UpdateConnectionResponse, UpdateEndpointRequest, + UpdateEventBusRequest, } from "../models/models_0"; /** @@ -1000,6 +1005,19 @@ export const se_UpdateEndpointCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1UpdateEventBusCommand + */ +export const se_UpdateEventBusCommand = async ( + input: UpdateEventBusCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateEventBus"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * deserializeAws_json1_1ActivateEventSourceCommand */ @@ -1417,7 +1435,7 @@ export const de_DescribeEventBusCommand = async ( } const data: any = await parseBody(output.body, context); let contents: any = {}; - contents = _json(data); + contents = de_DescribeEventBusResponse(data, context); const response: DescribeEventBusCommandOutput = { $metadata: deserializeMetadata(output), ...contents, @@ -1631,7 +1649,7 @@ export const de_ListEventBusesCommand = async ( } const data: any = await parseBody(output.body, context); let contents: any = {}; - contents = _json(data); + contents = de_ListEventBusesResponse(data, context); const response: ListEventBusesCommandOutput = { $metadata: deserializeMetadata(output), ...contents, @@ -2093,6 +2111,26 @@ export const de_UpdateEndpointCommand = async ( return response; }; +/** + * deserializeAws_json1_1UpdateEventBusCommand + */ +export const de_UpdateEventBusCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseAmazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your\n resources change state, they automatically send events to an event stream. You can create\n rules that match selected events in the stream and route them to targets to take action. You\n can also use rules to take action on a predetermined schedule. For example, you can configure\n rules to:
\nAutomatically invoke an Lambda function to update DNS entries when an event\n notifies you that Amazon EC2 instance enters the running state.
\nDirect specific API records from CloudTrail to an Amazon Kinesis data stream for\n detailed analysis of potential security or availability risks.
\nPeriodically invoke a built-in target to create a snapshot of an Amazon EBS\n volume.
\nFor more information about the features of Amazon EventBridge, see the Amazon EventBridge User\n Guide.
", + "smithy.api#documentation": "Amazon EventBridge helps you to respond to state changes in your Amazon Web Services\n resources. When your resources change state, they automatically send events to an event\n stream. You can create rules that match selected events in the stream and route them to\n targets to take action. You can also use rules to take action on a predetermined schedule. For\n example, you can configure rules to:
\nAutomatically invoke an Lambda function to update DNS entries when an\n event notifies you that Amazon EC2 instance enters the running state.
\nDirect specific API records from CloudTrail to an Amazon Kinesis\n data stream for detailed analysis of potential security or availability risks.
\nPeriodically invoke a built-in target to create a snapshot of an Amazon EBS\n volume.
\nFor more information about the features of Amazon EventBridge, see the Amazon EventBridge User\n Guide.
", "smithy.api#title": "Amazon EventBridge", "smithy.api#xmlNamespace": { "uri": "http://events.amazonaws.com/doc/2015-10-07" @@ -1823,12 +1826,12 @@ "GraphQLOperation": { "target": "com.amazonaws.eventbridge#GraphQLOperation", "traits": { - "smithy.api#documentation": "The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.
\nFor more information, see Operations in the AppSync User Guide.
" + "smithy.api#documentation": "The GraphQL operation; that is, the query, mutation, or subscription to be parsed and\n executed by the GraphQL service.
\nFor more information, see Operations in the AppSync User Guide.
" } } }, "traits": { - "smithy.api#documentation": "Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
" + "smithy.api#documentation": "Contains the GraphQL operation to be parsed and executed, if the event target is an\n AppSync API.
" } }, "com.amazonaws.eventbridge#Archive": { @@ -2071,14 +2074,14 @@ "JobDefinition": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "The ARN or name of the job definition to use if the event target is an Batch job. This\n job definition must already exist.
", + "smithy.api#documentation": "The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "The name to use for this execution of the job, if the target is an Batch job.
", + "smithy.api#documentation": "The name to use for this execution of the job, if the target is an Batch\n job.
", "smithy.api#required": {} } }, @@ -2091,7 +2094,7 @@ "RetryStrategy": { "target": "com.amazonaws.eventbridge#BatchRetryStrategy", "traits": { - "smithy.api#documentation": "The retry strategy to use for failed jobs, if the target is an Batch job. The retry\n strategy is the number of times to retry the failed job execution. Valid values are 1–10. When\n you specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.
" + "smithy.api#documentation": "The retry strategy to use for failed jobs, if the target is an Batch job.\n The retry strategy is the number of times to retry the failed job execution. Valid values are\n 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the\n job definition.
" } } }, @@ -2111,7 +2114,7 @@ } }, "traits": { - "smithy.api#documentation": "The retry strategy to use for failed jobs, if the target is an Batch job. If you\n specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.
" + "smithy.api#documentation": "The retry strategy to use for failed jobs, if the target is an Batch job.\n If you specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.
" } }, "com.amazonaws.eventbridge#Boolean": { @@ -2295,7 +2298,7 @@ } }, "traits": { - "smithy.api#documentation": "A JSON string which you can use to limit the event bus permissions you are granting to\n only accounts that fulfill the condition. Currently, the only supported condition is\n membership in a certain Amazon Web Services organization. The string must contain Type,\n Key, and Value fields. The Value field specifies the\n ID of the Amazon Web Services organization. Following is an example value for Condition:
\n '{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\":\n \"o-1234567890\"}'\n
A JSON string which you can use to limit the event bus permissions you are granting to\n only accounts that fulfill the condition. Currently, the only supported condition is\n membership in a certain Amazon Web Services organization. The string must contain\n Type, Key, and Value fields. The Value\n field specifies the ID of the Amazon Web Services organization. Following is an example value\n for Condition:
\n '{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\":\n \"o-1234567890\"}'\n
Creates an API destination, which is an HTTP invocation endpoint configured as a target\n for events.
\nAPI destinations do not support private destinations, such as interface VPC endpoints.
\nFor more information, see API destinations in the EventBridge User Guide.
" + "smithy.api#documentation": "Creates an API destination, which is an HTTP invocation endpoint configured as a target\n for events.
\nAPI destinations do not support private destinations, such as interface VPC\n endpoints.
\nFor more information, see API destinations in the\n EventBridge User Guide.
" } }, "com.amazonaws.eventbridge#CreateApiDestinationRequest": { @@ -2877,7 +2880,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an archive of events with the specified settings. When you create an archive,\n incoming events might not immediately start being sent to the archive. Allow a short period of\n time for changes to take effect. If you do not specify a pattern to filter events sent to the\n archive, all events are sent to the archive except replayed events. Replayed events are not\n sent to an archive.
" + "smithy.api#documentation": "Creates an archive of events with the specified settings. When you create an archive,\n incoming events might not immediately start being sent to the archive. Allow a short period of\n time for changes to take effect. If you do not specify a pattern to filter events sent to the\n archive, all events are sent to the archive except replayed events. Replayed events are not\n sent to an archive.
\nArchives and schema discovery are not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:
\nYou call \n CreateArchive\n on an event bus set to use a customer managed key for encryption.
You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.
You call \n UpdatedEventBus\n to set a customer managed key on an event bus with an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
\nCreates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region \n with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an \"unhealthy\" state \n is encountered and events will be routed back to the primary Region when the health check reports a \"healthy\" state.
" + "smithy.api#documentation": "Creates a global endpoint. Global endpoints improve your application's availability by\n making it regional-fault tolerant. To do this, you define a primary and secondary Region with\n event buses in each Region. You also create a Amazon Route 53 health check that will\n tell EventBridge to route events to the secondary Region when an \"unhealthy\" state is\n encountered and events will be routed back to the primary Region when the health check reports\n a \"healthy\" state.
" } }, "com.amazonaws.eventbridge#CreateEndpointRequest": { @@ -3204,7 +3207,7 @@ "Name": { "target": "com.amazonaws.eventbridge#EndpointName", "traits": { - "smithy.api#documentation": "The name of the global endpoint. For example, \"Name\":\"us-east-2-custom_bus_A-endpoint\".
The name of the global endpoint. For example,\n \"Name\":\"us-east-2-custom_bus_A-endpoint\".
Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a \n RoleArn or you don't want event replication enabled, set the state to DISABLED.
Enable or disable event replication. The default state is ENABLED which means\n you must supply a RoleArn. If you don't have a RoleArn or you don't\n want event replication enabled, set the state to DISABLED.
The name of the new event bus.
\nCustom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event\n source that this event bus is matched to.
You can't use the name default for a custom event bus, as this name is already used for your account's\n default event bus.
The name of the new event bus.
\nCustom event bus names can't contain the / character, but you can use the\n / character in partner event bus names. In addition, for partner event buses,\n the name must exactly match the name of the partner event source that this event bus is\n matched to.
You can't use the name default for a custom event bus, as this name is\n already used for your account's default event bus.
If you are creating a partner event bus, this specifies the partner event source that the\n new event bus will be matched with.
" } }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "The event bus description.
" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
\nIf you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt events on the event bus.
\nFor more information, see Managing keys in the Key Management Service\n Developer Guide.
\nArchives and schema discovery are not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:
\nYou call \n CreateArchive\n on an event bus set to use a customer managed key for encryption.
You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.
You call \n UpdatedEventBus\n to set a customer managed key on an event bus with an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
\nThe ARN of the new event bus.
" } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "The event bus description.
" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the KMS\n customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.
\nFor more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig" } }, "traits": { @@ -3397,7 +3430,7 @@ } ], "traits": { - "smithy.api#documentation": "Called by an SaaS partner to create a partner event source. This operation is not used by\n Amazon Web Services customers.
\nEach partner event source can be used by one Amazon Web Services account to create a matching partner\n event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each\n Amazon Web Services account that wants to receive those event types.
\nA partner event source creates events based on resources within the SaaS partner's service\n or application.
\nAn Amazon Web Services account that creates a partner event bus that matches the partner event source can\n use that event bus to receive events from the partner, and then process them using Amazon Web Services Events\n rules and targets.
\nPartner event source names follow this format:
\n\n \n partner_name/event_namespace/event_name\n \n
\n partner_name is determined during partner registration, and\n identifies the partner to Amazon Web Services customers.
\n\n event_namespace is determined by the partner, and is a way for\n the partner to categorize their events.
\n\n event_name is determined by the partner, and should uniquely identify\n an event-generating resource within the partner system.
\nThe event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource\n between the partner and customer accounts, and each partner event source unique in the partner account.
\nThe combination of\n event_namespace and event_name should help Amazon Web Services\n customers decide whether to create an event bus to receive these events.
" + "smithy.api#documentation": "Called by an SaaS partner to create a partner event source. This operation is not used by\n Amazon Web Services customers.
\nEach partner event source can be used by one Amazon Web Services account to create a\n matching partner event bus in that Amazon Web Services account. A SaaS partner must create one\n partner event source for each Amazon Web Services account that wants to receive those event\n types.
\nA partner event source creates events based on resources within the SaaS partner's service\n or application.
\nAn Amazon Web Services account that creates a partner event bus that matches the partner\n event source can use that event bus to receive events from the partner, and then process them\n using Amazon Web Services Events rules and targets.
\nPartner event source names follow this format:
\n\n \n partner_name/event_namespace/event_name\n \n
\n partner_name is determined during partner registration, and\n identifies the partner to Amazon Web Services customers.
\n\n event_namespace is determined by the partner, and is a way for\n the partner to categorize their events.
\n\n event_name is determined by the partner, and should uniquely\n identify an event-generating resource within the partner system.
\nThe event_name must be unique across all Amazon Web Services\n customers. This is because the event source is a shared resource between the partner and\n customer accounts, and each partner event source unique in the partner account.
\nThe combination of event_namespace and\n event_name should help Amazon Web Services customers decide whether to\n create an event bus to receive these events.
" } }, "com.amazonaws.eventbridge#CreatePartnerEventSourceRequest": { @@ -3406,14 +3439,14 @@ "Name": { "target": "com.amazonaws.eventbridge#EventSourceName", "traits": { - "smithy.api#documentation": "The name of the partner event source. This name must be unique and must be in the format\n \n partner_name/event_namespace/event_name\n .\n The Amazon Web Services account that wants to use this partner event source must create a partner event bus\n with a name that matches the name of the partner event source.
The name of the partner event source. This name must be unique and must be in the format\n \n partner_name/event_namespace/event_name\n .\n The Amazon Web Services account that wants to use this partner event source must create a\n partner event bus with a name that matches the name of the partner event source.
The Amazon Web Services account ID that is permitted to create a matching partner event bus for this\n partner event source.
", + "smithy.api#documentation": "The Amazon Web Services account ID that is permitted to create a matching partner event bus\n for this partner event source.
", "smithy.api#required": {} } } @@ -3520,7 +3553,7 @@ } }, "traits": { - "smithy.api#documentation": "A DeadLetterConfig object that contains information about a dead-letter queue\n configuration.
Configuration details of the Amazon SQS queue for EventBridge to use as a\n dead-letter queue (DLQ).
\nFor more information, see Event\n retry policy and using dead-letter queues in the EventBridge User\n Guide.
" } }, "com.amazonaws.eventbridge#DeauthorizeConnection": { @@ -3785,7 +3818,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
" + "smithy.api#documentation": "Delete an existing global endpoint. For more information about global endpoints, see\n Making applications Regional-fault tolerant with global endpoints and event\n replication in the \n Amazon EventBridge User Guide\n .
" } }, "com.amazonaws.eventbridge#DeleteEndpointRequest": { @@ -3794,7 +3827,7 @@ "Name": { "target": "com.amazonaws.eventbridge#EndpointName", "traits": { - "smithy.api#documentation": "The name of the endpoint you want to delete. For example, \"Name\":\"us-east-2-custom_bus_A-endpoint\"..
The name of the endpoint you want to delete. For example,\n \"Name\":\"us-east-2-custom_bus_A-endpoint\"..
This operation is used by SaaS partners to delete a partner event source. This operation\n is not used by Amazon Web Services customers.
\nWhen you delete an event source, the status of the corresponding partner event bus in the\n Amazon Web Services customer account becomes DELETED.
\n " + "smithy.api#documentation": "This operation is used by SaaS partners to delete a partner event source. This operation\n is not used by Amazon Web Services customers.
\nWhen you delete an event source, the status of the corresponding partner event bus in the\n Amazon Web Services customer account becomes DELETED.
\n " } }, "com.amazonaws.eventbridge#DeletePartnerEventSourceRequest": { @@ -3881,7 +3914,7 @@ "Account": { "target": "com.amazonaws.eventbridge#AccountId", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.
", + "smithy.api#documentation": "The Amazon Web Services account ID of the Amazon Web Services customer that the event source\n was created for.
", "smithy.api#required": {} } } @@ -3913,7 +3946,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified rule.
\nBefore you can delete the rule, you must remove all targets, using RemoveTargets.
\nWhen you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.
\nIf you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException is\n returned.
Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These\n rules are created by those other Amazon Web Services services to support functionality in those services. You\n can delete these rules using the Force option, but you should do so only if you\n are sure the other service is not still using that rule.
Deletes the specified rule.
\nBefore you can delete the rule, you must remove all targets, using RemoveTargets.
\nWhen you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.
\nIf you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException is\n returned.
Managed rules are rules created and managed by another Amazon Web Services service on your\n behalf. These rules are created by those other Amazon Web Services services to support\n functionality in those services. You can delete these rules using the Force\n option, but you should do so only if you are sure the other service is not still using that\n rule.
If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify\n Force as True to delete the rule. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.
If this is a managed rule, created by an Amazon Web Services service on your behalf, you\n must specify Force as True to delete the rule. This parameter is\n ignored for rules that are not managed rules. You can check whether a rule is a managed rule\n by using DescribeRule or ListRules and checking the\n ManagedBy field of the response.
Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
" + "smithy.api#documentation": "Get the information about an existing global endpoint. For more information about global\n endpoints, see Making applications\n Regional-fault tolerant with global endpoints and event replication in the\n \n Amazon EventBridge User Guide\n .
" } }, "com.amazonaws.eventbridge#DescribeEndpointRequest": { @@ -4296,14 +4329,14 @@ "Name": { "target": "com.amazonaws.eventbridge#EndpointName", "traits": { - "smithy.api#documentation": "The name of the endpoint you want to get information about. For example, \"Name\":\"us-east-2-custom_bus_A-endpoint\".
The name of the endpoint you want to get information about. For example,\n \"Name\":\"us-east-2-custom_bus_A-endpoint\".
The primary Region of the endpoint you want to get information about. For example \"HomeRegion\": \"us-east-1\".
The primary Region of the endpoint you want to get information about. For example\n \"HomeRegion\": \"us-east-1\".
Whether replication is enabled or disabled for the endpoint you asked for information about.
" + "smithy.api#documentation": "Whether replication is enabled or disabled for the endpoint you asked for information\n about.
" } }, "EventBuses": { @@ -4414,7 +4447,7 @@ } ], "traits": { - "smithy.api#documentation": "Displays details about an event bus in your account. This can include the external Amazon Web Services\n accounts that are permitted to write events to your default event bus, and the associated\n policy. For custom event buses and partner event buses, it displays the name, ARN, policy,\n state, and creation time.
\nTo enable your account to receive events from other accounts on its default event bus,\n use PutPermission.
\nFor more information about partner event buses, see CreateEventBus.
" + "smithy.api#documentation": "Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the\n associated policy. For custom event buses and partner event buses, it displays the name, ARN,\n policy, state, and creation time.
\nTo enable your account to receive events from other accounts on its default event bus,\n use PutPermission.
\nFor more information about partner event buses, see CreateEventBus.
" } }, "com.amazonaws.eventbridge#DescribeEventBusRequest": { @@ -4443,14 +4476,41 @@ "Arn": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the account permitted to write events to the current\n account.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "The event bus description.
" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the KMS\n customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.
\nFor more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
" } }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig" + }, "Policy": { "target": "com.amazonaws.eventbridge#String", "traits": { "smithy.api#documentation": "The policy that enables the external account to send events to your account.
" } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "The time the event bus was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "The time the event bus was last modified.
" + } } }, "traits": { @@ -4559,7 +4619,7 @@ } ], "traits": { - "smithy.api#documentation": "An SaaS partner can use this operation to list details about a partner event source that\n they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource\n to see details about a partner event source that is\n shared with them.
" + "smithy.api#documentation": "An SaaS partner can use this operation to list details about a partner event source that\n they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with\n them.
" } }, "com.amazonaws.eventbridge#DescribePartnerEventSourceRequest": { @@ -4771,7 +4831,7 @@ "EventPattern": { "target": "com.amazonaws.eventbridge#EventPattern", "traits": { - "smithy.api#documentation": "The event pattern. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.
" + "smithy.api#documentation": "The event pattern. For more information, see Events and Event\n Patterns in the \n Amazon EventBridge User Guide\n .
" } }, "ScheduleExpression": { @@ -4801,7 +4861,7 @@ "ManagedBy": { "target": "com.amazonaws.eventbridge#ManagedBy", "traits": { - "smithy.api#documentation": "If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays\n the principal name of the Amazon Web Services service that created the rule.
" + "smithy.api#documentation": "If this is a managed rule, created by an Amazon Web Services service on your behalf, this\n field displays the principal name of the Amazon Web Services service that created the\n rule.
" } }, "EventBusName": { @@ -4887,19 +4947,19 @@ "LaunchType": { "target": "com.amazonaws.eventbridge#LaunchType", "traits": { - "smithy.api#documentation": "Specifies the launch type on which your task is running. The launch type that you specify\n here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where Fargate with Amazon ECS\n is supported. For more information, see Fargate on Amazon ECS in\n the Amazon Elastic Container Service Developer Guide.
Specifies the launch type on which your task is running. The launch type that you specify\n here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where Fargate\n with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer\n Guide.
Use this structure if the Amazon ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and whether\n a public IP address is to be used. This structure is required if LaunchType is\n FARGATE because the awsvpc mode is required for Fargate\n tasks.
If you specify NetworkConfiguration when the target ECS task does not use the\n awsvpc network mode, the task fails.
Use this structure if the Amazon ECS task uses the awsvpc network\n mode. This structure specifies the VPC subnets and security groups associated with the task,\n and whether a public IP address is to be used. This structure is required if\n LaunchType is FARGATE because the awsvpc mode is\n required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the\n awsvpc network mode, the task fails.
Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.
This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see Fargate Platform\n Versions in the Amazon Elastic Container Service Developer\n Guide.
Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.
This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see Fargate\n Platform Versions in the Amazon Elastic Container Service Developer\n Guide.
Specifies whether to enable Amazon ECS managed tags for the task. For more information,\n see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer\n Guide.
" + "smithy.api#documentation": "Specifies whether to enable Amazon ECS managed tags for the task. For more\n information, see Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.
" } }, "EnableExecuteCommand": { @@ -5040,7 +5100,7 @@ "ReplicationConfig": { "target": "com.amazonaws.eventbridge#ReplicationConfig", "traits": { - "smithy.api#documentation": "Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn. \n If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.
Whether event replication was enabled or disabled for this endpoint. The default state is\n ENABLED which means you must supply a RoleArn. If you don't have a\n RoleArn or you don't want event replication enabled, set the state to\n DISABLED.
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 abcde.veo.
The URL subdomain of the endpoint. For example, if the URL for Endpoint is\n https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is\n abcde.veo.
A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
" + "smithy.api#documentation": "A global endpoint used to improve your application's availability by making it\n regional-fault tolerant. For more information about global endpoints, see Making\n applications Regional-fault tolerant with global endpoints and event replication in\n the \n Amazon EventBridge User Guide\n .
" } }, "com.amazonaws.eventbridge#EndpointArn": { @@ -5257,15 +5317,42 @@ "smithy.api#documentation": "The ARN of the event bus.
" } }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "The event bus description.
" + } + }, "Policy": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "The permissions policy of the event bus, describing which other Amazon Web Services accounts can write\n events to this event bus.
" + "smithy.api#documentation": "The permissions policy of the event bus, describing which other Amazon Web Services\n accounts can write events to this event bus.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "The time the event bus was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "The time the event bus was last modified.
" } } }, "traits": { - "smithy.api#documentation": "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).\n Your account's default event bus receives events from Amazon Web Services services. A custom event\n bus can receive events from your custom applications and services. A partner event bus\n receives events from an event source created by an SaaS partner. These events come from the\n partners services or applications.
" + "smithy.api#documentation": "An event bus receives events from a source, uses rules to evaluate them, applies any\n configured input transformation, and routes them to the appropriate target(s). Your account's\n default event bus receives events from Amazon Web Services services. A custom event bus can\n receive events from your custom applications and services. A partner event bus receives events\n from an event source created by an SaaS partner. These events come from the partners services\n or applications.
" + } + }, + "com.amazonaws.eventbridge#EventBusDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } } }, "com.amazonaws.eventbridge#EventBusList": { @@ -5351,7 +5438,7 @@ "ExpirationTime": { "target": "com.amazonaws.eventbridge#Timestamp", "traits": { - "smithy.api#documentation": "The date and time that the event source will expire, if the Amazon Web Services account doesn't create a\n matching event bus for it.
" + "smithy.api#documentation": "The date and time that the event source will expire, if the Amazon Web Services account\n doesn't create a matching event bus for it.
" } }, "Name": { @@ -5368,7 +5455,7 @@ } }, "traits": { - "smithy.api#documentation": "A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events from the\n partner's applications or services.
" + "smithy.api#documentation": "A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events\n from the partner's applications or services.
" } }, "com.amazonaws.eventbridge#EventSourceList": { @@ -5436,13 +5523,13 @@ "Secondary": { "target": "com.amazonaws.eventbridge#Secondary", "traits": { - "smithy.api#documentation": "The Region that events are routed to when failover is triggered or event replication is enabled.
", + "smithy.api#documentation": "The Region that events are routed to when failover is triggered or event replication is\n enabled.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
" + "smithy.api#documentation": "The failover configuration for an endpoint. This includes what triggers failover and what\n happens when it's triggered.
" } }, "com.amazonaws.eventbridge#GraphQLOperation": { @@ -5521,24 +5608,24 @@ "PathParameterValues": { "target": "com.amazonaws.eventbridge#PathParameterList", "traits": { - "smithy.api#documentation": "The path parameter values to be used to populate API Gateway API or EventBridge\n ApiDestination path wildcards (\"*\").
" + "smithy.api#documentation": "The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards (\"*\").
" } }, "HeaderParameters": { "target": "com.amazonaws.eventbridge#HeaderParametersMap", "traits": { - "smithy.api#documentation": "The headers that need to be sent as part of request invoking the API Gateway API or\n EventBridge ApiDestination.
" + "smithy.api#documentation": "The headers that need to be sent as part of request invoking the API Gateway API or\n EventBridge ApiDestination.
" } }, "QueryStringParameters": { "target": "com.amazonaws.eventbridge#QueryStringParametersMap", "traits": { - "smithy.api#documentation": "The query string keys/values that need to be sent as part of request invoking the API Gateway \n API or EventBridge ApiDestination.
" + "smithy.api#documentation": "The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
" } } }, "traits": { - "smithy.api#documentation": "These are custom parameter to be used when the target is an API Gateway APIs or\n EventBridge ApiDestinations. In the latter case, these are merged with any\n InvocationParameters specified on the Connection, with any values from the Connection taking\n precedence.
" + "smithy.api#documentation": "These are custom parameter to be used when the target is an API Gateway APIs or\n EventBridge ApiDestinations. In the latter case, these are merged with any\n InvocationParameters specified on the Connection, with any values from the Connection taking\n precedence.
" } }, "com.amazonaws.eventbridge#HttpsEndpoint": { @@ -5585,7 +5672,7 @@ "InputTemplate": { "target": "com.amazonaws.eventbridge#TransformerInput", "traits": { - "smithy.api#documentation": "Input template where you specify placeholders that will be filled with the values of the\n keys from InputPathsMap to customize the data sent to the target. Enclose each\n InputPathsMaps value in brackets: <value>\n
If InputTemplate is a JSON object (surrounded by curly braces), the following\n restrictions apply:
The placeholder cannot be used as an object key.
\nThe following example shows the syntax for using InputPathsMap and\n InputTemplate.
\n \"InputTransformer\":\n
\n {\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n
\n \"InputTemplate\": \"\n
\n }\n
To have the InputTemplate include quote marks within a JSON string, escape\n each quote marks with a slash, as in the following example:
\n \"InputTransformer\":\n
\n {\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n
\n \"InputTemplate\": \"\n
\n }\n
The InputTemplate can also be valid JSON with varibles in quotes or out, as\n in the following example:
\n \"InputTransformer\":\n
\n {\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n
\n \"InputTemplate\": '{\"myInstance\": \n
\n }\n
Input template where you specify placeholders that will be filled with the values of the\n keys from InputPathsMap to customize the data sent to the target. Enclose each\n InputPathsMaps value in brackets: <value>
If InputTemplate is a JSON object (surrounded by curly braces), the following\n restrictions apply:
The placeholder cannot be used as an object key.
\nThe following example shows the syntax for using InputPathsMap and\n InputTemplate.
\n \"InputTransformer\":\n
\n {\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n
\n \"InputTemplate\": \"\n
\n }\n
To have the InputTemplate include quote marks within a JSON string, escape\n each quote marks with a slash, as in the following example:
\n \"InputTransformer\":\n
\n {\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n
\n \"InputTemplate\": \"\n
\n }\n
The InputTemplate can also be valid JSON with varibles in quotes or out, as\n in the following example:
\n \"InputTransformer\":\n
\n {\n
\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n
\n \"InputTemplate\": '{\"myInstance\": \n
\n }\n
This object enables you to specify a JSON path to extract from the event and use as the\n partition key for the Amazon Kinesis data stream, so that you can control the shard to which\n the event goes. If you do not include this parameter, the default is to use the\n eventId as the partition key.
List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
" + "smithy.api#documentation": "List the global endpoints associated with this account. For more information about global\n endpoints, see Making applications\n Regional-fault tolerant with global endpoints and event replication in the\n \n Amazon EventBridge User Guide\n .
" } }, "com.amazonaws.eventbridge#ListEndpointsRequest": { @@ -5952,19 +6048,19 @@ "NamePrefix": { "target": "com.amazonaws.eventbridge#EndpointName", "traits": { - "smithy.api#documentation": "A value that will return a subset of the endpoints associated with this account. For example, \"NamePrefix\": \"ABC\" will return all endpoints with \"ABC\" in the name.
A value that will return a subset of the endpoints associated with this account. For\n example, \"NamePrefix\": \"ABC\" will return all endpoints with \"ABC\" in the\n name.
The primary Region of the endpoints associated with this account. For example \"HomeRegion\": \"us-east-1\".
The primary Region of the endpoints associated with this account. For example\n \"HomeRegion\": \"us-east-1\".
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. \n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination \n token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using\n the returned token to retrieve the next page. Keep all other arguments unchanged. Each\n pagination token expires after 24 hours. Using an expired pagination token will return an HTTP\n 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. \n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination \n token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using\n the returned token to retrieve the next page. Keep all other arguments unchanged. Each\n pagination token expires after 24 hours. Using an expired pagination token will return an HTTP\n 400 InvalidToken error.
You can use this to see all the partner event sources that have been shared with your Amazon Web Services\n account. For more information about partner event sources, see CreateEventBus.
" + "smithy.api#documentation": "You can use this to see all the partner event sources that have been shared with your\n Amazon Web Services account. For more information about partner event sources, see CreateEventBus.
" } }, "com.amazonaws.eventbridge#ListEventSourcesRequest": { @@ -6147,7 +6243,7 @@ } ], "traits": { - "smithy.api#documentation": "An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular\n partner event source name is associated with. This operation is not used by Amazon Web Services\n customers.
" + "smithy.api#documentation": "An SaaS partner can use this operation to display the Amazon Web Services account ID that a\n particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.
" } }, "com.amazonaws.eventbridge#ListPartnerEventSourceAccountsRequest": { @@ -6429,7 +6525,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists your Amazon EventBridge rules. You can either list all the rules or you can provide\n a prefix to match to the rule names.
\nThe maximum number of results per page for requests is 100.
\nListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.
" + "smithy.api#documentation": "Lists your Amazon EventBridge rules. You can either list all the rules or you can\n provide a prefix to match to the rule names.
\nThe maximum number of results per page for requests is 100.
\nListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.
" } }, "com.amazonaws.eventbridge#ListRulesRequest": { @@ -6629,7 +6725,7 @@ } }, "traits": { - "smithy.api#documentation": "This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that\n service. If you see this error in response to DeleteRule or\n RemoveTargets, you can use the Force parameter in those calls to\n delete the rule or remove targets from the rule. You cannot modify these managed rules by\n using DisableRule, EnableRule, PutTargets,\n PutRule, TagResource, or UntagResource.
This rule was created by an Amazon Web Services service on behalf of your account. It is\n managed by that service. If you see this error in response to DeleteRule or\n RemoveTargets, you can use the Force parameter in those calls to\n delete the rule or remove targets from the rule. You cannot modify these managed rules by\n using DisableRule, EnableRule, PutTargets,\n PutRule, TagResource, or UntagResource.
A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events from the\n partner's applications or services.
" + "smithy.api#documentation": "A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events\n from the partner's applications or services.
" } }, "com.amazonaws.eventbridge#PartnerEventSourceAccount": { @@ -6763,7 +6859,7 @@ "ExpirationTime": { "target": "com.amazonaws.eventbridge#Timestamp", "traits": { - "smithy.api#documentation": "The date and time that the event source will expire, if the Amazon Web Services account doesn't create a\n matching event bus for it.
" + "smithy.api#documentation": "The date and time that the event source will expire, if the Amazon Web Services account\n doesn't create a matching event bus for it.
" } }, "State": { @@ -6823,12 +6919,12 @@ "expression": { "target": "com.amazonaws.eventbridge#PlacementConstraintExpression", "traits": { - "smithy.api#documentation": "A cluster query language expression to apply to the constraint. You cannot specify an\n expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.\n
A cluster query language expression to apply to the constraint. You cannot specify an\n expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer\n Guide.
" + "smithy.api#documentation": "An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.eventbridge#PlacementConstraintExpression": { @@ -6951,7 +7047,7 @@ "HealthCheck": { "target": "com.amazonaws.eventbridge#HealthCheck", "traits": { - "smithy.api#documentation": "The ARN of the health check used by the endpoint to determine whether failover is triggered.
", + "smithy.api#documentation": "The ARN of the health check used by the endpoint to determine whether failover is\n triggered.
", "smithy.api#required": {} } } @@ -6995,7 +7091,7 @@ } ], "traits": { - "smithy.api#documentation": "Sends custom events to Amazon EventBridge so that they can be matched to rules.
\nThe 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. \n To learn more, see\n Calculating PutEvents event entry size in the Amazon EventBridge User Guide\n
\nPutEvents accepts the data in JSON format. For the JSON number\n (integer) data type, the constraints are: a minimum value of\n -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.
\nPutEvents will only process nested JSON up to 1100 levels deep.
\nSends custom events to Amazon EventBridge so that they can be matched to rules.
\nThe maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including\n the event and any necessary characters and keys of the JSON representation of the event. To\n learn more, see Calculating PutEvents event entry\n size in the \n Amazon EventBridge User Guide\n \n
\nPutEvents accepts the data in JSON format. For the JSON number (integer) data type, the\n constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of\n 9,223,372,036,854,775,807.
\nPutEvents will only process nested JSON up to 1100 levels deep.
\nThe URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
When using Java, you must include auth-crt on the class path.
The URL subdomain of the endpoint. For example, if the URL for Endpoint is\n https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is\n abcde.veo.
When using Java, you must include auth-crt on the class path.
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.
" + "smithy.api#documentation": "Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.\n Any number, including zero, may be present.
" } }, "DetailType": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
\n\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n
Free-form string, with a maximum of 128 characters, used to decide what fields to expect\n in the event detail.
\n\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n
The name or ARN of the event bus to receive the event. Only the rules that are associated\n with this event bus are used to match the event. If you omit this, the default event bus is\n used.
\nIf 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 \n in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the \n other Region based on the endpoint referenced by the EndpointId. Specifying the event bus ARN is preferred.
The name or ARN of the event bus to receive the event. Only the rules that are associated\n with this event bus are used to match the event. If you omit this, the default event bus is\n used.
\nIf you're using a global endpoint with a custom bus, you can enter either the name or\n Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then\n determines the corresponding event bus in the other Region based on the endpoint referenced\n by the EndpointId. Specifying the event bus ARN is preferred.
An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the\n trace-id associated with the event.
\nTo learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
" + "smithy.api#documentation": "An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that\n contains the trace-id associated with the event.
\nTo learn more about X-Ray trace headers, see Tracing\n header in the X-Ray Developer Guide.
" } } }, @@ -7097,7 +7193,7 @@ "Entries": { "target": "com.amazonaws.eventbridge#PutEventsResultEntryList", "traits": { - "smithy.api#documentation": "The successfully and unsuccessfully ingested events results. If the ingestion was\n successful, the entry has the event ID in it. Otherwise, you can use the error code and error\n message to identify the problem with the entry.
\nFor each record, the index of the response element is the same as the index in the request array.
" + "smithy.api#documentation": "The successfully and unsuccessfully ingested events results. If the ingestion was\n successful, the entry has the event ID in it. Otherwise, you can use the error code and error\n message to identify the problem with the entry.
\nFor each record, the index of the response element is the same as the index in the request\n array.
" } } }, @@ -7117,7 +7213,7 @@ "ErrorCode": { "target": "com.amazonaws.eventbridge#ErrorCode", "traits": { - "smithy.api#documentation": "The error code that indicates why the event submission failed.
\nRetryable errors include:
\n\n \n InternalFailure\n \n
The request processing has failed because of an unknown error, exception or failure.
\n\n \n ThrottlingException\n \n
The request was denied due to request throttling.
\nNon-retryable errors include:
\n\n \n AccessDeniedException\n \n
You do not have sufficient access to perform this action.
\n\n InvalidAccountIdException\n
The account ID provided is not valid.
\n\n InvalidArgument\n
A specified parameter is not valid.
\n\n MalformedDetail\n
The JSON provided is not valid.
\n\n RedactionFailure\n
Redacting the CloudTrail event failed.
\n\n NotAuthorizedForSourceException\n
You do not have permissions to publish events with this source onto this event bus.
\n\n NotAuthorizedForDetailTypeException\n
You do not have permissions to publish events with this detail type onto this event bus.
\nThe error code that indicates why the event submission failed.
\nRetryable errors include:
\n\n \n InternalFailure\n \n
The request processing has failed because of an unknown error, exception or\n failure.
\n\n \n ThrottlingException\n \n
The request was denied due to request throttling.
\nNon-retryable errors include:
\n\n \n AccessDeniedException\n \n
You do not have sufficient access to perform this action.
\n\n InvalidAccountIdException\n
The account ID provided is not valid.
\n\n InvalidArgument\n
A specified parameter is not valid.
\n\n MalformedDetail\n
The JSON provided is not valid.
\n\n RedactionFailure\n
Redacting the CloudTrail event failed.
\n\n NotAuthorizedForSourceException\n
You do not have permissions to publish events with this source onto this event\n bus.
\n\n NotAuthorizedForDetailTypeException\n
You do not have permissions to publish events with this detail type onto this event\n bus.
\nRepresents the results of an event submitted to an event bus.
\nIf the submission was successful, the entry has the event ID in it. \n Otherwise, you can use the error code and error message to identify the problem with the entry.
\nFor information about the errors that are common to all actions, see \n Common Errors.
" + "smithy.api#documentation": "Represents the results of an event submitted to an event bus.
\nIf the submission was successful, the entry has the event ID in it. Otherwise, you can use\n the error code and error message to identify the problem with the entry.
\nFor information about the errors that are common to all actions, see Common\n Errors.
" } }, "com.amazonaws.eventbridge#PutEventsResultEntryList": { @@ -7154,7 +7250,7 @@ } ], "traits": { - "smithy.api#documentation": "This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services\n customers do not use this operation.
\nFor information on calculating event batch size, see \n Calculating EventBridge PutEvents event entry size\n in the EventBridge User Guide.
" + "smithy.api#documentation": "This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
\nFor information on calculating event batch size, see Calculating EventBridge PutEvents event\n entry size in the EventBridge User Guide.
" } }, "com.amazonaws.eventbridge#PutPartnerEventsRequest": { @@ -7190,13 +7286,13 @@ "Resources": { "target": "com.amazonaws.eventbridge#EventResourceList", "traits": { - "smithy.api#documentation": "Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.
" + "smithy.api#documentation": "Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.\n Any number, including zero, may be present.
" } }, "DetailType": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
\n\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n
A free-form string, with a maximum of 128 characters, used to decide what fields to expect\n in the event detail.
\n\n Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. \n If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. \n If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.\n
The results for each event entry the partner submitted in this request. \n If the event was successfully submitted, the entry has the event ID in it. \n Otherwise, you can use the error code and error message to identify the problem with the entry.
\nFor each record, the index of the response element is the same as the index in the request array.
" + "smithy.api#documentation": "The results for each event entry the partner submitted in this request. If the event was\n successfully submitted, the entry has the event ID in it. Otherwise, you can use the error\n code and error message to identify the problem with the entry.
\nFor each record, the index of the response element is the same as the index in the request\n array.
" } } }, @@ -7266,7 +7362,7 @@ } }, "traits": { - "smithy.api#documentation": "The result of an event entry the partner submitted in this request. \n If the event was successfully submitted, the entry has the event ID in it. \n Otherwise, you can use the error code and error message to identify the problem with the entry.
" + "smithy.api#documentation": "The result of an event entry the partner submitted in this request. If the event was\n successfully submitted, the entry has the event ID in it. Otherwise, you can use the error\n code and error message to identify the problem with the entry.
" } }, "com.amazonaws.eventbridge#PutPartnerEventsResultEntryList": { @@ -7301,7 +7397,7 @@ } ], "traits": { - "smithy.api#documentation": "Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization\n to put events to the specified event bus. Amazon EventBridge (CloudWatch\n Events) rules in your account are triggered by these events arriving to an event bus in your\n account.
For another account to send events to your account, that external account must have an\n EventBridge rule with your account's event bus as a target.
\nTo enable multiple Amazon Web Services accounts to put events to your event bus, run\n PutPermission once for each of these accounts. Or, if all the accounts are\n members of the same Amazon Web Services organization, you can run PutPermission once specifying\n Principal as \"*\" and specifying the Amazon Web Services organization ID in\n Condition, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must\n specify a RoleArn with proper permissions when they use PutTarget to\n add your account's event bus as a target. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.
The permission policy on the event bus cannot exceed 10 KB in size.
" + "smithy.api#documentation": "Running PutPermission permits the specified Amazon Web Services account or\n Amazon Web Services organization to put events to the specified event\n bus. Amazon EventBridge (CloudWatch Events) rules in your account are\n triggered by these events arriving to an event bus in your account.
For another account to send events to your account, that external account must have an\n EventBridge rule with your account's event bus as a target.
\nTo enable multiple Amazon Web Services accounts to put events to your event bus, run\n PutPermission once for each of these accounts. Or, if all the accounts are\n members of the same Amazon Web Services organization, you can run PutPermission\n once specifying Principal as \"*\" and specifying the Amazon Web Services\n organization ID in Condition, to grant permissions to all accounts in that\n organization.
If you grant permissions using an organization, then accounts in that organization must\n specify a RoleArn with proper permissions when they use PutTarget to\n add your account's event bus as a target. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.
The permission policy on the event bus cannot exceed 10 KB in size.
" } }, "com.amazonaws.eventbridge#PutPermissionRequest": { @@ -7322,19 +7418,19 @@ "Principal": { "target": "com.amazonaws.eventbridge#Principal", "traits": { - "smithy.api#documentation": "The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event\n bus. Specify \"*\" to permit any account to put events to your default event bus.
\nIf you specify \"*\" without specifying Condition, avoid creating rules that\n may match undesirable events. To create more secure rules, make sure that the event pattern\n for each rule contains an account field with a specific account ID from which to\n receive events. Rules with an account field do not match any events sent from other\n accounts.
The 12-digit Amazon Web Services account ID that you are permitting to put events to your\n default event bus. Specify \"*\" to permit any account to put events to your default event\n bus.
\nIf you specify \"*\" without specifying Condition, avoid creating rules that\n may match undesirable events. To create more secure rules, make sure that the event pattern\n for each rule contains an account field with a specific account ID from which to\n receive events. Rules with an account field do not match any events sent from other\n accounts.
An identifier string for the external account that you are granting permissions to. If you\n later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.
Each StatementId must be unique.
An identifier string for the external account that you are granting permissions to. If you\n later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.
Each StatementId must be unique.
This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain Amazon Web Services organization. For more information about\n Amazon Web Services Organizations, see What Is Amazon Web Services \n Organizations in the Amazon Web Services Organizations User Guide.
\nIf you specify Condition with an Amazon Web Services organization ID, and specify \"*\" as the\n value for Principal, you grant permission to all the accounts in the named\n organization.
The Condition is a JSON string which must contain Type,\n Key, and Value fields.
This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain Amazon Web Services organization. For more\n information about Amazon Web Services Organizations, see What Is Amazon Web Services\n Organizations in the Amazon Web Services Organizations User\n Guide.
\nIf you specify Condition with an Amazon Web Services organization ID, and\n specify \"*\" as the value for Principal, you grant permission to all the accounts\n in the named organization.
The Condition is a JSON string which must contain Type,\n Key, and Value fields.
Creates or updates the specified rule. Rules are enabled by default, or based on value of\n the state. You can disable a rule using DisableRule.
\nA single rule watches for events from a single event bus. Events generated by Amazon Web Services services\n go to your account's default event bus. Events generated by SaaS partner services or\n applications go to the matching partner event bus. If you have custom applications or\n services, you can specify whether their events go to your default event bus or a custom event\n bus that you have created. For more information, see CreateEventBus.
\nIf you are updating an existing rule, the rule is replaced with what you specify in this\n PutRule command. If you omit arguments in PutRule, the old values\n for those arguments are not kept. Instead, they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to\n new or updated rules. Allow a short period of time for changes to take effect.
\nA rule must contain at least an EventPattern or ScheduleExpression. Rules with\n EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\n self-trigger based on the given schedule. A rule can have both an EventPattern and a\n ScheduleExpression, in which case the rule triggers on matching events as well as on a\n schedule.
\nWhen you initially create a rule, you can optionally assign one or more tags to the rule.\n Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only rules with certain tag\n values. To use the PutRule operation and assign tags, you must have both the\n events:PutRule and events:TagResource permissions.
If you are updating an existing rule, any tags you specify in the PutRule\n operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.
\nIn EventBridge, it is possible to create rules that lead to infinite loops, where a rule\n is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\n and trigger software to change them to the desired state. If the rule is not written\n carefully, the subsequent change to the ACLs fires the rule again, creating an infinite\n loop.
\nTo prevent this, write the rules so that the triggered actions do not re-fire the same\n rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\n of after any change.
\nAn infinite loop can quickly cause higher than expected charges. We recommend that you use\n budgeting, which alerts you when charges exceed your specified limit. For more information,\n see Managing Your Costs with\n Budgets.
" + "smithy.api#documentation": "Creates or updates the specified rule. Rules are enabled by default, or based on value of\n the state. You can disable a rule using DisableRule.
\nA single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner\n services or applications go to the matching partner event bus. If you have custom applications\n or services, you can specify whether their events go to your default event bus or a custom\n event bus that you have created. For more information, see CreateEventBus.
\nIf you are updating an existing rule, the rule is replaced with what you specify in this\n PutRule command. If you omit arguments in PutRule, the old values\n for those arguments are not kept. Instead, they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to\n new or updated rules. Allow a short period of time for changes to take effect.
\nA rule must contain at least an EventPattern or ScheduleExpression. Rules with\n EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\n self-trigger based on the given schedule. A rule can have both an EventPattern and a\n ScheduleExpression, in which case the rule triggers on matching events as well as on a\n schedule.
\nWhen you initially create a rule, you can optionally assign one or more tags to the rule.\n Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only rules with certain tag\n values. To use the PutRule operation and assign tags, you must have both the\n events:PutRule and events:TagResource permissions.
If you are updating an existing rule, any tags you specify in the PutRule\n operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource\n Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to\n use the correct ARN characters when creating event patterns so that they match the ARN syntax\n in the event you want to match.
\nIn EventBridge, it is possible to create rules that lead to infinite loops, where a rule\n is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\n and trigger software to change them to the desired state. If the rule is not written\n carefully, the subsequent change to the ACLs fires the rule again, creating an infinite\n loop.
\nTo prevent this, write the rules so that the triggered actions do not re-fire the same\n rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\n of after any change.
\nAn infinite loop can quickly cause higher than expected charges. We recommend that you use\n budgeting, which alerts you when charges exceed your specified limit. For more information,\n see Managing Your Costs with\n Budgets.
" } }, "com.amazonaws.eventbridge#PutRuleRequest": { @@ -7399,13 +7495,13 @@ "EventPattern": { "target": "com.amazonaws.eventbridge#EventPattern", "traits": { - "smithy.api#documentation": "The event pattern. For more information, see Amazon EventBridge event\n patterns in the Amazon EventBridge User Guide.
" + "smithy.api#documentation": "The event pattern. For more information, see Amazon EventBridge event\n patterns in the \n Amazon EventBridge User Guide\n .
" } }, "State": { "target": "com.amazonaws.eventbridge#RuleState", "traits": { - "smithy.api#documentation": "Indicates whether the rule is enabled or disabled.
" + "smithy.api#documentation": "The state of the rule.
\nValid values include:
\n\n DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
\n ENABLED: The rule is enabled. \n EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
\n ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all\n events, including Amazon Web Services management events delivered through CloudTrail.
Management events provide visibility into management operations that are performed on\n resources in your Amazon Web Services account. These are also known as control plane\n operations. For more information, see Logging management events in the CloudTrail User\n Guide, and Filtering management events from Amazon Web Services services in the\n \n Amazon EventBridge User Guide\n .
\nThis value is only valid for rules on the default event bus \n or custom event buses. \n It does not apply to partner event buses.
\nAdds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.
\nTargets are the resources that are invoked when a rule is triggered.
\nThe maximum number of entries per request is 10.
\nEach rule can have up to five (5) targets associated with it at one time.
\nFor a list of services you can configure as targets for events, see EventBridge targets\n in the Amazon EventBridge User Guide.
\nCreating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are:
\n\n Amazon EBS CreateSnapshot API call\n
\n Amazon EC2 RebootInstances API call\n
\n Amazon EC2 StopInstances API call\n
\n Amazon EC2 TerminateInstances API\n call\n
For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions: \n
\nFor Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies.
\nFor EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.
For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.
\nIf another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.
\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services \n account.
If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.
If you have an IAM role on a cross-account event bus target, \n a PutTargets call without a role on the same target (same Id and Arn) will not remove the role.
For more information about enabling cross-account events, see PutPermission.
\n\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:
\nIf none of the following arguments are specified for a target, then the entire event\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n Amazon ECS task, in which case nothing from the event is passed to the target).
\nIf Input is specified in the form of valid JSON, then\n the matched event is overridden with this constant.
\nIf InputPath is specified in the form of JSONPath\n (for example, $.detail), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).
If InputTransformer is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.
\nWhen you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.
\nThis action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.
Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.
\nTargets are the resources that are invoked when a rule is triggered.
\nThe maximum number of entries per request is 10.
\nEach rule can have up to five (5) targets associated with it at one time.
\nFor a list of services you can configure as targets for events, see EventBridge targets\n in the \n Amazon EventBridge User Guide\n .
\nCreating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are:
\n\n Amazon EBS CreateSnapshot API call\n
\n Amazon EC2 RebootInstances API call\n
\n Amazon EC2 StopInstances API call\n
\n Amazon EC2 TerminateInstances API call\n
For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event\n goes to by using the KinesisParameters argument. To invoke a command on multiple\n EC2 instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions:
\nFor Lambda and Amazon SNS resources, EventBridge relies\n on resource-based policies.
\nFor EC2 instances, Kinesis Data Streams, Step Functions state machines and\n API Gateway APIs, EventBridge relies on IAM roles that you specify in the\n RoleARN argument in PutTargets.
For more information, see Authentication\n and Access Control in the \n Amazon EventBridge User Guide\n .
\nIf another Amazon Web Services account is in the same region and has granted you permission\n (using PutPermission), you can send events to that account. Set that account's\n event bus as a target of the rules in your account. To send the matched events to the other\n account, specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing.
\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services account.
If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.
If you have an IAM role on a cross-account event bus target, a PutTargets\n call without a role on the same target (same Id and Arn) will not\n remove the role.
For more information about enabling cross-account events, see PutPermission.
\n\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:
\nIf none of the following arguments are specified for a target, then the entire event\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n Amazon ECS task, in which case nothing from the event is passed to the target).
\nIf Input is specified in the form of valid JSON, then\n the matched event is overridden with this constant.
\nIf InputPath is specified in the form of JSONPath\n (for example, $.detail), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).
If InputTransformer is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.
\nWhen you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.
\nThis action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.
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. \n Subsequent SQL statements don't start until the previous statement in the array completes. \n If any SQL statement fails, then because they are run as one transaction, all work is rolled back.
" + "smithy.api#documentation": "One or more SQL statements to run. The SQL statements are run as a single transaction.\n They run serially in the order of the array. Subsequent SQL statements don't start until the\n previous statement in the array completes. If any SQL statement fails, then because they are\n run as one transaction, all work is rolled back.
" } } }, "traits": { - "smithy.api#documentation": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement based on EventBridge events.
" + "smithy.api#documentation": "These are custom parameters to be used when the target is a Amazon Redshift cluster\n to invoke the Amazon Redshift Data API\n ExecuteStatement based on EventBridge events.
" } }, "com.amazonaws.eventbridge#RedshiftSecretManagerArn": { @@ -7696,7 +7792,7 @@ } ], "traits": { - "smithy.api#documentation": "Revokes the permission of another Amazon Web Services account to be able to put events to the specified\n event bus. Specify the account to revoke by the StatementId value that you\n associated with the account when you granted it permission with PutPermission.\n You can find the StatementId by using DescribeEventBus.
Revokes the permission of another Amazon Web Services account to be able to put events to\n the specified event bus. Specify the account to revoke by the StatementId value\n that you associated with the account when you granted it permission with\n PutPermission. You can find the StatementId by using DescribeEventBus.
Removes the specified targets from the specified rule. When the rule is triggered, those\n targets are no longer be invoked.
\nA successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.
When you remove a target, when the associated rule triggers, removed targets might\n continue to be invoked. Allow a short period of time for changes to take effect.
\nThis action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.
The maximum number of entries per request is 10.
" + "smithy.api#documentation": "Removes the specified targets from the specified rule. When the rule is triggered, those\n targets are no longer be invoked.
\nA successful execution of RemoveTargets doesn't guarantee all targets are\n removed from the rule, it means that the target(s) listed in the request are removed.
When you remove a target, when the associated rule triggers, removed targets might\n continue to be invoked. Allow a short period of time for changes to take effect.
\nThis action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.
The maximum number of entries per request is 10.
" } }, "com.amazonaws.eventbridge#RemoveTargetsRequest": { @@ -7779,7 +7875,7 @@ "target": "com.amazonaws.eventbridge#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify\n Force as True to remove targets. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.
If this is a managed rule, created by an Amazon Web Services service on your behalf, you\n must specify Force as True to remove targets. This parameter is\n ignored for rules that are not managed rules. You can check whether a rule is a managed rule\n by using DescribeRule or ListRules and checking the\n ManagedBy field of the response.
The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
", + "smithy.api#documentation": "The failover configuration for an endpoint. This includes what triggers failover and what\n happens when it's triggered.
", "smithy.api#required": {} } } @@ -8160,13 +8256,13 @@ "EventPattern": { "target": "com.amazonaws.eventbridge#EventPattern", "traits": { - "smithy.api#documentation": "The event pattern of the rule. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.
" + "smithy.api#documentation": "The event pattern of the rule. For more information, see Events and Event\n Patterns in the \n Amazon EventBridge User Guide\n .
" } }, "State": { "target": "com.amazonaws.eventbridge#RuleState", "traits": { - "smithy.api#documentation": "The state of the rule.
" + "smithy.api#documentation": "The state of the rule.
\nValid values include:
\n\n DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
\n ENABLED: The rule is enabled. \n EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
\n ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all\n events, including Amazon Web Services management events delivered through CloudTrail.
Management events provide visibility into management operations that are performed on\n resources in your Amazon Web Services account. These are also known as control plane\n operations. For more information, see Logging management events in the CloudTrail User\n Guide, and Filtering management events from Amazon Web Services services in the\n \n Amazon EventBridge User Guide\n .
\nThis value is only valid for rules on the default event bus \n or custom event buses. \n It does not apply to partner event buses.
\nThe scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
" + "smithy.api#documentation": "The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more\n information, see Creating an Amazon EventBridge rule\n that runs on a schedule.
" } }, "RoleArn": { @@ -8190,7 +8286,7 @@ "ManagedBy": { "target": "com.amazonaws.eventbridge#ManagedBy", "traits": { - "smithy.api#documentation": "If the rule was created on behalf of your account by an Amazon Web Services service, this field displays\n the principal name of the service that created the rule.
" + "smithy.api#documentation": "If the rule was created on behalf of your account by an Amazon Web Services service, this\n field displays the principal name of the service that created the rule.
" } }, "EventBusName": { @@ -8353,14 +8449,14 @@ "Name": { "target": "com.amazonaws.eventbridge#SageMakerPipelineParameterName", "traits": { - "smithy.api#documentation": "Name of parameter to start execution of a SageMaker Model Building Pipeline.
", + "smithy.api#documentation": "Name of parameter to start execution of a SageMaker Model Building\n Pipeline.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.eventbridge#SageMakerPipelineParameterValue", "traits": { - "smithy.api#documentation": "Value of parameter to start execution of a SageMaker Model Building Pipeline.
", + "smithy.api#documentation": "Value of parameter to start execution of a SageMaker Model Building\n Pipeline.
", "smithy.api#required": {} } } @@ -8406,12 +8502,12 @@ "PipelineParameterList": { "target": "com.amazonaws.eventbridge#SageMakerPipelineParameterList", "traits": { - "smithy.api#documentation": "List of Parameter names and values for SageMaker Model Building Pipeline execution.
" + "smithy.api#documentation": "List of Parameter names and values for SageMaker Model Building Pipeline\n execution.
" } } }, "traits": { - "smithy.api#documentation": "These are custom parameters to use when the target is a SageMaker Model Building Pipeline\n that starts based on EventBridge events.
" + "smithy.api#documentation": "These are custom parameters to use when the target is a SageMaker Model Building\n Pipeline that starts based on EventBridge events.
" } }, "com.amazonaws.eventbridge#ScheduleExpression": { @@ -8435,7 +8531,7 @@ } }, "traits": { - "smithy.api#documentation": "The secondary Region that processes events when failover is triggered or replication is enabled.
" + "smithy.api#documentation": "The secondary Region that processes events when failover is triggered or replication is\n enabled.
" } }, "com.amazonaws.eventbridge#SecretsManagerSecretArn": { @@ -8651,7 +8747,7 @@ } }, "traits": { - "smithy.api#documentation": "A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses\n support tagging.
" + "smithy.api#documentation": "A key-value pair associated with an Amazon Web Services resource. In EventBridge,\n rules and event buses support tagging.
" } }, "com.amazonaws.eventbridge#TagKey": { @@ -8698,7 +8794,7 @@ } ], "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can\n help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user permission to access or change only resources with certain tag\n values. In EventBridge, rules and event buses can be tagged.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of\n characters.
\nYou can use the TagResource action with a resource that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n resource. If you specify a tag key that is already associated with the resource, the new tag\n value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
" + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can\n help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user permission to access or change only resources with certain tag\n values. In EventBridge, rules and event buses can be tagged.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as\n strings of characters.
\nYou can use the TagResource action with a resource that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n resource. If you specify a tag key that is already associated with the resource, the new tag\n value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
" } }, "com.amazonaws.eventbridge#TagResourceRequest": { @@ -8745,7 +8841,7 @@ "Id": { "target": "com.amazonaws.eventbridge#TargetId", "traits": { - "smithy.api#documentation": "The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
", + "smithy.api#documentation": "The ID of the target within the specified rule. Use this ID to reference the target when\n updating the rule. We recommend using a memorable and unique string.
", "smithy.api#required": {} } }, @@ -8759,7 +8855,7 @@ "RoleArn": { "target": "com.amazonaws.eventbridge#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is\n triggered. If one rule triggers multiple targets, you can use a different IAM role for each\n target.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If\n one rule triggers multiple targets, you can use a different IAM role for each target.
" } }, "Input": { @@ -8801,7 +8897,7 @@ "BatchParameters": { "target": "com.amazonaws.eventbridge#BatchParameters", "traits": { - "smithy.api#documentation": "If the event target is an Batch job, this contains the job definition, job name, and\n other parameters. For more information, see Jobs in the Batch User\n Guide.
" + "smithy.api#documentation": "If the event target is an Batch job, this contains the job definition, job\n name, and other parameters. For more information, see Jobs in the Batch\n User Guide.
" } }, "SqsParameters": { @@ -8813,19 +8909,19 @@ "HttpParameters": { "target": "com.amazonaws.eventbridge#HttpParameters", "traits": { - "smithy.api#documentation": "Contains the HTTP parameters to use when the target is a API Gateway endpoint or\n EventBridge ApiDestination.
\nIf you specify an API Gateway API or EventBridge ApiDestination as a target, you can\n use this parameter to specify headers, path parameters, and query string keys/values as part\n of your target invoking request. If you're using ApiDestinations, the corresponding Connection\n can also have these values configured. In case of any conflicting keys, values from the\n Connection take precedence.
" + "smithy.api#documentation": "Contains the HTTP parameters to use when the target is a API Gateway endpoint or\n EventBridge ApiDestination.
\nIf you specify an API Gateway API or EventBridge ApiDestination as a target,\n you can use this parameter to specify headers, path parameters, and query string keys/values\n as part of your target invoking request. If you're using ApiDestinations, the corresponding\n Connection can also have these values configured. In case of any conflicting keys, values from\n the Connection take precedence.
" } }, "RedshiftDataParameters": { "target": "com.amazonaws.eventbridge#RedshiftDataParameters", "traits": { - "smithy.api#documentation": "Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift\n cluster.
\nIf you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to\n invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
" + "smithy.api#documentation": "Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
\nIf you specify a Amazon Redshift Cluster as a Target, you can use this to specify\n parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
" } }, "SageMakerPipelineParameters": { "target": "com.amazonaws.eventbridge#SageMakerPipelineParameters", "traits": { - "smithy.api#documentation": "Contains the SageMaker Model Building Pipeline parameters to start execution of a\n SageMaker Model Building Pipeline.
\nIf you specify a SageMaker Model Building Pipeline as a target, you can use this to\n specify parameters to start a pipeline execution based on EventBridge events.
" + "smithy.api#documentation": "Contains the SageMaker Model Building Pipeline parameters to start execution of a\n SageMaker Model Building Pipeline.
\nIf you specify a SageMaker Model Building Pipeline as a target, you can use this\n to specify parameters to start a pipeline execution based on EventBridge events.
" } }, "DeadLetterConfig": { @@ -8843,12 +8939,12 @@ "AppSyncParameters": { "target": "com.amazonaws.eventbridge#AppSyncParameters", "traits": { - "smithy.api#documentation": "Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
" + "smithy.api#documentation": "Contains the GraphQL operation to be parsed and executed, if the event target is an\n AppSync API.
" } } }, "traits": { - "smithy.api#documentation": "Targets are the resources to be invoked when a rule is triggered. For a complete list of\n services and resources that can be set as a target, see PutTargets.
\nIf you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.
Targets are the resources to be invoked when a rule is triggered. For a complete list of\n services and resources that can be set as a target, see PutTargets.
\nIf you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.
Tests whether the specified event pattern matches the provided event.
\nMost services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.
" + "smithy.api#documentation": "Tests whether the specified event pattern matches the provided event.
\nMost services in Amazon Web Services treat : or / as the same character in Amazon Resource\n Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be\n sure to use the correct ARN characters when creating event patterns so that they match the ARN\n syntax in the event you want to match.
" } }, "com.amazonaws.eventbridge#TestEventPatternRequest": { @@ -8947,14 +9043,14 @@ "EventPattern": { "target": "com.amazonaws.eventbridge#EventPattern", "traits": { - "smithy.api#documentation": "The event pattern. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.
", + "smithy.api#documentation": "The event pattern. For more information, see Events and Event\n Patterns in the \n Amazon EventBridge User Guide\n .
", "smithy.api#required": {} } }, "Event": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "The event, in JSON format, to test against the event pattern. The JSON must follow the\n format specified in Amazon Web Services Events, and the following\n fields are mandatory:
\n\n id\n
\n account\n
\n source\n
\n time\n
\n region\n
\n resources\n
\n detail-type\n
The event, in JSON format, to test against the event pattern. The JSON must follow the\n format specified in Amazon Web Services Events, and\n the following fields are mandatory:
\n\n id\n
\n account\n
\n source\n
\n time\n
\n region\n
\n resources\n
\n detail-type\n
Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
" + "smithy.api#documentation": "Update an existing endpoint. For more information about global endpoints, see Making\n applications Regional-fault tolerant with global endpoints and event replication in\n the \n Amazon EventBridge User Guide\n .
" } }, "com.amazonaws.eventbridge#UpdateEndpointRequest": { @@ -9579,7 +9675,7 @@ "ReplicationConfig": { "target": "com.amazonaws.eventbridge#ReplicationConfig", "traits": { - "smithy.api#documentation": "Whether event replication was enabled or disabled for the endpoint you updated in this request.
" + "smithy.api#documentation": "Whether event replication was enabled or disabled for the endpoint you updated in this\n request.
" } }, "EventBuses": { @@ -9591,7 +9687,7 @@ "RoleArn": { "target": "com.amazonaws.eventbridge#IamRoleArn", "traits": { - "smithy.api#documentation": "The ARN of the role used by event replication for the endpoint you updated in this request.
" + "smithy.api#documentation": "The ARN of the role used by event replication for the endpoint you updated in this\n request.
" } }, "EndpointId": { @@ -9616,6 +9712,96 @@ "traits": { "smithy.api#output": {} } + }, + "com.amazonaws.eventbridge#UpdateEventBus": { + "type": "operation", + "input": { + "target": "com.amazonaws.eventbridge#UpdateEventBusRequest" + }, + "output": { + "target": "com.amazonaws.eventbridge#UpdateEventBusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eventbridge#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.eventbridge#InternalException" + }, + { + "target": "com.amazonaws.eventbridge#OperationDisabledException" + }, + { + "target": "com.amazonaws.eventbridge#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified event bus.
" + } + }, + "com.amazonaws.eventbridge#UpdateEventBusRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "The name of the event bus.
" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
\nIf you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt events on the event bus.
\nFor more information, see Managing keys in the Key Management Service\n Developer Guide.
\nArchives and schema discovery are not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:
\nYou call \n CreateArchive\n on an event bus set to use a customer managed key for encryption.
You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.
You call \n UpdatedEventBus\n to set a customer managed key on an event bus with an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
\nThe event bus description.
" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eventbridge#UpdateEventBusResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.eventbridge#String", + "traits": { + "smithy.api#documentation": "The event bus Amazon Resource Name (ARN).
" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "The event bus name.
" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the KMS\n customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.
\nFor more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
" + } + }, + "Description": { + "target": "com.amazonaws.eventbridge#EventBusDescription", + "traits": { + "smithy.api#documentation": "The event bus description.
" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig" + } + }, + "traits": { + "smithy.api#output": {} + } } } }