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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { SendActivationCodeRequest, SendActivationCodeResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @public
+ *
  * The input for {@link SendActivationCodeCommand}.
  */
 export interface SendActivationCodeCommandInput extends SendActivationCodeRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SendActivationCodeCommand}.
  */
 export interface SendActivationCodeCommandOutput extends SendActivationCodeResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Sends an activation code to a contact channel. The contact can use this code to activate
  *          the contact channel in the console or with the <code>ActivateChannel</code> operation.
  *          Incident Manager can't engage a contact channel until it has been activated.</p>
@@ -27,6 +32,8 @@ export interface SendActivationCodeCommandOutput extends SendActivationCodeResul
  * const response = await client.send(command);
  * ```
  *
+ * @param SendActivationCodeCommandInput - {@link SendActivationCodeCommandInput}
+ * @returns {@link SendActivationCodeCommandOutput}
  * @see {@link SendActivationCodeCommandInput} for command's `input` shape.
  * @see {@link SendActivationCodeCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -70,11 +77,20 @@ export interface SendActivationCodeCommandOutput extends SendActivationCodeResul
 export declare class SendActivationCodeCommand extends $Command<SendActivationCodeCommandInput, SendActivationCodeCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: SendActivationCodeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SendActivationCodeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendActivationCodeCommandInput, SendActivationCodeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartEngagementRequest, StartEngagementResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @public
+ *
  * The input for {@link StartEngagementCommand}.
  */
 export interface StartEngagementCommandInput extends StartEngagementRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartEngagementCommand}.
  */
 export interface StartEngagementCommandOutput extends StartEngagementResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts an engagement to a contact or escalation plan. The engagement engages each
  *          contact specified in the incident.</p>
  * @example
@@ -26,6 +31,8 @@ export interface StartEngagementCommandOutput extends StartEngagementResult, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param StartEngagementCommandInput - {@link StartEngagementCommandInput}
+ * @returns {@link StartEngagementCommandOutput}
  * @see {@link StartEngagementCommandInput} for command's `input` shape.
  * @see {@link StartEngagementCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -97,11 +104,20 @@ export interface StartEngagementCommandOutput extends StartEngagementResult, __M
 export declare class StartEngagementCommand extends $Command<StartEngagementCommandInput, StartEngagementCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: StartEngagementCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartEngagementCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartEngagementCommandInput, StartEngagementCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StopEngagementRequest, StopEngagementResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @public
+ *
  * The input for {@link StopEngagementCommand}.
  */
 export interface StopEngagementCommandInput extends StopEngagementRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopEngagementCommand}.
  */
 export interface StopEngagementCommandOutput extends StopEngagementResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops an engagement before it finishes the final stage of the escalation plan or
  *          engagement plan. Further contacts aren't engaged.</p>
  * @example
@@ -26,6 +31,8 @@ export interface StopEngagementCommandOutput extends StopEngagementResult, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param StopEngagementCommandInput - {@link StopEngagementCommandInput}
+ * @returns {@link StopEngagementCommandOutput}
  * @see {@link StopEngagementCommandInput} for command's `input` shape.
  * @see {@link StopEngagementCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -63,11 +70,20 @@ export interface StopEngagementCommandOutput extends StopEngagementResult, __Met
 export declare class StopEngagementCommand extends $Command<StopEngagementCommandInput, StopEngagementCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: StopEngagementCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopEngagementCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopEngagementCommandInput, StopEngagementCommandOutput>;
+    /**
+     * @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, TagResourceResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @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>Tags a contact or escalation plan. You can tag only contacts and escalation plans in the
  *          first region of your replication set. </p>
  * @example
@@ -26,6 +31,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 SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -72,11 +79,20 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, 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, UntagResourceResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @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 tags from the specified 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 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 SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -65,11 +72,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

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

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