@aws-sdk/client-codestar-notifications 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CodestarNotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodestarNotificationsClient";
 import { ListTargetsRequest, ListTargetsResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTargetsCommand}.
  */
 export interface ListTargetsCommandInput extends ListTargetsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTargetsCommand}.
  */
 export interface ListTargetsCommandOutput extends ListTargetsResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of the notification rule targets for an Amazon Web Services account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTargetsCommandOutput extends ListTargetsResult, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTargetsCommandInput - {@link ListTargetsCommandInput}
+ * @returns {@link ListTargetsCommandOutput}
  * @see {@link ListTargetsCommandInput} for command's `input` shape.
  * @see {@link ListTargetsCommandOutput} for command's `response` shape.
  * @see {@link CodestarNotificationsClientResolvedConfig | config} for CodestarNotificationsClient's `config` shape.
@@ -40,11 +47,20 @@ export interface ListTargetsCommandOutput extends ListTargetsResult, __MetadataB
 export declare class ListTargetsCommand extends $Command<ListTargetsCommandInput, ListTargetsCommandOutput, CodestarNotificationsClientResolvedConfig> {
     readonly input: ListTargetsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTargetsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodestarNotificationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTargetsCommandInput, ListTargetsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CodestarNotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodestarNotificationsClient";
 import { SubscribeRequest, SubscribeResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SubscribeCommand}.
  */
 export interface SubscribeCommandInput extends SubscribeRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SubscribeCommand}.
  */
 export interface SubscribeCommandOutput extends SubscribeResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the
  *             associated target can receive notifications when the events described in the rule are
  *             triggered.</p>
@@ -27,6 +32,8 @@ export interface SubscribeCommandOutput extends SubscribeResult, __MetadataBeare
  * const response = await client.send(command);
  * ```
  *
+ * @param SubscribeCommandInput - {@link SubscribeCommandInput}
+ * @returns {@link SubscribeCommandOutput}
  * @see {@link SubscribeCommandInput} for command's `input` shape.
  * @see {@link SubscribeCommandOutput} for command's `response` shape.
  * @see {@link CodestarNotificationsClientResolvedConfig | config} for CodestarNotificationsClient's `config` shape.
@@ -45,11 +52,20 @@ export interface SubscribeCommandOutput extends SubscribeResult, __MetadataBeare
 export declare class SubscribeCommand extends $Command<SubscribeCommandInput, SubscribeCommandOutput, CodestarNotificationsClientResolvedConfig> {
     readonly input: SubscribeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SubscribeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodestarNotificationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SubscribeCommandInput, SubscribeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CodestarNotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodestarNotificationsClient";
 import { TagResourceRequest, TagResourceResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Associates a set of provided tags with a notification rule.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link CodestarNotificationsClientResolvedConfig | config} for CodestarNotificationsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, CodestarNotificationsClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodestarNotificationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CodestarNotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodestarNotificationsClient";
 import { UnsubscribeRequest, UnsubscribeResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UnsubscribeCommand}.
  */
 export interface UnsubscribeCommandInput extends UnsubscribeRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UnsubscribeCommand}.
  */
 export interface UnsubscribeCommandOutput extends UnsubscribeResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes an association between a notification rule and an Chatbot topic so that
  *             subscribers to that topic stop receiving notifications when the events described in the
  *             rule are triggered.</p>
@@ -27,6 +32,8 @@ export interface UnsubscribeCommandOutput extends UnsubscribeResult, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param UnsubscribeCommandInput - {@link UnsubscribeCommandInput}
+ * @returns {@link UnsubscribeCommandOutput}
  * @see {@link UnsubscribeCommandInput} for command's `input` shape.
  * @see {@link UnsubscribeCommandOutput} for command's `response` shape.
  * @see {@link CodestarNotificationsClientResolvedConfig | config} for CodestarNotificationsClient's `config` shape.
@@ -39,11 +46,20 @@ export interface UnsubscribeCommandOutput extends UnsubscribeResult, __MetadataB
 export declare class UnsubscribeCommand extends $Command<UnsubscribeCommandInput, UnsubscribeCommandOutput, CodestarNotificationsClientResolvedConfig> {
     readonly input: UnsubscribeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UnsubscribeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodestarNotificationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UnsubscribeCommandInput, UnsubscribeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CodestarNotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodestarNotificationsClient";
 import { UntagResourceRequest, UntagResourceResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes the association between one or more provided tags and a notification
  *             rule.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link CodestarNotificationsClientResolvedConfig | config} for CodestarNotificationsClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, CodestarNotificationsClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodestarNotificationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CodestarNotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CodestarNotificationsClient";
 import { UpdateNotificationRuleRequest, UpdateNotificationRuleResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateNotificationRuleCommand}.
  */
 export interface UpdateNotificationRuleCommandInput extends UpdateNotificationRuleRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateNotificationRuleCommand}.
  */
 export interface UpdateNotificationRuleCommandOutput extends UpdateNotificationRuleResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a notification rule for a resource. You can change the events that trigger the
  *             notification rule, the status of the rule, and the targets that receive the
  *             notifications.</p>
@@ -30,6 +35,8 @@ export interface UpdateNotificationRuleCommandOutput extends UpdateNotificationR
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateNotificationRuleCommandInput - {@link UpdateNotificationRuleCommandInput}
+ * @returns {@link UpdateNotificationRuleCommandOutput}
  * @see {@link UpdateNotificationRuleCommandInput} for command's `input` shape.
  * @see {@link UpdateNotificationRuleCommandOutput} for command's `response` shape.
  * @see {@link CodestarNotificationsClientResolvedConfig | config} for CodestarNotificationsClient's `config` shape.
@@ -48,11 +55,20 @@ export interface UpdateNotificationRuleCommandOutput extends UpdateNotificationR
 export declare class UpdateNotificationRuleCommand extends $Command<UpdateNotificationRuleCommandInput, UpdateNotificationRuleCommandOutput, CodestarNotificationsClientResolvedConfig> {
     readonly input: UpdateNotificationRuleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateNotificationRuleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CodestarNotificationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateNotificationRuleCommandInput, UpdateNotificationRuleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/CodestarNotificationsServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from CodestarNotifications service.
  */
 export declare class CodestarNotificationsServiceException extends __ServiceException {