@aws-sdk/client-cloudwatch-events 3.296.0 → 3.297.0

package/dist-types/CloudWatchEvents.d.ts

@@ -52,6 +52,7 @@ import { UpdateApiDestinationCommandInput, UpdateApiDestinationCommandOutput } f
 import { UpdateArchiveCommandInput, UpdateArchiveCommandOutput } from "./commands/UpdateArchiveCommand";
 import { UpdateConnectionCommandInput, UpdateConnectionCommandOutput } from "./commands/UpdateConnectionCommand";
 /**
+ * @public
  * <p>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
@@ -76,6 +77,7 @@ import { UpdateConnectionCommandInput, UpdateConnectionCommandOutput } from "./c
  */
 export declare class CloudWatchEvents extends CloudWatchEventsClient {
     /**
+     * @public
      * <p>Activates a partner event source that has been deactivated. Once activated, your matching
      *       event bus will start receiving events from the event source.</p>
      */
@@ -83,12 +85,14 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     activateEventSource(args: ActivateEventSourceCommandInput, cb: (err: any, data?: ActivateEventSourceCommandOutput) => void): void;
     activateEventSource(args: ActivateEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateEventSourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Cancels the specified replay.</p>
      */
     cancelReplay(args: CancelReplayCommandInput, options?: __HttpHandlerOptions): Promise<CancelReplayCommandOutput>;
     cancelReplay(args: CancelReplayCommandInput, cb: (err: any, data?: CancelReplayCommandOutput) => void): void;
     cancelReplay(args: CancelReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelReplayCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates an API destination, which is an HTTP invocation endpoint configured as a target
      *       for events.</p>
      */
@@ -96,6 +100,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     createApiDestination(args: CreateApiDestinationCommandInput, cb: (err: any, data?: CreateApiDestinationCommandOutput) => void): void;
     createApiDestination(args: CreateApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApiDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates an archive of events with the specified settings. When you create an archive,
      *       incoming events might not immediately start being sent to the archive. Allow a short period of
      *       time for changes to take effect. If you do not specify a pattern to filter events sent to the
@@ -106,6 +111,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     createArchive(args: CreateArchiveCommandInput, cb: (err: any, data?: CreateArchiveCommandOutput) => void): void;
     createArchive(args: CreateArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateArchiveCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a connection. A connection defines the authorization type and credentials to use
      *       for authorization with an API destination HTTP endpoint.</p>
      */
@@ -113,6 +119,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     createConnection(args: CreateConnectionCommandInput, cb: (err: any, data?: CreateConnectionCommandOutput) => void): void;
     createConnection(args: CreateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a new event bus within your account. This can be a custom event bus which you can
      *       use to receive events from your custom applications and services, or it can be a partner event
      *       bus which can be matched to a partner event source.</p>
@@ -121,6 +128,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     createEventBus(args: CreateEventBusCommandInput, cb: (err: any, data?: CreateEventBusCommandOutput) => void): void;
     createEventBus(args: CreateEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventBusCommandOutput) => void): void;
     /**
+     * @public
      * <p>Called by an SaaS partner to create a partner event source. This operation is not used by
      *       Amazon Web Services customers.</p>
      *          <p>Each partner event source can be used by one Amazon Web Services account to create a matching partner
@@ -150,6 +158,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     createPartnerEventSource(args: CreatePartnerEventSourceCommandInput, cb: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void): void;
     createPartnerEventSource(args: CreatePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>You can use this operation to temporarily stop receiving events from the specified partner
      *       event source. The matching event bus is not deleted. </p>
      *          <p>When you deactivate a partner event source, the source goes into PENDING state. If it
@@ -160,6 +169,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     deactivateEventSource(args: DeactivateEventSourceCommandInput, cb: (err: any, data?: DeactivateEventSourceCommandOutput) => void): void;
     deactivateEventSource(args: DeactivateEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateEventSourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes all authorization parameters from the connection. This lets you remove the secret
      *       from the connection so you can reuse it without having to create a new connection.</p>
      */
@@ -167,24 +177,28 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     deauthorizeConnection(args: DeauthorizeConnectionCommandInput, cb: (err: any, data?: DeauthorizeConnectionCommandOutput) => void): void;
     deauthorizeConnection(args: DeauthorizeConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeauthorizeConnectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified API destination.</p>
      */
     deleteApiDestination(args: DeleteApiDestinationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteApiDestinationCommandOutput>;
     deleteApiDestination(args: DeleteApiDestinationCommandInput, cb: (err: any, data?: DeleteApiDestinationCommandOutput) => void): void;
     deleteApiDestination(args: DeleteApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApiDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified archive.</p>
      */
     deleteArchive(args: DeleteArchiveCommandInput, options?: __HttpHandlerOptions): Promise<DeleteArchiveCommandOutput>;
     deleteArchive(args: DeleteArchiveCommandInput, cb: (err: any, data?: DeleteArchiveCommandOutput) => void): void;
     deleteArchive(args: DeleteArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteArchiveCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a connection.</p>
      */
     deleteConnection(args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConnectionCommandOutput>;
     deleteConnection(args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void): void;
     deleteConnection(args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified custom event bus or partner event bus. All rules associated with
      *       this event bus need to be deleted. You can't delete your account's default event bus.</p>
      */
@@ -192,6 +206,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     deleteEventBus(args: DeleteEventBusCommandInput, cb: (err: any, data?: DeleteEventBusCommandOutput) => void): void;
     deleteEventBus(args: DeleteEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventBusCommandOutput) => void): void;
     /**
+     * @public
      * <p>This operation is used by SaaS partners to delete a partner event source. This operation
      *       is not used by Amazon Web Services customers.</p>
      *          <p>When you delete an event source, the status of the corresponding partner event bus in the
@@ -202,6 +217,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     deletePartnerEventSource(args: DeletePartnerEventSourceCommandInput, cb: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void): void;
     deletePartnerEventSource(args: DeletePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void): void;
     /**
+     * @public
      * <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>
      *
@@ -221,24 +237,28 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void;
     deleteRule(args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves details about an API destination.</p>
      */
     describeApiDestination(args: DescribeApiDestinationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeApiDestinationCommandOutput>;
     describeApiDestination(args: DescribeApiDestinationCommandInput, cb: (err: any, data?: DescribeApiDestinationCommandOutput) => void): void;
     describeApiDestination(args: DescribeApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApiDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves details about an archive.</p>
      */
     describeArchive(args: DescribeArchiveCommandInput, options?: __HttpHandlerOptions): Promise<DescribeArchiveCommandOutput>;
     describeArchive(args: DescribeArchiveCommandInput, cb: (err: any, data?: DescribeArchiveCommandOutput) => void): void;
     describeArchive(args: DescribeArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeArchiveCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves details about a connection.</p>
      */
     describeConnection(args: DescribeConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConnectionCommandOutput>;
     describeConnection(args: DescribeConnectionCommandInput, cb: (err: any, data?: DescribeConnectionCommandOutput) => void): void;
     describeConnection(args: DescribeConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>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,
@@ -251,6 +271,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     describeEventBus(args: DescribeEventBusCommandInput, cb: (err: any, data?: DescribeEventBusCommandOutput) => void): void;
     describeEventBus(args: DescribeEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventBusCommandOutput) => void): void;
     /**
+     * @public
      * <p>This operation lists details about a partner event source that is shared with your
      *       account.</p>
      */
@@ -258,6 +279,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     describeEventSource(args: DescribeEventSourceCommandInput, cb: (err: any, data?: DescribeEventSourceCommandOutput) => void): void;
     describeEventSource(args: DescribeEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html">DescribeEventSource</a>
      *       to see details about a partner event source that is
@@ -267,6 +289,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     describePartnerEventSource(args: DescribePartnerEventSourceCommandInput, cb: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void): void;
     describePartnerEventSource(args: DescribePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves details about a replay. Use <code>DescribeReplay</code> to determine the
      *       progress of a running replay. A replay processes events to replay based on the time in the
      *       event, and replays them using 1 minute intervals. If you use <code>StartReplay</code> and
@@ -281,6 +304,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     describeReplay(args: DescribeReplayCommandInput, cb: (err: any, data?: DescribeReplayCommandOutput) => void): void;
     describeReplay(args: DescribeReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplayCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the specified rule.</p>
      *          <p>DescribeRule 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>
@@ -289,6 +313,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     describeRule(args: DescribeRuleCommandInput, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void;
     describeRule(args: DescribeRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void;
     /**
+     * @public
      * <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>
      *
@@ -299,6 +324,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     disableRule(args: DisableRuleCommandInput, cb: (err: any, data?: DisableRuleCommandOutput) => void): void;
     disableRule(args: DisableRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableRuleCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -308,12 +334,14 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     enableRule(args: EnableRuleCommandInput, cb: (err: any, data?: EnableRuleCommandOutput) => void): void;
     enableRule(args: EnableRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableRuleCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves a list of API destination in the account in the current Region.</p>
      */
     listApiDestinations(args: ListApiDestinationsCommandInput, options?: __HttpHandlerOptions): Promise<ListApiDestinationsCommandOutput>;
     listApiDestinations(args: ListApiDestinationsCommandInput, cb: (err: any, data?: ListApiDestinationsCommandOutput) => void): void;
     listApiDestinations(args: ListApiDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApiDestinationsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists your archives. You can either list all the archives or you can provide a prefix to
      *       match to the archive names. Filter parameters are exclusive.</p>
      */
@@ -321,12 +349,14 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     listArchives(args: ListArchivesCommandInput, cb: (err: any, data?: ListArchivesCommandOutput) => void): void;
     listArchives(args: ListArchivesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListArchivesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves a list of connections from the account.</p>
      */
     listConnections(args: ListConnectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListConnectionsCommandOutput>;
     listConnections(args: ListConnectionsCommandInput, cb: (err: any, data?: ListConnectionsCommandOutput) => void): void;
     listConnections(args: ListConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all the event buses in your account, including the default event bus, custom event
      *       buses, and partner event buses.</p>
      */
@@ -334,6 +364,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     listEventBuses(args: ListEventBusesCommandInput, cb: (err: any, data?: ListEventBusesCommandOutput) => void): void;
     listEventBuses(args: ListEventBusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventBusesCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
      */
@@ -341,6 +372,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     listEventSources(args: ListEventSourcesCommandInput, cb: (err: any, data?: ListEventSourcesCommandOutput) => void): void;
     listEventSources(args: ListEventSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventSourcesCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
@@ -349,6 +381,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     listPartnerEventSourceAccounts(args: ListPartnerEventSourceAccountsCommandInput, cb: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void): void;
     listPartnerEventSourceAccounts(args: ListPartnerEventSourceAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void): void;
     /**
+     * @public
      * <p>An SaaS partner can use this operation to list all the partner event source names that
      *       they have created. This operation is not used by Amazon Web Services customers.</p>
      */
@@ -356,6 +389,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     listPartnerEventSources(args: ListPartnerEventSourcesCommandInput, cb: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void): void;
     listPartnerEventSources(args: ListPartnerEventSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists your replays. You can either list all the replays or you can provide a prefix to
      *       match to the replay names. Filter parameters are exclusive.</p>
      */
@@ -363,6 +397,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     listReplays(args: ListReplaysCommandInput, cb: (err: any, data?: ListReplaysCommandOutput) => void): void;
     listReplays(args: ListReplaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReplaysCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the rules for the specified target. You can see which of the rules in Amazon
      *       EventBridge can invoke a specific target in your account.</p>
      */
@@ -370,6 +405,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     listRuleNamesByTarget(args: ListRuleNamesByTargetCommandInput, cb: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void): void;
     listRuleNamesByTarget(args: ListRuleNamesByTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void): void;
     /**
+     * @public
      * <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>
      *
@@ -380,6 +416,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void;
     listRules(args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Displays the tags associated with an EventBridge resource. In EventBridge, rules and event
      *       buses can be tagged.</p>
      */
@@ -387,18 +424,21 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the targets assigned to the specified rule.</p>
      */
     listTargetsByRule(args: ListTargetsByRuleCommandInput, options?: __HttpHandlerOptions): Promise<ListTargetsByRuleCommandOutput>;
     listTargetsByRule(args: ListTargetsByRuleCommandInput, cb: (err: any, data?: ListTargetsByRuleCommandOutput) => void): void;
     listTargetsByRule(args: ListTargetsByRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetsByRuleCommandOutput) => void): void;
     /**
+     * @public
      * <p>Sends custom events to Amazon EventBridge so that they can be matched to rules.</p>
      */
     putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise<PutEventsCommandOutput>;
     putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void;
     putEvents(args: PutEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventsCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      */
@@ -406,6 +446,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     putPartnerEvents(args: PutPartnerEventsCommandInput, cb: (err: any, data?: PutPartnerEventsCommandOutput) => void): void;
     putPartnerEvents(args: PutPartnerEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPartnerEventsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Running <code>PutPermission</code> permits the specified Amazon Web Services account or Amazon Web Services organization
      *       to put events to the specified <i>event bus</i>. Amazon EventBridge (CloudWatch
      *       Events) rules in your account are triggered by these events arriving to an event bus in your
@@ -431,6 +472,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     putPermission(args: PutPermissionCommandInput, cb: (err: any, data?: PutPermissionCommandOutput) => void): void;
     putPermission(args: PutPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionCommandOutput) => void): void;
     /**
+     * @public
      * <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>
      *
@@ -483,6 +525,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     putRule(args: PutRuleCommandInput, cb: (err: any, data?: PutRuleCommandOutput) => void): void;
     putRule(args: PutRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRuleCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds the specified targets to the specified rule, or updates the targets if they are
      *       already associated with the rule.</p>
      *          <p>Targets are the resources that are invoked when a rule is triggered.</p>
@@ -654,6 +697,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     putTargets(args: PutTargetsCommandInput, cb: (err: any, data?: PutTargetsCommandOutput) => void): void;
     putTargets(args: PutTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutTargetsCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <code>StatementId</code> value that you
      *       associated with the account when you granted it permission with <code>PutPermission</code>.
@@ -663,6 +707,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     removePermission(args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
     removePermission(args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes the specified targets from the specified rule. When the rule is triggered, those
      *       targets are no longer be invoked.</p>
      *
@@ -677,6 +722,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     removeTargets(args: RemoveTargetsCommandInput, cb: (err: any, data?: RemoveTargetsCommandOutput) => void): void;
     removeTargets(args: RemoveTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTargetsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Starts the specified replay. Events are not necessarily replayed in the exact same order
      *       that they were added to the archive. A replay processes events to replay based on the time in
      *       the event, and replays them using 1 minute intervals. If you specify an
@@ -691,6 +737,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     startReplay(args: StartReplayCommandInput, cb: (err: any, data?: StartReplayCommandOutput) => void): void;
     startReplay(args: StartReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReplayCommandOutput) => void): void;
     /**
+     * @public
      * <p>Assigns one or more tags (key-value pairs) to the specified EventBridge resource. 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 resources with certain tag
@@ -707,6 +754,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Tests whether the specified event pattern matches the provided event.</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
@@ -717,6 +765,7 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     testEventPattern(args: TestEventPatternCommandInput, cb: (err: any, data?: TestEventPatternCommandOutput) => void): void;
     testEventPattern(args: TestEventPatternCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestEventPatternCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge
      *       (CloudWatch Events), rules and event buses can be tagged.</p>
      */
@@ -724,18 +773,21 @@ export declare class CloudWatchEvents extends CloudWatchEventsClient {
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates an API destination.</p>
      */
     updateApiDestination(args: UpdateApiDestinationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateApiDestinationCommandOutput>;
     updateApiDestination(args: UpdateApiDestinationCommandInput, cb: (err: any, data?: UpdateApiDestinationCommandOutput) => void): void;
     updateApiDestination(args: UpdateApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApiDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the specified archive.</p>
      */
     updateArchive(args: UpdateArchiveCommandInput, options?: __HttpHandlerOptions): Promise<UpdateArchiveCommandOutput>;
     updateArchive(args: UpdateArchiveCommandInput, cb: (err: any, data?: UpdateArchiveCommandOutput) => void): void;
     updateArchive(args: UpdateArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateArchiveCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates settings for a connection.</p>
      */
     updateConnection(args: UpdateConnectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateConnectionCommandOutput>;

package/dist-types/CloudWatchEventsClient.d.ts

@@ -59,15 +59,24 @@ import { UpdateApiDestinationCommandInput, UpdateApiDestinationCommandOutput } f
 import { UpdateArchiveCommandInput, UpdateArchiveCommandOutput } from "./commands/UpdateArchiveCommand";
 import { UpdateConnectionCommandInput, UpdateConnectionCommandOutput } from "./commands/UpdateConnectionCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = ActivateEventSourceCommandInput | CancelReplayCommandInput | CreateApiDestinationCommandInput | CreateArchiveCommandInput | CreateConnectionCommandInput | CreateEventBusCommandInput | CreatePartnerEventSourceCommandInput | DeactivateEventSourceCommandInput | DeauthorizeConnectionCommandInput | DeleteApiDestinationCommandInput | DeleteArchiveCommandInput | DeleteConnectionCommandInput | DeleteEventBusCommandInput | DeletePartnerEventSourceCommandInput | DeleteRuleCommandInput | DescribeApiDestinationCommandInput | DescribeArchiveCommandInput | DescribeConnectionCommandInput | DescribeEventBusCommandInput | DescribeEventSourceCommandInput | DescribePartnerEventSourceCommandInput | DescribeReplayCommandInput | DescribeRuleCommandInput | DisableRuleCommandInput | EnableRuleCommandInput | ListApiDestinationsCommandInput | ListArchivesCommandInput | ListConnectionsCommandInput | ListEventBusesCommandInput | ListEventSourcesCommandInput | ListPartnerEventSourceAccountsCommandInput | ListPartnerEventSourcesCommandInput | ListReplaysCommandInput | ListRuleNamesByTargetCommandInput | ListRulesCommandInput | ListTagsForResourceCommandInput | ListTargetsByRuleCommandInput | PutEventsCommandInput | PutPartnerEventsCommandInput | PutPermissionCommandInput | PutRuleCommandInput | PutTargetsCommandInput | RemovePermissionCommandInput | RemoveTargetsCommandInput | StartReplayCommandInput | TagResourceCommandInput | TestEventPatternCommandInput | UntagResourceCommandInput | UpdateApiDestinationCommandInput | UpdateArchiveCommandInput | UpdateConnectionCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = ActivateEventSourceCommandOutput | CancelReplayCommandOutput | CreateApiDestinationCommandOutput | CreateArchiveCommandOutput | CreateConnectionCommandOutput | CreateEventBusCommandOutput | CreatePartnerEventSourceCommandOutput | DeactivateEventSourceCommandOutput | DeauthorizeConnectionCommandOutput | DeleteApiDestinationCommandOutput | DeleteArchiveCommandOutput | DeleteConnectionCommandOutput | DeleteEventBusCommandOutput | DeletePartnerEventSourceCommandOutput | DeleteRuleCommandOutput | DescribeApiDestinationCommandOutput | DescribeArchiveCommandOutput | DescribeConnectionCommandOutput | DescribeEventBusCommandOutput | DescribeEventSourceCommandOutput | DescribePartnerEventSourceCommandOutput | DescribeReplayCommandOutput | DescribeRuleCommandOutput | DisableRuleCommandOutput | EnableRuleCommandOutput | ListApiDestinationsCommandOutput | ListArchivesCommandOutput | ListConnectionsCommandOutput | ListEventBusesCommandOutput | ListEventSourcesCommandOutput | ListPartnerEventSourceAccountsCommandOutput | ListPartnerEventSourcesCommandOutput | ListReplaysCommandOutput | ListRuleNamesByTargetCommandOutput | ListRulesCommandOutput | ListTagsForResourceCommandOutput | ListTargetsByRuleCommandOutput | PutEventsCommandOutput | PutPartnerEventsCommandOutput | PutPermissionCommandOutput | PutRuleCommandOutput | PutTargetsCommandOutput | RemovePermissionCommandOutput | RemoveTargetsCommandOutput | StartReplayCommandOutput | TagResourceCommandOutput | TestEventPatternCommandOutput | UntagResourceCommandOutput | UpdateApiDestinationCommandOutput | UpdateArchiveCommandOutput | UpdateConnectionCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -157,23 +166,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type CloudWatchEventsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of CloudWatchEventsClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of CloudWatchEventsClient class constructor that set the region, credentials and other options.
  */
 export interface CloudWatchEventsClientConfig extends CloudWatchEventsClientConfigType {
 }
+/**
+ * @public
+ */
 type CloudWatchEventsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of CloudWatchEventsClient class. This is resolved and normalized from the {@link CloudWatchEventsClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of CloudWatchEventsClient class. This is resolved and normalized from the {@link CloudWatchEventsClientConfig | constructor configuration interface}.
  */
 export interface CloudWatchEventsClientResolvedConfig extends CloudWatchEventsClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>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

package/dist-types/commands/ActivateEventSourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchEventsClient";
 import { ActivateEventSourceRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ActivateEventSourceCommand}.
  */
 export interface ActivateEventSourceCommandInput extends ActivateEventSourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ActivateEventSourceCommand}.
  */
 export interface ActivateEventSourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Activates a partner event source that has been deactivated. Once activated, your matching
  *       event bus will start receiving events from the event source.</p>
  * @example
@@ -26,6 +31,8 @@ export interface ActivateEventSourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param ActivateEventSourceCommandInput - {@link ActivateEventSourceCommandInput}
+ * @returns {@link ActivateEventSourceCommandOutput}
  * @see {@link ActivateEventSourceCommandInput} for command's `input` shape.
  * @see {@link ActivateEventSourceCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchEventsClientResolvedConfig | config} for CloudWatchEventsClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ActivateEventSourceCommandOutput extends __MetadataBearer {
 export declare class ActivateEventSourceCommand extends $Command<ActivateEventSourceCommandInput, ActivateEventSourceCommandOutput, CloudWatchEventsClientResolvedConfig> {
     readonly input: ActivateEventSourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ActivateEventSourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ActivateEventSourceCommandInput, ActivateEventSourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CancelReplayCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchEventsClient";
 import { CancelReplayRequest, CancelReplayResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CancelReplayCommand}.
  */
 export interface CancelReplayCommandInput extends CancelReplayRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CancelReplayCommand}.
  */
 export interface CancelReplayCommandOutput extends CancelReplayResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Cancels the specified replay.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CancelReplayCommandOutput extends CancelReplayResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param CancelReplayCommandInput - {@link CancelReplayCommandInput}
+ * @returns {@link CancelReplayCommandOutput}
  * @see {@link CancelReplayCommandInput} for command's `input` shape.
  * @see {@link CancelReplayCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchEventsClientResolvedConfig | config} for CloudWatchEventsClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CancelReplayCommandOutput extends CancelReplayResponse, __Metad
 export declare class CancelReplayCommand extends $Command<CancelReplayCommandInput, CancelReplayCommandOutput, CloudWatchEventsClientResolvedConfig> {
     readonly input: CancelReplayCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CancelReplayCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelReplayCommandInput, CancelReplayCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateApiDestinationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchEventsClient";
 import { CreateApiDestinationRequest, CreateApiDestinationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateApiDestinationCommand}.
  */
 export interface CreateApiDestinationCommandInput extends CreateApiDestinationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateApiDestinationCommand}.
  */
 export interface CreateApiDestinationCommandOutput extends CreateApiDestinationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates an API destination, which is an HTTP invocation endpoint configured as a target
  *       for events.</p>
  * @example
@@ -26,6 +31,8 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateApiDestinationCommandInput - {@link CreateApiDestinationCommandInput}
+ * @returns {@link CreateApiDestinationCommandOutput}
  * @see {@link CreateApiDestinationCommandInput} for command's `input` shape.
  * @see {@link CreateApiDestinationCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchEventsClientResolvedConfig | config} for CloudWatchEventsClient's `config` shape.
@@ -48,11 +55,20 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR
 export declare class CreateApiDestinationCommand extends $Command<CreateApiDestinationCommandInput, CreateApiDestinationCommandOutput, CloudWatchEventsClientResolvedConfig> {
     readonly input: CreateApiDestinationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateApiDestinationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateApiDestinationCommandInput, CreateApiDestinationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }