@aws-sdk/client-eventbridge 3.296.0 → 3.298.0

package/dist-types/EventBridge.d.ts

@@ -57,6 +57,7 @@ import { UpdateConnectionCommandInput, UpdateConnectionCommandOutput } from "./c
 import { UpdateEndpointCommandInput, UpdateEndpointCommandOutput } from "./commands/UpdateEndpointCommand";
 import { EventBridgeClient } from "./EventBridgeClient";
 /**
+ * @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
@@ -81,6 +82,7 @@ import { EventBridgeClient } from "./EventBridgeClient";
  */
 export declare class EventBridge extends EventBridgeClient {
     /**
+     * @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>
      */
@@ -88,12 +90,14 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -101,6 +105,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -111,6 +116,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -118,6 +124,7 @@ export declare class EventBridge extends EventBridgeClient {
     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 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.</p>
@@ -126,6 +133,7 @@ export declare class EventBridge extends EventBridgeClient {
     createEndpoint(args: CreateEndpointCommandInput, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void;
     createEndpoint(args: CreateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointCommandOutput) => 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>
@@ -134,6 +142,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -163,6 +172,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -173,6 +183,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -180,30 +191,35 @@ export declare class EventBridge extends EventBridgeClient {
     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>Delete an existing global endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide.</p>
      */
     deleteEndpoint(args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEndpointCommandOutput>;
     deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
     deleteEndpoint(args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => 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>
      */
@@ -211,6 +227,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -221,6 +238,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      *          <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow
@@ -237,30 +255,35 @@ export declare class EventBridge extends EventBridgeClient {
     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>Get the information about an existing global endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
      */
     describeEndpoint(args: DescribeEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEndpointCommandOutput>;
     describeEndpoint(args: DescribeEndpointCommandInput, cb: (err: any, data?: DescribeEndpointCommandOutput) => void): void;
     describeEndpoint(args: DescribeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointCommandOutput) => 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,
@@ -273,6 +296,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -280,6 +304,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -289,6 +314,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -303,6 +329,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
@@ -311,6 +338,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      *          <p>When you disable a rule, incoming events might continue to match to the disabled rule.
@@ -320,6 +348,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
      *       enabled rule. Allow a short period of time for changes to take effect.</p>
@@ -328,12 +357,14 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -341,18 +372,21 @@ export declare class EventBridge extends EventBridgeClient {
     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>List the global endpoints associated with this account. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
      */
     listEndpoints(args: ListEndpointsCommandInput, options?: __HttpHandlerOptions): Promise<ListEndpointsCommandOutput>;
     listEndpoints(args: ListEndpointsCommandInput, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void;
     listEndpoints(args: ListEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsCommandOutput) => 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>
      */
@@ -360,6 +394,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -367,6 +402,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
@@ -375,6 +411,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -382,6 +419,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -389,6 +427,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -396,6 +435,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      *          <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
@@ -405,6 +445,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -412,12 +453,14 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      *          <note>
      *             <p>PutEvents will only process nested JSON up to 1100 levels deep.</p>
@@ -427,6 +470,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -434,6 +478,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -456,6 +501,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      *          <p>A single rule watches for events from a single event bus. Events generated by Amazon Web Services services
@@ -501,6 +547,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
@@ -684,6 +731,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>.
@@ -693,6 +741,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      *          <note>
@@ -708,6 +757,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -722,6 +772,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -738,6 +789,7 @@ export declare class EventBridge extends EventBridgeClient {
     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
@@ -748,6 +800,7 @@ export declare class EventBridge extends EventBridgeClient {
     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>
      */
@@ -755,24 +808,28 @@ export declare class EventBridge extends EventBridgeClient {
     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>;
     updateConnection(args: UpdateConnectionCommandInput, cb: (err: any, data?: UpdateConnectionCommandOutput) => void): void;
     updateConnection(args: UpdateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Update an existing endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
      */
     updateEndpoint(args: UpdateEndpointCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEndpointCommandOutput>;

package/dist-types/EventBridgeClient.d.ts

@@ -64,15 +64,24 @@ import { UpdateArchiveCommandInput, UpdateArchiveCommandOutput } from "./command
 import { UpdateConnectionCommandInput, UpdateConnectionCommandOutput } from "./commands/UpdateConnectionCommand";
 import { UpdateEndpointCommandInput, UpdateEndpointCommandOutput } from "./commands/UpdateEndpointCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = ActivateEventSourceCommandInput | CancelReplayCommandInput | CreateApiDestinationCommandInput | CreateArchiveCommandInput | CreateConnectionCommandInput | CreateEndpointCommandInput | CreateEventBusCommandInput | CreatePartnerEventSourceCommandInput | DeactivateEventSourceCommandInput | DeauthorizeConnectionCommandInput | DeleteApiDestinationCommandInput | DeleteArchiveCommandInput | DeleteConnectionCommandInput | DeleteEndpointCommandInput | DeleteEventBusCommandInput | DeletePartnerEventSourceCommandInput | DeleteRuleCommandInput | DescribeApiDestinationCommandInput | DescribeArchiveCommandInput | DescribeConnectionCommandInput | DescribeEndpointCommandInput | DescribeEventBusCommandInput | DescribeEventSourceCommandInput | DescribePartnerEventSourceCommandInput | DescribeReplayCommandInput | DescribeRuleCommandInput | DisableRuleCommandInput | EnableRuleCommandInput | ListApiDestinationsCommandInput | ListArchivesCommandInput | ListConnectionsCommandInput | ListEndpointsCommandInput | ListEventBusesCommandInput | ListEventSourcesCommandInput | ListPartnerEventSourceAccountsCommandInput | ListPartnerEventSourcesCommandInput | ListReplaysCommandInput | ListRuleNamesByTargetCommandInput | ListRulesCommandInput | ListTagsForResourceCommandInput | ListTargetsByRuleCommandInput | PutEventsCommandInput | PutPartnerEventsCommandInput | PutPermissionCommandInput | PutRuleCommandInput | PutTargetsCommandInput | RemovePermissionCommandInput | RemoveTargetsCommandInput | StartReplayCommandInput | TagResourceCommandInput | TestEventPatternCommandInput | UntagResourceCommandInput | UpdateApiDestinationCommandInput | UpdateArchiveCommandInput | UpdateConnectionCommandInput | UpdateEndpointCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = ActivateEventSourceCommandOutput | CancelReplayCommandOutput | CreateApiDestinationCommandOutput | CreateArchiveCommandOutput | CreateConnectionCommandOutput | CreateEndpointCommandOutput | CreateEventBusCommandOutput | CreatePartnerEventSourceCommandOutput | DeactivateEventSourceCommandOutput | DeauthorizeConnectionCommandOutput | DeleteApiDestinationCommandOutput | DeleteArchiveCommandOutput | DeleteConnectionCommandOutput | DeleteEndpointCommandOutput | DeleteEventBusCommandOutput | DeletePartnerEventSourceCommandOutput | DeleteRuleCommandOutput | DescribeApiDestinationCommandOutput | DescribeArchiveCommandOutput | DescribeConnectionCommandOutput | DescribeEndpointCommandOutput | DescribeEventBusCommandOutput | DescribeEventSourceCommandOutput | DescribePartnerEventSourceCommandOutput | DescribeReplayCommandOutput | DescribeRuleCommandOutput | DisableRuleCommandOutput | EnableRuleCommandOutput | ListApiDestinationsCommandOutput | ListArchivesCommandOutput | ListConnectionsCommandOutput | ListEndpointsCommandOutput | ListEventBusesCommandOutput | ListEventSourcesCommandOutput | ListPartnerEventSourceAccountsCommandOutput | ListPartnerEventSourcesCommandOutput | ListReplaysCommandOutput | ListRuleNamesByTargetCommandOutput | ListRulesCommandOutput | ListTagsForResourceCommandOutput | ListTargetsByRuleCommandOutput | PutEventsCommandOutput | PutPartnerEventsCommandOutput | PutPermissionCommandOutput | PutRuleCommandOutput | PutTargetsCommandOutput | RemovePermissionCommandOutput | RemoveTargetsCommandOutput | StartReplayCommandOutput | TagResourceCommandOutput | TestEventPatternCommandOutput | UntagResourceCommandOutput | UpdateApiDestinationCommandOutput | UpdateArchiveCommandOutput | UpdateConnectionCommandOutput | UpdateEndpointCommandOutput;
+/**
+ * @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
      */
@@ -162,23 +171,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 EventBridgeClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of EventBridgeClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of EventBridgeClient class constructor that set the region, credentials and other options.
  */
 export interface EventBridgeClientConfig extends EventBridgeClientConfigType {
 }
+/**
+ * @public
+ */
 type EventBridgeClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of EventBridgeClient class. This is resolved and normalized from the {@link EventBridgeClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of EventBridgeClient class. This is resolved and normalized from the {@link EventBridgeClientConfig | constructor configuration interface}.
  */
 export interface EventBridgeClientResolvedConfig extends EventBridgeClientResolvedConfigType {
 }
 /**
+ * @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 { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
 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 EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ActivateEventSourceCommandOutput extends __MetadataBearer {
 export declare class ActivateEventSourceCommand extends $Command<ActivateEventSourceCommandInput, ActivateEventSourceCommandOutput, EventBridgeClientResolvedConfig> {
     readonly input: ActivateEventSourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ActivateEventSourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, 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 { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
 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 EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CancelReplayCommandOutput extends CancelReplayResponse, __Metad
 export declare class CancelReplayCommand extends $Command<CancelReplayCommandInput, CancelReplayCommandOutput, EventBridgeClientResolvedConfig> {
     readonly input: CancelReplayCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CancelReplayCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelReplayCommandInput, CancelReplayCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }