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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/dist-types/SSMContacts.d.ts +28 -0
  2. package/dist-types/SSMContactsClient.d.ts +24 -4
  3. package/dist-types/commands/AcceptPageCommand.d.ts +16 -0
  4. package/dist-types/commands/ActivateContactChannelCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateContactChannelCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateContactCommand.d.ts +16 -0
  7. package/dist-types/commands/DeactivateContactChannelCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteContactChannelCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteContactCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeEngagementCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribePageCommand.d.ts +16 -0
  12. package/dist-types/commands/GetContactChannelCommand.d.ts +16 -0
  13. package/dist-types/commands/GetContactCommand.d.ts +16 -0
  14. package/dist-types/commands/GetContactPolicyCommand.d.ts +16 -0
  15. package/dist-types/commands/ListContactChannelsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListContactsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListEngagementsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListPageReceiptsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListPagesByContactCommand.d.ts +16 -0
  20. package/dist-types/commands/ListPagesByEngagementCommand.d.ts +16 -0
  21. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  22. package/dist-types/commands/PutContactPolicyCommand.d.ts +16 -0
  23. package/dist-types/commands/SendActivationCodeCommand.d.ts +16 -0
  24. package/dist-types/commands/StartEngagementCommand.d.ts +16 -0
  25. package/dist-types/commands/StopEngagementCommand.d.ts +16 -0
  26. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  27. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateContactChannelCommand.d.ts +16 -0
  29. package/dist-types/commands/UpdateContactCommand.d.ts +16 -0
  30. package/dist-types/models/SSMContactsServiceException.d.ts +2 -0
  31. package/dist-types/models/models_0.d.ts +205 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/dist-types/pagination/ListContactChannelsPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListContactsPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListEngagementsPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListPageReceiptsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListPagesByContactPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListPagesByEngagementPaginator.d.ts +3 -0
  39. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeEngagementRequest, DescribeEngagementResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEngagementCommand}.
8
10
  */
9
11
  export interface DescribeEngagementCommandInput extends DescribeEngagementRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEngagementCommand}.
13
17
  */
14
18
  export interface DescribeEngagementCommandOutput extends DescribeEngagementResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Incident Manager uses engagements to engage contacts and escalation plans during an incident.
18
23
  * Use this command to describe the engagement that occurred during an incident.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeEngagementCommandOutput extends DescribeEngagementResul
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeEngagementCommandInput - {@link DescribeEngagementCommandInput}
35
+ * @returns {@link DescribeEngagementCommandOutput}
29
36
  * @see {@link DescribeEngagementCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeEngagementCommandOutput} for command's `response` shape.
31
38
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -78,11 +85,20 @@ export interface DescribeEngagementCommandOutput extends DescribeEngagementResul
78
85
  export declare class DescribeEngagementCommand extends $Command<DescribeEngagementCommandInput, DescribeEngagementCommandOutput, SSMContactsClientResolvedConfig> {
79
86
  readonly input: DescribeEngagementCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: DescribeEngagementCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEngagementCommandInput, DescribeEngagementCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribePageRequest, DescribePageResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribePageCommand}.
8
10
  */
9
11
  export interface DescribePageCommandInput extends DescribePageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribePageCommand}.
13
17
  */
14
18
  export interface DescribePageCommandOutput extends DescribePageResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists details of the engagement to a contact channel.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribePageCommandOutput extends DescribePageResult, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribePageCommandInput - {@link DescribePageCommandInput}
34
+ * @returns {@link DescribePageCommandOutput}
28
35
  * @see {@link DescribePageCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribePageCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -80,11 +87,20 @@ export interface DescribePageCommandOutput extends DescribePageResult, __Metadat
80
87
  export declare class DescribePageCommand extends $Command<DescribePageCommandInput, DescribePageCommandOutput, SSMContactsClientResolvedConfig> {
81
88
  readonly input: DescribePageCommandInput;
82
89
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
83
93
  constructor(input: DescribePageCommandInput);
84
94
  /**
85
95
  * @internal
86
96
  */
87
97
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePageCommandInput, DescribePageCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
88
101
  private serialize;
102
+ /**
103
+ * @internal
104
+ */
89
105
  private deserialize;
90
106
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetContactChannelRequest, GetContactChannelResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetContactChannelCommand}.
8
10
  */
9
11
  export interface GetContactChannelCommandInput extends GetContactChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetContactChannelCommand}.
13
17
  */
14
18
  export interface GetContactChannelCommandOutput extends GetContactChannelResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List details about a specific contact channel.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetContactChannelCommandOutput extends GetContactChannelResult,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetContactChannelCommandInput - {@link GetContactChannelCommandInput}
34
+ * @returns {@link GetContactChannelCommandOutput}
28
35
  * @see {@link GetContactChannelCommandInput} for command's `input` shape.
29
36
  * @see {@link GetContactChannelCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -77,11 +84,20 @@ export interface GetContactChannelCommandOutput extends GetContactChannelResult,
77
84
  export declare class GetContactChannelCommand extends $Command<GetContactChannelCommandInput, GetContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
78
85
  readonly input: GetContactChannelCommandInput;
79
86
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
87
+ /**
88
+ * @public
89
+ */
80
90
  constructor(input: GetContactChannelCommandInput);
81
91
  /**
82
92
  * @internal
83
93
  */
84
94
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetContactChannelCommandInput, GetContactChannelCommandOutput>;
95
+ /**
96
+ * @internal
97
+ */
85
98
  private serialize;
99
+ /**
100
+ * @internal
101
+ */
86
102
  private deserialize;
87
103
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetContactRequest, GetContactResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetContactCommand}.
8
10
  */
9
11
  export interface GetContactCommandInput extends GetContactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetContactCommand}.
13
17
  */
14
18
  export interface GetContactCommandOutput extends GetContactResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the specified contact or escalation plan.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetContactCommandOutput extends GetContactResult, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetContactCommandInput - {@link GetContactCommandInput}
34
+ * @returns {@link GetContactCommandOutput}
28
35
  * @see {@link GetContactCommandInput} for command's `input` shape.
29
36
  * @see {@link GetContactCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -166,11 +173,20 @@ export interface GetContactCommandOutput extends GetContactResult, __MetadataBea
166
173
  export declare class GetContactCommand extends $Command<GetContactCommandInput, GetContactCommandOutput, SSMContactsClientResolvedConfig> {
167
174
  readonly input: GetContactCommandInput;
168
175
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
176
+ /**
177
+ * @public
178
+ */
169
179
  constructor(input: GetContactCommandInput);
170
180
  /**
171
181
  * @internal
172
182
  */
173
183
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetContactCommandInput, GetContactCommandOutput>;
184
+ /**
185
+ * @internal
186
+ */
174
187
  private serialize;
188
+ /**
189
+ * @internal
190
+ */
175
191
  private deserialize;
176
192
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetContactPolicyRequest, GetContactPolicyResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetContactPolicyCommand}.
8
10
  */
9
11
  export interface GetContactPolicyCommandInput extends GetContactPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetContactPolicyCommand}.
13
17
  */
14
18
  export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the resource policies attached to the specified contact or escalation
18
23
  * plan.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, _
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetContactPolicyCommandInput - {@link GetContactPolicyCommandInput}
35
+ * @returns {@link GetContactPolicyCommandOutput}
29
36
  * @see {@link GetContactPolicyCommandInput} for command's `input` shape.
30
37
  * @see {@link GetContactPolicyCommandOutput} for command's `response` shape.
31
38
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -69,11 +76,20 @@ export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, _
69
76
  export declare class GetContactPolicyCommand extends $Command<GetContactPolicyCommandInput, GetContactPolicyCommandOutput, SSMContactsClientResolvedConfig> {
70
77
  readonly input: GetContactPolicyCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: GetContactPolicyCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetContactPolicyCommandInput, GetContactPolicyCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListContactChannelsRequest, ListContactChannelsResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListContactChannelsCommand}.
8
10
  */
9
11
  export interface ListContactChannelsCommandInput extends ListContactChannelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListContactChannelsCommand}.
13
17
  */
14
18
  export interface ListContactChannelsCommandOutput extends ListContactChannelsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all contact channels for the specified contact.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListContactChannelsCommandOutput extends ListContactChannelsRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListContactChannelsCommandInput - {@link ListContactChannelsCommandInput}
34
+ * @returns {@link ListContactChannelsCommandOutput}
28
35
  * @see {@link ListContactChannelsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListContactChannelsCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -81,11 +88,20 @@ export interface ListContactChannelsCommandOutput extends ListContactChannelsRes
81
88
  export declare class ListContactChannelsCommand extends $Command<ListContactChannelsCommandInput, ListContactChannelsCommandOutput, SSMContactsClientResolvedConfig> {
82
89
  readonly input: ListContactChannelsCommandInput;
83
90
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
91
+ /**
92
+ * @public
93
+ */
84
94
  constructor(input: ListContactChannelsCommandInput);
85
95
  /**
86
96
  * @internal
87
97
  */
88
98
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListContactChannelsCommandInput, ListContactChannelsCommandOutput>;
99
+ /**
100
+ * @internal
101
+ */
89
102
  private serialize;
103
+ /**
104
+ * @internal
105
+ */
90
106
  private deserialize;
91
107
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListContactsRequest, ListContactsResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListContactsCommand}.
8
10
  */
9
11
  export interface ListContactsCommandInput extends ListContactsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListContactsCommand}.
13
17
  */
14
18
  export interface ListContactsCommandOutput extends ListContactsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all contacts and escalation plans in Incident Manager.</p>
18
23
  * @example
19
24
  * 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
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListContactsCommandInput - {@link ListContactsCommandInput}
34
+ * @returns {@link ListContactsCommandOutput}
28
35
  * @see {@link ListContactsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListContactsCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -87,11 +94,20 @@ export interface ListContactsCommandOutput extends ListContactsResult, __Metadat
87
94
  export declare class ListContactsCommand extends $Command<ListContactsCommandInput, ListContactsCommandOutput, SSMContactsClientResolvedConfig> {
88
95
  readonly input: ListContactsCommandInput;
89
96
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
97
+ /**
98
+ * @public
99
+ */
90
100
  constructor(input: ListContactsCommandInput);
91
101
  /**
92
102
  * @internal
93
103
  */
94
104
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListContactsCommandInput, ListContactsCommandOutput>;
105
+ /**
106
+ * @internal
107
+ */
95
108
  private serialize;
109
+ /**
110
+ * @internal
111
+ */
96
112
  private deserialize;
97
113
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListEngagementsRequest, ListEngagementsResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListEngagementsCommand}.
8
10
  */
9
11
  export interface ListEngagementsCommandInput extends ListEngagementsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListEngagementsCommand}.
13
17
  */
14
18
  export interface ListEngagementsCommandOutput extends ListEngagementsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all engagements that have happened in an incident.</p>
18
23
  * @example
19
24
  * 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
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListEngagementsCommandInput - {@link ListEngagementsCommandInput}
34
+ * @returns {@link ListEngagementsCommandOutput}
28
35
  * @see {@link ListEngagementsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListEngagementsCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -87,11 +94,20 @@ export interface ListEngagementsCommandOutput extends ListEngagementsResult, __M
87
94
  export declare class ListEngagementsCommand extends $Command<ListEngagementsCommandInput, ListEngagementsCommandOutput, SSMContactsClientResolvedConfig> {
88
95
  readonly input: ListEngagementsCommandInput;
89
96
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
97
+ /**
98
+ * @public
99
+ */
90
100
  constructor(input: ListEngagementsCommandInput);
91
101
  /**
92
102
  * @internal
93
103
  */
94
104
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEngagementsCommandInput, ListEngagementsCommandOutput>;
105
+ /**
106
+ * @internal
107
+ */
95
108
  private serialize;
109
+ /**
110
+ * @internal
111
+ */
96
112
  private deserialize;
97
113
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListPageReceiptsRequest, ListPageReceiptsResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPageReceiptsCommand}.
8
10
  */
9
11
  export interface ListPageReceiptsCommandInput extends ListPageReceiptsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPageReceiptsCommand}.
13
17
  */
14
18
  export interface ListPageReceiptsCommandOutput extends ListPageReceiptsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all of the engagements to contact channels that have been acknowledged. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListPageReceiptsCommandOutput extends ListPageReceiptsResult, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListPageReceiptsCommandInput - {@link ListPageReceiptsCommandInput}
34
+ * @returns {@link ListPageReceiptsCommandOutput}
28
35
  * @see {@link ListPageReceiptsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListPageReceiptsCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -86,11 +93,20 @@ export interface ListPageReceiptsCommandOutput extends ListPageReceiptsResult, _
86
93
  export declare class ListPageReceiptsCommand extends $Command<ListPageReceiptsCommandInput, ListPageReceiptsCommandOutput, SSMContactsClientResolvedConfig> {
87
94
  readonly input: ListPageReceiptsCommandInput;
88
95
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
96
+ /**
97
+ * @public
98
+ */
89
99
  constructor(input: ListPageReceiptsCommandInput);
90
100
  /**
91
101
  * @internal
92
102
  */
93
103
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPageReceiptsCommandInput, ListPageReceiptsCommandOutput>;
104
+ /**
105
+ * @internal
106
+ */
94
107
  private serialize;
108
+ /**
109
+ * @internal
110
+ */
95
111
  private deserialize;
96
112
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListPagesByContactRequest, ListPagesByContactResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPagesByContactCommand}.
8
10
  */
9
11
  export interface ListPagesByContactCommandInput extends ListPagesByContactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPagesByContactCommand}.
13
17
  */
14
18
  export interface ListPagesByContactCommandOutput extends ListPagesByContactResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the engagements to a contact's contact channels.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListPagesByContactCommandOutput extends ListPagesByContactResul
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListPagesByContactCommandInput - {@link ListPagesByContactCommandInput}
34
+ * @returns {@link ListPagesByContactCommandOutput}
28
35
  * @see {@link ListPagesByContactCommandInput} for command's `input` shape.
29
36
  * @see {@link ListPagesByContactCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -77,11 +84,20 @@ export interface ListPagesByContactCommandOutput extends ListPagesByContactResul
77
84
  export declare class ListPagesByContactCommand extends $Command<ListPagesByContactCommandInput, ListPagesByContactCommandOutput, SSMContactsClientResolvedConfig> {
78
85
  readonly input: ListPagesByContactCommandInput;
79
86
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
87
+ /**
88
+ * @public
89
+ */
80
90
  constructor(input: ListPagesByContactCommandInput);
81
91
  /**
82
92
  * @internal
83
93
  */
84
94
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPagesByContactCommandInput, ListPagesByContactCommandOutput>;
95
+ /**
96
+ * @internal
97
+ */
85
98
  private serialize;
99
+ /**
100
+ * @internal
101
+ */
86
102
  private deserialize;
87
103
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListPagesByEngagementRequest, ListPagesByEngagementResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPagesByEngagementCommand}.
8
10
  */
9
11
  export interface ListPagesByEngagementCommandInput extends ListPagesByEngagementRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPagesByEngagementCommand}.
13
17
  */
14
18
  export interface ListPagesByEngagementCommandOutput extends ListPagesByEngagementResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the engagements to contact channels that occurred by engaging a contact.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListPagesByEngagementCommandOutput extends ListPagesByEngagemen
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListPagesByEngagementCommandInput - {@link ListPagesByEngagementCommandInput}
34
+ * @returns {@link ListPagesByEngagementCommandOutput}
28
35
  * @see {@link ListPagesByEngagementCommandInput} for command's `input` shape.
29
36
  * @see {@link ListPagesByEngagementCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -75,11 +82,20 @@ export interface ListPagesByEngagementCommandOutput extends ListPagesByEngagemen
75
82
  export declare class ListPagesByEngagementCommand extends $Command<ListPagesByEngagementCommandInput, ListPagesByEngagementCommandOutput, SSMContactsClientResolvedConfig> {
76
83
  readonly input: ListPagesByEngagementCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: ListPagesByEngagementCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPagesByEngagementCommandInput, ListPagesByEngagementCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceRequest, ListTagsForResourceResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags of an escalation plan or contact.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -72,11 +79,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
72
79
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SSMContactsClientResolvedConfig> {
73
80
  readonly input: ListTagsForResourceCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: ListTagsForResourceCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutContactPolicyRequest, PutContactPolicyResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutContactPolicyCommand}.
8
10
  */
9
11
  export interface PutContactPolicyCommandInput extends PutContactPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutContactPolicyCommand}.
13
17
  */
14
18
  export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds a resource policy to the specified contact or escalation plan. The resource policy
18
23
  * 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
19
24
  * cross-account functionality</a>.</p>
@@ -27,6 +32,8 @@ export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, _
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param PutContactPolicyCommandInput - {@link PutContactPolicyCommandInput}
36
+ * @returns {@link PutContactPolicyCommandOutput}
30
37
  * @see {@link PutContactPolicyCommandInput} for command's `input` shape.
31
38
  * @see {@link PutContactPolicyCommandOutput} for command's `response` shape.
32
39
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -68,11 +75,20 @@ export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, _
68
75
  export declare class PutContactPolicyCommand extends $Command<PutContactPolicyCommandInput, PutContactPolicyCommandOutput, SSMContactsClientResolvedConfig> {
69
76
  readonly input: PutContactPolicyCommandInput;
70
77
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
78
+ /**
79
+ * @public
80
+ */
71
81
  constructor(input: PutContactPolicyCommandInput);
72
82
  /**
73
83
  * @internal
74
84
  */
75
85
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutContactPolicyCommandInput, PutContactPolicyCommandOutput>;
86
+ /**
87
+ * @internal
88
+ */
76
89
  private serialize;
90
+ /**
91
+ * @internal
92
+ */
77
93
  private deserialize;
78
94
  }