@aws-sdk/client-ssm-incidents 3.296.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartIncidentInput, StartIncidentOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
 /**
+ * @public
+ *
  * The input for {@link StartIncidentCommand}.
  */
 export interface StartIncidentCommandInput extends StartIncidentInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StartIncidentCommand}.
  */
 export interface StartIncidentCommandOutput extends StartIncidentOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Used to start an incident from CloudWatch alarms, EventBridge events, or
  *             manually. </p>
  * @example
@@ -26,6 +31,8 @@ export interface StartIncidentCommandOutput extends StartIncidentOutput, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param StartIncidentCommandInput - {@link StartIncidentCommandInput}
+ * @returns {@link StartIncidentCommandOutput}
  * @see {@link StartIncidentCommandInput} for command's `input` shape.
  * @see {@link StartIncidentCommandOutput} for command's `response` shape.
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -55,11 +62,20 @@ export interface StartIncidentCommandOutput extends StartIncidentOutput, __Metad
 export declare class StartIncidentCommand extends $Command<StartIncidentCommandInput, StartIncidentCommandOutput, SSMIncidentsClientResolvedConfig> {
     readonly input: StartIncidentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartIncidentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartIncidentCommandInput, StartIncidentCommandOutput>;
+    /**
+     * @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 { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds a tag to a response plan.</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 TagResourceResponse, __Metadat
  * 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 SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SSMIncidentsClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @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 { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes a tag from a resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * 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 SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SSMIncidentsClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateDeletionProtectionInput, UpdateDeletionProtectionOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateDeletionProtectionCommand}.
  */
 export interface UpdateDeletionProtectionCommandInput extends UpdateDeletionProtectionInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDeletionProtectionCommand}.
  */
 export interface UpdateDeletionProtectionCommandOutput extends UpdateDeletionProtectionOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Update deletion protection to either allow or deny deletion of the final Region in a
  *             replication set.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateDeletionProtectionCommandOutput extends UpdateDeletionPro
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDeletionProtectionCommandInput - {@link UpdateDeletionProtectionCommandInput}
+ * @returns {@link UpdateDeletionProtectionCommandOutput}
  * @see {@link UpdateDeletionProtectionCommandInput} for command's `input` shape.
  * @see {@link UpdateDeletionProtectionCommandOutput} for command's `response` shape.
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateDeletionProtectionCommandOutput extends UpdateDeletionPro
 export declare class UpdateDeletionProtectionCommand extends $Command<UpdateDeletionProtectionCommandInput, UpdateDeletionProtectionCommandOutput, SSMIncidentsClientResolvedConfig> {
     readonly input: UpdateDeletionProtectionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDeletionProtectionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDeletionProtectionCommandInput, UpdateDeletionProtectionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateIncidentRecordInput, UpdateIncidentRecordOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateIncidentRecordCommand}.
  */
 export interface UpdateIncidentRecordCommandInput extends UpdateIncidentRecordInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateIncidentRecordCommand}.
  */
 export interface UpdateIncidentRecordCommandOutput extends UpdateIncidentRecordOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Update the details of an incident record. You can use this operation to update an
  *             incident record from the defined chat channel. For more information about using actions
  *             in chat channels, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact">Interacting through chat</a>.</p>
@@ -27,6 +32,8 @@ export interface UpdateIncidentRecordCommandOutput extends UpdateIncidentRecordO
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateIncidentRecordCommandInput - {@link UpdateIncidentRecordCommandInput}
+ * @returns {@link UpdateIncidentRecordCommandOutput}
  * @see {@link UpdateIncidentRecordCommandInput} for command's `input` shape.
  * @see {@link UpdateIncidentRecordCommandOutput} for command's `response` shape.
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -56,11 +63,20 @@ export interface UpdateIncidentRecordCommandOutput extends UpdateIncidentRecordO
 export declare class UpdateIncidentRecordCommand extends $Command<UpdateIncidentRecordCommandInput, UpdateIncidentRecordCommandOutput, SSMIncidentsClientResolvedConfig> {
     readonly input: UpdateIncidentRecordCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateIncidentRecordCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateIncidentRecordCommandInput, UpdateIncidentRecordCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateRelatedItemsInput, UpdateRelatedItemsOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateRelatedItemsCommand}.
  */
 export interface UpdateRelatedItemsCommandInput extends UpdateRelatedItemsInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRelatedItemsCommand}.
  */
 export interface UpdateRelatedItemsCommandOutput extends UpdateRelatedItemsOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Add or remove related items from the related items tab of an incident record.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateRelatedItemsCommandOutput extends UpdateRelatedItemsOutpu
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRelatedItemsCommandInput - {@link UpdateRelatedItemsCommandInput}
+ * @returns {@link UpdateRelatedItemsCommandOutput}
  * @see {@link UpdateRelatedItemsCommandInput} for command's `input` shape.
  * @see {@link UpdateRelatedItemsCommandOutput} for command's `response` shape.
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateRelatedItemsCommandOutput extends UpdateRelatedItemsOutpu
 export declare class UpdateRelatedItemsCommand extends $Command<UpdateRelatedItemsCommandInput, UpdateRelatedItemsCommandOutput, SSMIncidentsClientResolvedConfig> {
     readonly input: UpdateRelatedItemsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRelatedItemsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRelatedItemsCommandInput, UpdateRelatedItemsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateReplicationSetInput, UpdateReplicationSetOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateReplicationSetCommand}.
  */
 export interface UpdateReplicationSetCommandInput extends UpdateReplicationSetInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateReplicationSetCommand}.
  */
 export interface UpdateReplicationSetCommandOutput extends UpdateReplicationSetOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Add or delete Regions from your replication set.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateReplicationSetCommandOutput extends UpdateReplicationSetO
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateReplicationSetCommandInput - {@link UpdateReplicationSetCommandInput}
+ * @returns {@link UpdateReplicationSetCommandOutput}
  * @see {@link UpdateReplicationSetCommandInput} for command's `input` shape.
  * @see {@link UpdateReplicationSetCommandOutput} for command's `response` shape.
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateReplicationSetCommandOutput extends UpdateReplicationSetO
 export declare class UpdateReplicationSetCommand extends $Command<UpdateReplicationSetCommandInput, UpdateReplicationSetCommandOutput, SSMIncidentsClientResolvedConfig> {
     readonly input: UpdateReplicationSetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateReplicationSetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateReplicationSetCommandInput, UpdateReplicationSetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateTimelineEventInput, UpdateTimelineEventOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateTimelineEventCommand}.
  */
 export interface UpdateTimelineEventCommandInput extends UpdateTimelineEventInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateTimelineEventCommand}.
  */
 export interface UpdateTimelineEventCommandOutput extends UpdateTimelineEventOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a timeline event. You can update events of type <code>Custom
  *             Event</code>.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateTimelineEventCommandOutput extends UpdateTimelineEventOut
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateTimelineEventCommandInput - {@link UpdateTimelineEventCommandInput}
+ * @returns {@link UpdateTimelineEventCommandOutput}
  * @see {@link UpdateTimelineEventCommandInput} for command's `input` shape.
  * @see {@link UpdateTimelineEventCommandOutput} for command's `response` shape.
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -55,11 +62,20 @@ export interface UpdateTimelineEventCommandOutput extends UpdateTimelineEventOut
 export declare class UpdateTimelineEventCommand extends $Command<UpdateTimelineEventCommandInput, UpdateTimelineEventCommandOutput, SSMIncidentsClientResolvedConfig> {
     readonly input: UpdateTimelineEventCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateTimelineEventCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTimelineEventCommandInput, UpdateTimelineEventCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/SSMIncidentsServiceException.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 SSMIncidents service.
  */
 export declare class SSMIncidentsServiceException extends __ServiceException {