feat(client-eventbridge): Minor comments for Redshift Serverless workgroup target support.

Author: awstools

clients/client-eventbridge/src/EventBridge.ts

@@ -823,14 +823,11 @@ export class EventBridge extends EventBridgeClient {
   /**
    * <p>Deletes the specified rule.</p>
    *          <p>Before you can delete the rule, you must remove all targets, using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html">RemoveTargets</a>.</p>
-   *
    *          <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow
    *       a short period of time for changes to take effect.</p>
-   *
    *          <p>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, <code>ResourceNotFoundException</code> is
    *       returned.</p>
-   *
    *          <p>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 <code>Force</code> option, but you should do so only if you
@@ -1167,7 +1164,6 @@ export class EventBridge extends EventBridgeClient {
   /**
    * <p>Disables the specified rule. A disabled rule won't match any events, and won't
    *       self-trigger if it has a schedule expression.</p>
-   *
    *          <p>When you disable a rule, incoming events might continue to match to the disabled rule.
    *       Allow a short period of time for changes to take effect.</p>
    */
@@ -1196,7 +1192,6 @@ export class EventBridge extends EventBridgeClient {
 
   /**
    * <p>Enables the specified rule. If the rule does not exist, the operation fails.</p>
-   *
    *          <p>When you enable a rule, incoming events might not immediately start matching to a newly
    *       enabled rule. Allow a short period of time for changes to take effect.</p>
    */
@@ -1545,7 +1540,6 @@ export class EventBridge extends EventBridgeClient {
   /**
    * <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide
    *       a prefix to match to the rule names.</p>
-   *
    *          <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
    *       use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
    */
@@ -1706,19 +1700,16 @@ export class EventBridge extends EventBridgeClient {
    *       account. </p>
    *          <p>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.</p>
-   *
    *          <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run
    *         <code>PutPermission</code> once for each of these accounts. Or, if all the accounts are
    *       members of the same Amazon Web Services organization, you can run <code>PutPermission</code> once specifying
    *         <code>Principal</code> as "*" and specifying the Amazon Web Services organization ID in
    *         <code>Condition</code>, to grant permissions to all accounts in that organization.</p>
-   *
    *          <p>If you grant permissions using an organization, then accounts in that organization must
    *       specify a <code>RoleArn</code> with proper permissions when they use <code>PutTarget</code> to
    *       add your account's event bus as a target. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
    *         Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
    *         Guide</i>.</p>
-   *
    *          <p>The permission policy on the event bus cannot exceed 10 KB in size.</p>
    */
   public putPermission(
@@ -1753,39 +1744,32 @@ export class EventBridge extends EventBridgeClient {
   /**
    * <p>Creates or updates the specified rule. Rules are enabled by default, or based on value of
    *       the state. You can disable a rule using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html">DisableRule</a>.</p>
-   *
    *          <p>A single rule watches for events from a single event bus. Events generated by Amazon Web Services services
    *       go to your account's default event bus. Events generated by SaaS partner 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 <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
-   *
    *          <p>If you are updating an existing rule, the rule is replaced with what you specify in this
    *         <code>PutRule</code> command. If you omit arguments in <code>PutRule</code>, the old values
    *       for those arguments are not kept. Instead, they are replaced with null values.</p>
-   *
    *          <p>When you create or update a rule, incoming events might not immediately start matching to
    *       new or updated rules. Allow a short period of time for changes to take effect.</p>
-   *
    *          <p>A rule must contain at least an EventPattern or ScheduleExpression. Rules with
    *       EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions
    *       self-trigger based on the given schedule. A rule can have both an EventPattern and a
    *       ScheduleExpression, in which case the rule triggers on matching events as well as on a
    *       schedule.</p>
-   *
    *          <p>When you initially create a rule, you can optionally assign one or more tags to the rule.
    *       Tags can 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 rules with certain tag
    *       values. To use the <code>PutRule</code> operation and assign tags, you must have both the
    *         <code>events:PutRule</code> and <code>events:TagResource</code> permissions.</p>
    *          <p>If you are updating an existing rule, any tags you specify in the <code>PutRule</code>
    *       operation are ignored. To update the tags of an existing rule, use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html">TagResource</a> and <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
-   *
    *          <p>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.</p>
-   *
    *          <p>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
@@ -1830,7 +1814,6 @@ export class EventBridge extends EventBridgeClient {
    *             <p>Each rule can have up to five (5) targets associated with it at one time.</p>
    *          </note>
    *          <p>You can configure the following as targets for Events:</p>
-   *
    *          <ul>
    *             <li>
    *                <p>
@@ -1908,6 +1891,9 @@ export class EventBridge extends EventBridgeClient {
    *                <p>Redshift cluster</p>
    *             </li>
    *             <li>
+   *                <p>Redshift Serverless workgroup</p>
+   *             </li>
+   *             <li>
    *                <p>SageMaker Pipeline</p>
    *             </li>
    *             <li>
@@ -1929,25 +1915,21 @@ export class EventBridge extends EventBridgeClient {
    *                <p>Systems Manager Run Command</p>
    *             </li>
    *          </ul>
-   *
    *          <p>Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
    *       built-in targets are <code>EC2 CreateSnapshot API call</code>, <code>EC2 RebootInstances API
    *         call</code>, <code>EC2 StopInstances API call</code>, and <code>EC2 TerminateInstances API
    *         call</code>. </p>
-   *
    *          <p>For some target types, <code>PutTargets</code> 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 <code>KinesisParameters</code> argument. To invoke a command on multiple EC2
    *       instances with one rule, you can use the <code>RunCommandParameters</code> field.</p>
-   *
    *          <p>To be able to make API calls against the resources that you own, Amazon EventBridge
    *       needs the appropriate permissions. 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 REST APIs, EventBridge relies on
+   *       Step Functions state machines and API Gateway APIs, EventBridge relies on
    *       IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>.
    *       For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html">Authentication
    *         and Access Control</a> in the <i>Amazon EventBridge User Guide</i>.</p>
-   *
    *          <p>If another Amazon Web Services account is in the same region and has granted you permission (using
    *         <code>PutPermission</code>), 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,
@@ -1956,28 +1938,23 @@ export class EventBridge extends EventBridgeClient {
    *       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 <a href="http://aws.amazon.com/eventbridge/pricing/">Amazon EventBridge
    *         Pricing</a>.</p>
-   *
    *          <note>
    *             <p>
    *                <code>Input</code>, <code>InputPath</code>, and <code>InputTransformer</code> are not
    *         available with <code>PutTarget</code> if the target is an event bus of a different Amazon Web Services
    *         account.</p>
    *          </note>
-   *
    *          <p>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 <code>RoleArn</code> with proper permissions in the
    *         <code>Target</code> structure. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
    *           Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
    *         Guide</i>.</p>
-   *
    *          <p>For more information about enabling cross-account events, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html">PutPermission</a>.</p>
-   *
    *          <p>
    *             <b>Input</b>, <b>InputPath</b>, and
    *         <b>InputTransformer</b> are mutually exclusive and optional
    *       parameters of a target. When a rule is triggered due to a matched event:</p>
-   *
    *          <ul>
    *             <li>
    *                <p>If none of the following arguments are specified for a target, then the entire event
@@ -2000,14 +1977,11 @@ export class EventBridge extends EventBridgeClient {
    *           specify as the input to the target.</p>
    *             </li>
    *          </ul>
-   *
    *          <p>When you specify <code>InputPath</code> or <code>InputTransformer</code>, you must use
    *       JSON dot notation, not bracket notation.</p>
-   *
    *          <p>When you add targets to a rule and the associated rule triggers soon after, new or updated
    *       targets might not be immediately invoked. Allow a short period of time for changes to take
    *       effect.</p>
-   *
    *          <p>This action can partially fail if too many requests are made at the same time. If that
    *       happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in
    *         <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>
@@ -2073,14 +2047,11 @@ export class EventBridge extends EventBridgeClient {
   /**
    * <p>Removes the specified targets from the specified rule. When the rule is triggered, those
    *       targets are no longer be invoked.</p>
-   *
    *          <note>
    *             <p>A successful execution of <code>RemoveTargets</code> doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.</p>
    *          </note>
-   *
    *          <p>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.</p>
-   *
    *          <p>This action can partially fail if too many requests are made at the same time. If that
    *       happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in
    *         <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>

clients/client-eventbridge/src/commands/DeleteRuleCommand.ts

@@ -26,14 +26,11 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {}
 /**
  * <p>Deletes the specified rule.</p>
  *          <p>Before you can delete the rule, you must remove all targets, using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html">RemoveTargets</a>.</p>
- *
  *          <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow
  *       a short period of time for changes to take effect.</p>
- *
  *          <p>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, <code>ResourceNotFoundException</code> is
  *       returned.</p>
- *
  *          <p>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 <code>Force</code> option, but you should do so only if you

clients/client-eventbridge/src/commands/DisableRuleCommand.ts

@@ -26,7 +26,6 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {}
 /**
  * <p>Disables the specified rule. A disabled rule won't match any events, and won't
  *       self-trigger if it has a schedule expression.</p>
- *
  *          <p>When you disable a rule, incoming events might continue to match to the disabled rule.
  *       Allow a short period of time for changes to take effect.</p>
  * @example

clients/client-eventbridge/src/commands/EnableRuleCommand.ts

@@ -25,7 +25,6 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {}
 
 /**
  * <p>Enables the specified rule. If the rule does not exist, the operation fails.</p>
- *
  *          <p>When you enable a rule, incoming events might not immediately start matching to a newly
  *       enabled rule. Allow a short period of time for changes to take effect.</p>
  * @example

clients/client-eventbridge/src/commands/ListRulesCommand.ts

@@ -28,7 +28,6 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea
 /**
  * <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide
  *       a prefix to match to the rule names.</p>
- *
  *          <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
  *       use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
  * @example

clients/client-eventbridge/src/commands/PutPermissionCommand.ts

@@ -30,19 +30,16 @@ export interface PutPermissionCommandOutput extends __MetadataBearer {}
  *       account. </p>
  *          <p>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.</p>
- *
  *          <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run
  *         <code>PutPermission</code> once for each of these accounts. Or, if all the accounts are
  *       members of the same Amazon Web Services organization, you can run <code>PutPermission</code> once specifying
  *         <code>Principal</code> as "*" and specifying the Amazon Web Services organization ID in
  *         <code>Condition</code>, to grant permissions to all accounts in that organization.</p>
- *
  *          <p>If you grant permissions using an organization, then accounts in that organization must
  *       specify a <code>RoleArn</code> with proper permissions when they use <code>PutTarget</code> to
  *       add your account's event bus as a target. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
  *         Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
  *         Guide</i>.</p>
- *
  *          <p>The permission policy on the event bus cannot exceed 10 KB in size.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.