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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetContactPolicyRequest, GetContactPolicyResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @public
+ *
  * The input for {@link GetContactPolicyCommand}.
  */
 export interface GetContactPolicyCommandInput extends GetContactPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetContactPolicyCommand}.
  */
 export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves the resource policies attached to the specified contact or escalation
  *          plan.</p>
  * @example
@@ -26,6 +31,8 @@ export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, _
  * const response = await client.send(command);
  * ```
  *
+ * @param GetContactPolicyCommandInput - {@link GetContactPolicyCommandInput}
+ * @returns {@link GetContactPolicyCommandOutput}
  * @see {@link GetContactPolicyCommandInput} for command's `input` shape.
  * @see {@link GetContactPolicyCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -69,11 +76,20 @@ export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, _
 export declare class GetContactPolicyCommand extends $Command<GetContactPolicyCommandInput, GetContactPolicyCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: GetContactPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetContactPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetContactPolicyCommandInput, GetContactPolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListContactsRequest, ListContactsResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @public
+ *
  * The input for {@link ListContactsCommand}.
  */
 export interface ListContactsCommandInput extends ListContactsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListContactsCommand}.
  */
 export interface ListContactsCommandOutput extends ListContactsResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists all contacts and escalation plans in Incident Manager.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListContactsCommandOutput extends ListContactsResult, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param ListContactsCommandInput - {@link ListContactsCommandInput}
+ * @returns {@link ListContactsCommandOutput}
  * @see {@link ListContactsCommandInput} for command's `input` shape.
  * @see {@link ListContactsCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -87,11 +94,20 @@ export interface ListContactsCommandOutput extends ListContactsResult, __Metadat
 export declare class ListContactsCommand extends $Command<ListContactsCommandInput, ListContactsCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: ListContactsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListContactsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListContactsCommandInput, ListContactsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListEngagementsRequest, ListEngagementsResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @public
+ *
  * The input for {@link ListEngagementsCommand}.
  */
 export interface ListEngagementsCommandInput extends ListEngagementsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListEngagementsCommand}.
  */
 export interface ListEngagementsCommandOutput extends ListEngagementsResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists all engagements that have happened in an incident.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListEngagementsCommandOutput extends ListEngagementsResult, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param ListEngagementsCommandInput - {@link ListEngagementsCommandInput}
+ * @returns {@link ListEngagementsCommandOutput}
  * @see {@link ListEngagementsCommandInput} for command's `input` shape.
  * @see {@link ListEngagementsCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -87,11 +94,20 @@ export interface ListEngagementsCommandOutput extends ListEngagementsResult, __M
 export declare class ListEngagementsCommand extends $Command<ListEngagementsCommandInput, ListEngagementsCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: ListEngagementsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListEngagementsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEngagementsCommandInput, ListEngagementsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListPageReceiptsRequest, ListPageReceiptsResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @public
+ *
  * The input for {@link ListPageReceiptsCommand}.
  */
 export interface ListPageReceiptsCommandInput extends ListPageReceiptsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListPageReceiptsCommand}.
  */
 export interface ListPageReceiptsCommandOutput extends ListPageReceiptsResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists all of the engagements to contact channels that have been acknowledged. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListPageReceiptsCommandOutput extends ListPageReceiptsResult, _
  * const response = await client.send(command);
  * ```
  *
+ * @param ListPageReceiptsCommandInput - {@link ListPageReceiptsCommandInput}
+ * @returns {@link ListPageReceiptsCommandOutput}
  * @see {@link ListPageReceiptsCommandInput} for command's `input` shape.
  * @see {@link ListPageReceiptsCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -86,11 +93,20 @@ export interface ListPageReceiptsCommandOutput extends ListPageReceiptsResult, _
 export declare class ListPageReceiptsCommand extends $Command<ListPageReceiptsCommandInput, ListPageReceiptsCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: ListPageReceiptsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListPageReceiptsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPageReceiptsCommandInput, ListPageReceiptsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

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

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutContactPolicyRequest, PutContactPolicyResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
 /**
+ * @public
+ *
  * The input for {@link PutContactPolicyCommand}.
  */
 export interface PutContactPolicyCommandInput extends PutContactPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutContactPolicyCommand}.
  */
 export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds a resource policy to the specified contact or escalation plan. The resource policy
  *          is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/xa.html">Setting up
  *             cross-account functionality</a>.</p>
@@ -27,6 +32,8 @@ export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, _
  * const response = await client.send(command);
  * ```
  *
+ * @param PutContactPolicyCommandInput - {@link PutContactPolicyCommandInput}
+ * @returns {@link PutContactPolicyCommandOutput}
  * @see {@link PutContactPolicyCommandInput} for command's `input` shape.
  * @see {@link PutContactPolicyCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -68,11 +75,20 @@ export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, _
 export declare class PutContactPolicyCommand extends $Command<PutContactPolicyCommandInput, PutContactPolicyCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: PutContactPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutContactPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutContactPolicyCommandInput, PutContactPolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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;
 }