@aws-sdk/client-ssm-contacts 3.296.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.
- package/dist-types/SSMContacts.d.ts +28 -0
- package/dist-types/SSMContactsClient.d.ts +24 -4
- package/dist-types/commands/AcceptPageCommand.d.ts +16 -0
- package/dist-types/commands/ActivateContactChannelCommand.d.ts +16 -0
- package/dist-types/commands/CreateContactChannelCommand.d.ts +16 -0
- package/dist-types/commands/CreateContactCommand.d.ts +16 -0
- package/dist-types/commands/DeactivateContactChannelCommand.d.ts +16 -0
- package/dist-types/commands/DeleteContactChannelCommand.d.ts +16 -0
- package/dist-types/commands/DeleteContactCommand.d.ts +16 -0
- package/dist-types/commands/DescribeEngagementCommand.d.ts +16 -0
- package/dist-types/commands/DescribePageCommand.d.ts +16 -0
- package/dist-types/commands/GetContactChannelCommand.d.ts +16 -0
- package/dist-types/commands/GetContactCommand.d.ts +16 -0
- package/dist-types/commands/GetContactPolicyCommand.d.ts +16 -0
- package/dist-types/commands/ListContactChannelsCommand.d.ts +16 -0
- package/dist-types/commands/ListContactsCommand.d.ts +16 -0
- package/dist-types/commands/ListEngagementsCommand.d.ts +16 -0
- package/dist-types/commands/ListPageReceiptsCommand.d.ts +16 -0
- package/dist-types/commands/ListPagesByContactCommand.d.ts +16 -0
- package/dist-types/commands/ListPagesByEngagementCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/PutContactPolicyCommand.d.ts +16 -0
- package/dist-types/commands/SendActivationCodeCommand.d.ts +16 -0
- package/dist-types/commands/StartEngagementCommand.d.ts +16 -0
- package/dist-types/commands/StopEngagementCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateContactChannelCommand.d.ts +16 -0
- package/dist-types/commands/UpdateContactCommand.d.ts +16 -0
- package/dist-types/models/SSMContactsServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +205 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListContactChannelsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListContactsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListEngagementsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListPageReceiptsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListPagesByContactPaginator.d.ts +3 -0
- package/dist-types/pagination/ListPagesByEngagementPaginator.d.ts +3 -0
- package/package.json +3 -3
|
@@ -28,6 +28,7 @@ import { UpdateContactChannelCommandInput, UpdateContactChannelCommandOutput } f
|
|
|
28
28
|
import { UpdateContactCommandInput, UpdateContactCommandOutput } from "./commands/UpdateContactCommand";
|
|
29
29
|
import { SSMContactsClient } from "./SSMContactsClient";
|
|
30
30
|
/**
|
|
31
|
+
* @public
|
|
31
32
|
* <p>Systems Manager Incident Manager is an incident management console designed to help users
|
|
32
33
|
* mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.
|
|
33
34
|
* An incident is any unplanned interruption or reduction in quality of services. </p>
|
|
@@ -39,12 +40,14 @@ import { SSMContactsClient } from "./SSMContactsClient";
|
|
|
39
40
|
*/
|
|
40
41
|
export declare class SSMContacts extends SSMContactsClient {
|
|
41
42
|
/**
|
|
43
|
+
* @public
|
|
42
44
|
* <p>Used to acknowledge an engagement to a contact channel during an incident.</p>
|
|
43
45
|
*/
|
|
44
46
|
acceptPage(args: AcceptPageCommandInput, options?: __HttpHandlerOptions): Promise<AcceptPageCommandOutput>;
|
|
45
47
|
acceptPage(args: AcceptPageCommandInput, cb: (err: any, data?: AcceptPageCommandOutput) => void): void;
|
|
46
48
|
acceptPage(args: AcceptPageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptPageCommandOutput) => void): void;
|
|
47
49
|
/**
|
|
50
|
+
* @public
|
|
48
51
|
* <p>Activates a contact's contact channel. Incident Manager can't engage a contact until the
|
|
49
52
|
* contact channel has been activated.</p>
|
|
50
53
|
*/
|
|
@@ -52,6 +55,7 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
52
55
|
activateContactChannel(args: ActivateContactChannelCommandInput, cb: (err: any, data?: ActivateContactChannelCommandOutput) => void): void;
|
|
53
56
|
activateContactChannel(args: ActivateContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateContactChannelCommandOutput) => void): void;
|
|
54
57
|
/**
|
|
58
|
+
* @public
|
|
55
59
|
* <p>Contacts are either the contacts that Incident Manager engages during an incident or the
|
|
56
60
|
* escalation plans that Incident Manager uses to engage contacts in phases during an
|
|
57
61
|
* incident. </p>
|
|
@@ -60,12 +64,14 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
60
64
|
createContact(args: CreateContactCommandInput, cb: (err: any, data?: CreateContactCommandOutput) => void): void;
|
|
61
65
|
createContact(args: CreateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactCommandOutput) => void): void;
|
|
62
66
|
/**
|
|
67
|
+
* @public
|
|
63
68
|
* <p>A contact channel is the method that Incident Manager uses to engage your contact.</p>
|
|
64
69
|
*/
|
|
65
70
|
createContactChannel(args: CreateContactChannelCommandInput, options?: __HttpHandlerOptions): Promise<CreateContactChannelCommandOutput>;
|
|
66
71
|
createContactChannel(args: CreateContactChannelCommandInput, cb: (err: any, data?: CreateContactChannelCommandOutput) => void): void;
|
|
67
72
|
createContactChannel(args: CreateContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactChannelCommandOutput) => void): void;
|
|
68
73
|
/**
|
|
74
|
+
* @public
|
|
69
75
|
* <p>To no longer receive Incident Manager engagements to a contact channel, you can deactivate
|
|
70
76
|
* the channel.</p>
|
|
71
77
|
*/
|
|
@@ -73,6 +79,7 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
73
79
|
deactivateContactChannel(args: DeactivateContactChannelCommandInput, cb: (err: any, data?: DeactivateContactChannelCommandOutput) => void): void;
|
|
74
80
|
deactivateContactChannel(args: DeactivateContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateContactChannelCommandOutput) => void): void;
|
|
75
81
|
/**
|
|
82
|
+
* @public
|
|
76
83
|
* <p>To remove a contact from Incident Manager, you can delete the contact. Deleting a contact
|
|
77
84
|
* removes them from all escalation plans and related response plans. Deleting an escalation
|
|
78
85
|
* plan removes it from all related response plans. You will have to recreate the contact and
|
|
@@ -82,6 +89,7 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
82
89
|
deleteContact(args: DeleteContactCommandInput, cb: (err: any, data?: DeleteContactCommandOutput) => void): void;
|
|
83
90
|
deleteContact(args: DeleteContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactCommandOutput) => void): void;
|
|
84
91
|
/**
|
|
92
|
+
* @public
|
|
85
93
|
* <p>To no longer receive engagements on a contact channel, you can delete the channel from a
|
|
86
94
|
* contact. Deleting the contact channel removes it from the contact's engagement plan. If you
|
|
87
95
|
* delete the only contact channel for a contact, you won't be able to engage that contact
|
|
@@ -91,6 +99,7 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
91
99
|
deleteContactChannel(args: DeleteContactChannelCommandInput, cb: (err: any, data?: DeleteContactChannelCommandOutput) => void): void;
|
|
92
100
|
deleteContactChannel(args: DeleteContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactChannelCommandOutput) => void): void;
|
|
93
101
|
/**
|
|
102
|
+
* @public
|
|
94
103
|
* <p>Incident Manager uses engagements to engage contacts and escalation plans during an incident.
|
|
95
104
|
* Use this command to describe the engagement that occurred during an incident.</p>
|
|
96
105
|
*/
|
|
@@ -98,24 +107,28 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
98
107
|
describeEngagement(args: DescribeEngagementCommandInput, cb: (err: any, data?: DescribeEngagementCommandOutput) => void): void;
|
|
99
108
|
describeEngagement(args: DescribeEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngagementCommandOutput) => void): void;
|
|
100
109
|
/**
|
|
110
|
+
* @public
|
|
101
111
|
* <p>Lists details of the engagement to a contact channel.</p>
|
|
102
112
|
*/
|
|
103
113
|
describePage(args: DescribePageCommandInput, options?: __HttpHandlerOptions): Promise<DescribePageCommandOutput>;
|
|
104
114
|
describePage(args: DescribePageCommandInput, cb: (err: any, data?: DescribePageCommandOutput) => void): void;
|
|
105
115
|
describePage(args: DescribePageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePageCommandOutput) => void): void;
|
|
106
116
|
/**
|
|
117
|
+
* @public
|
|
107
118
|
* <p>Retrieves information about the specified contact or escalation plan.</p>
|
|
108
119
|
*/
|
|
109
120
|
getContact(args: GetContactCommandInput, options?: __HttpHandlerOptions): Promise<GetContactCommandOutput>;
|
|
110
121
|
getContact(args: GetContactCommandInput, cb: (err: any, data?: GetContactCommandOutput) => void): void;
|
|
111
122
|
getContact(args: GetContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactCommandOutput) => void): void;
|
|
112
123
|
/**
|
|
124
|
+
* @public
|
|
113
125
|
* <p>List details about a specific contact channel.</p>
|
|
114
126
|
*/
|
|
115
127
|
getContactChannel(args: GetContactChannelCommandInput, options?: __HttpHandlerOptions): Promise<GetContactChannelCommandOutput>;
|
|
116
128
|
getContactChannel(args: GetContactChannelCommandInput, cb: (err: any, data?: GetContactChannelCommandOutput) => void): void;
|
|
117
129
|
getContactChannel(args: GetContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactChannelCommandOutput) => void): void;
|
|
118
130
|
/**
|
|
131
|
+
* @public
|
|
119
132
|
* <p>Retrieves the resource policies attached to the specified contact or escalation
|
|
120
133
|
* plan.</p>
|
|
121
134
|
*/
|
|
@@ -123,48 +136,56 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
123
136
|
getContactPolicy(args: GetContactPolicyCommandInput, cb: (err: any, data?: GetContactPolicyCommandOutput) => void): void;
|
|
124
137
|
getContactPolicy(args: GetContactPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactPolicyCommandOutput) => void): void;
|
|
125
138
|
/**
|
|
139
|
+
* @public
|
|
126
140
|
* <p>Lists all contact channels for the specified contact.</p>
|
|
127
141
|
*/
|
|
128
142
|
listContactChannels(args: ListContactChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListContactChannelsCommandOutput>;
|
|
129
143
|
listContactChannels(args: ListContactChannelsCommandInput, cb: (err: any, data?: ListContactChannelsCommandOutput) => void): void;
|
|
130
144
|
listContactChannels(args: ListContactChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactChannelsCommandOutput) => void): void;
|
|
131
145
|
/**
|
|
146
|
+
* @public
|
|
132
147
|
* <p>Lists all contacts and escalation plans in Incident Manager.</p>
|
|
133
148
|
*/
|
|
134
149
|
listContacts(args: ListContactsCommandInput, options?: __HttpHandlerOptions): Promise<ListContactsCommandOutput>;
|
|
135
150
|
listContacts(args: ListContactsCommandInput, cb: (err: any, data?: ListContactsCommandOutput) => void): void;
|
|
136
151
|
listContacts(args: ListContactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactsCommandOutput) => void): void;
|
|
137
152
|
/**
|
|
153
|
+
* @public
|
|
138
154
|
* <p>Lists all engagements that have happened in an incident.</p>
|
|
139
155
|
*/
|
|
140
156
|
listEngagements(args: ListEngagementsCommandInput, options?: __HttpHandlerOptions): Promise<ListEngagementsCommandOutput>;
|
|
141
157
|
listEngagements(args: ListEngagementsCommandInput, cb: (err: any, data?: ListEngagementsCommandOutput) => void): void;
|
|
142
158
|
listEngagements(args: ListEngagementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEngagementsCommandOutput) => void): void;
|
|
143
159
|
/**
|
|
160
|
+
* @public
|
|
144
161
|
* <p>Lists all of the engagements to contact channels that have been acknowledged. </p>
|
|
145
162
|
*/
|
|
146
163
|
listPageReceipts(args: ListPageReceiptsCommandInput, options?: __HttpHandlerOptions): Promise<ListPageReceiptsCommandOutput>;
|
|
147
164
|
listPageReceipts(args: ListPageReceiptsCommandInput, cb: (err: any, data?: ListPageReceiptsCommandOutput) => void): void;
|
|
148
165
|
listPageReceipts(args: ListPageReceiptsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPageReceiptsCommandOutput) => void): void;
|
|
149
166
|
/**
|
|
167
|
+
* @public
|
|
150
168
|
* <p>Lists the engagements to a contact's contact channels.</p>
|
|
151
169
|
*/
|
|
152
170
|
listPagesByContact(args: ListPagesByContactCommandInput, options?: __HttpHandlerOptions): Promise<ListPagesByContactCommandOutput>;
|
|
153
171
|
listPagesByContact(args: ListPagesByContactCommandInput, cb: (err: any, data?: ListPagesByContactCommandOutput) => void): void;
|
|
154
172
|
listPagesByContact(args: ListPagesByContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPagesByContactCommandOutput) => void): void;
|
|
155
173
|
/**
|
|
174
|
+
* @public
|
|
156
175
|
* <p>Lists the engagements to contact channels that occurred by engaging a contact.</p>
|
|
157
176
|
*/
|
|
158
177
|
listPagesByEngagement(args: ListPagesByEngagementCommandInput, options?: __HttpHandlerOptions): Promise<ListPagesByEngagementCommandOutput>;
|
|
159
178
|
listPagesByEngagement(args: ListPagesByEngagementCommandInput, cb: (err: any, data?: ListPagesByEngagementCommandOutput) => void): void;
|
|
160
179
|
listPagesByEngagement(args: ListPagesByEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPagesByEngagementCommandOutput) => void): void;
|
|
161
180
|
/**
|
|
181
|
+
* @public
|
|
162
182
|
* <p>Lists the tags of an escalation plan or contact.</p>
|
|
163
183
|
*/
|
|
164
184
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
165
185
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
166
186
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
167
187
|
/**
|
|
188
|
+
* @public
|
|
168
189
|
* <p>Adds a resource policy to the specified contact or escalation plan. The resource policy
|
|
169
190
|
* 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
|
|
170
191
|
* cross-account functionality</a>.</p>
|
|
@@ -173,6 +194,7 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
173
194
|
putContactPolicy(args: PutContactPolicyCommandInput, cb: (err: any, data?: PutContactPolicyCommandOutput) => void): void;
|
|
174
195
|
putContactPolicy(args: PutContactPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutContactPolicyCommandOutput) => void): void;
|
|
175
196
|
/**
|
|
197
|
+
* @public
|
|
176
198
|
* <p>Sends an activation code to a contact channel. The contact can use this code to activate
|
|
177
199
|
* the contact channel in the console or with the <code>ActivateChannel</code> operation.
|
|
178
200
|
* Incident Manager can't engage a contact channel until it has been activated.</p>
|
|
@@ -181,6 +203,7 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
181
203
|
sendActivationCode(args: SendActivationCodeCommandInput, cb: (err: any, data?: SendActivationCodeCommandOutput) => void): void;
|
|
182
204
|
sendActivationCode(args: SendActivationCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendActivationCodeCommandOutput) => void): void;
|
|
183
205
|
/**
|
|
206
|
+
* @public
|
|
184
207
|
* <p>Starts an engagement to a contact or escalation plan. The engagement engages each
|
|
185
208
|
* contact specified in the incident.</p>
|
|
186
209
|
*/
|
|
@@ -188,6 +211,7 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
188
211
|
startEngagement(args: StartEngagementCommandInput, cb: (err: any, data?: StartEngagementCommandOutput) => void): void;
|
|
189
212
|
startEngagement(args: StartEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEngagementCommandOutput) => void): void;
|
|
190
213
|
/**
|
|
214
|
+
* @public
|
|
191
215
|
* <p>Stops an engagement before it finishes the final stage of the escalation plan or
|
|
192
216
|
* engagement plan. Further contacts aren't engaged.</p>
|
|
193
217
|
*/
|
|
@@ -195,6 +219,7 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
195
219
|
stopEngagement(args: StopEngagementCommandInput, cb: (err: any, data?: StopEngagementCommandOutput) => void): void;
|
|
196
220
|
stopEngagement(args: StopEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEngagementCommandOutput) => void): void;
|
|
197
221
|
/**
|
|
222
|
+
* @public
|
|
198
223
|
* <p>Tags a contact or escalation plan. You can tag only contacts and escalation plans in the
|
|
199
224
|
* first region of your replication set. </p>
|
|
200
225
|
*/
|
|
@@ -202,18 +227,21 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
202
227
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
203
228
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
204
229
|
/**
|
|
230
|
+
* @public
|
|
205
231
|
* <p>Removes tags from the specified resource. </p>
|
|
206
232
|
*/
|
|
207
233
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
208
234
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
209
235
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
210
236
|
/**
|
|
237
|
+
* @public
|
|
211
238
|
* <p>Updates the contact or escalation plan specified. </p>
|
|
212
239
|
*/
|
|
213
240
|
updateContact(args: UpdateContactCommandInput, options?: __HttpHandlerOptions): Promise<UpdateContactCommandOutput>;
|
|
214
241
|
updateContact(args: UpdateContactCommandInput, cb: (err: any, data?: UpdateContactCommandOutput) => void): void;
|
|
215
242
|
updateContact(args: UpdateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactCommandOutput) => void): void;
|
|
216
243
|
/**
|
|
244
|
+
* @public
|
|
217
245
|
* <p>Updates a contact's contact channel.</p>
|
|
218
246
|
*/
|
|
219
247
|
updateContactChannel(args: UpdateContactChannelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateContactChannelCommandOutput>;
|
|
@@ -35,15 +35,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
35
35
|
import { UpdateContactChannelCommandInput, UpdateContactChannelCommandOutput } from "./commands/UpdateContactChannelCommand";
|
|
36
36
|
import { UpdateContactCommandInput, UpdateContactCommandOutput } from "./commands/UpdateContactCommand";
|
|
37
37
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
38
|
+
/**
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
38
41
|
export type ServiceInputTypes = AcceptPageCommandInput | ActivateContactChannelCommandInput | CreateContactChannelCommandInput | CreateContactCommandInput | DeactivateContactChannelCommandInput | DeleteContactChannelCommandInput | DeleteContactCommandInput | DescribeEngagementCommandInput | DescribePageCommandInput | GetContactChannelCommandInput | GetContactCommandInput | GetContactPolicyCommandInput | ListContactChannelsCommandInput | ListContactsCommandInput | ListEngagementsCommandInput | ListPageReceiptsCommandInput | ListPagesByContactCommandInput | ListPagesByEngagementCommandInput | ListTagsForResourceCommandInput | PutContactPolicyCommandInput | SendActivationCodeCommandInput | StartEngagementCommandInput | StopEngagementCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateContactChannelCommandInput | UpdateContactCommandInput;
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
39
45
|
export type ServiceOutputTypes = AcceptPageCommandOutput | ActivateContactChannelCommandOutput | CreateContactChannelCommandOutput | CreateContactCommandOutput | DeactivateContactChannelCommandOutput | DeleteContactChannelCommandOutput | DeleteContactCommandOutput | DescribeEngagementCommandOutput | DescribePageCommandOutput | GetContactChannelCommandOutput | GetContactCommandOutput | GetContactPolicyCommandOutput | ListContactChannelsCommandOutput | ListContactsCommandOutput | ListEngagementsCommandOutput | ListPageReceiptsCommandOutput | ListPagesByContactCommandOutput | ListPagesByEngagementCommandOutput | ListTagsForResourceCommandOutput | PutContactPolicyCommandOutput | SendActivationCodeCommandOutput | StartEngagementCommandOutput | StopEngagementCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateContactChannelCommandOutput | UpdateContactCommandOutput;
|
|
46
|
+
/**
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
40
49
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
41
50
|
/**
|
|
42
51
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
43
52
|
*/
|
|
44
53
|
requestHandler?: __HttpHandler;
|
|
45
54
|
/**
|
|
46
|
-
* A constructor for a class implementing the {@link
|
|
55
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
47
56
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
48
57
|
* @internal
|
|
49
58
|
*/
|
|
@@ -133,23 +142,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
133
142
|
*/
|
|
134
143
|
logger?: __Logger;
|
|
135
144
|
/**
|
|
136
|
-
* The {@link
|
|
145
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
137
146
|
*/
|
|
138
147
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
139
148
|
}
|
|
149
|
+
/**
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
140
152
|
type SSMContactsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
141
153
|
/**
|
|
142
|
-
*
|
|
154
|
+
* @public
|
|
155
|
+
*
|
|
156
|
+
* The configuration interface of SSMContactsClient class constructor that set the region, credentials and other options.
|
|
143
157
|
*/
|
|
144
158
|
export interface SSMContactsClientConfig extends SSMContactsClientConfigType {
|
|
145
159
|
}
|
|
160
|
+
/**
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
146
163
|
type SSMContactsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
147
164
|
/**
|
|
148
|
-
*
|
|
165
|
+
* @public
|
|
166
|
+
*
|
|
167
|
+
* The resolved configuration interface of SSMContactsClient class. This is resolved and normalized from the {@link SSMContactsClientConfig | constructor configuration interface}.
|
|
149
168
|
*/
|
|
150
169
|
export interface SSMContactsClientResolvedConfig extends SSMContactsClientResolvedConfigType {
|
|
151
170
|
}
|
|
152
171
|
/**
|
|
172
|
+
* @public
|
|
153
173
|
* <p>Systems Manager Incident Manager is an incident management console designed to help users
|
|
154
174
|
* mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.
|
|
155
175
|
* An incident is any unplanned interruption or reduction in quality of services. </p>
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { AcceptPageRequest, AcceptPageResult } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AcceptPageCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AcceptPageCommandInput extends AcceptPageRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AcceptPageCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Used to acknowledge an engagement to a contact channel during 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 AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
|
|
|
25
30
|
* const response = await client.send(command);
|
|
26
31
|
* ```
|
|
27
32
|
*
|
|
33
|
+
* @param AcceptPageCommandInput - {@link AcceptPageCommandInput}
|
|
34
|
+
* @returns {@link AcceptPageCommandOutput}
|
|
28
35
|
* @see {@link AcceptPageCommandInput} for command's `input` shape.
|
|
29
36
|
* @see {@link AcceptPageCommandOutput} for command's `response` shape.
|
|
30
37
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
@@ -64,11 +71,20 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
|
|
|
64
71
|
export declare class AcceptPageCommand extends $Command<AcceptPageCommandInput, AcceptPageCommandOutput, SSMContactsClientResolvedConfig> {
|
|
65
72
|
readonly input: AcceptPageCommandInput;
|
|
66
73
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
67
77
|
constructor(input: AcceptPageCommandInput);
|
|
68
78
|
/**
|
|
69
79
|
* @internal
|
|
70
80
|
*/
|
|
71
81
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AcceptPageCommandInput, AcceptPageCommandOutput>;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
72
85
|
private serialize;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
73
89
|
private deserialize;
|
|
74
90
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { ActivateContactChannelRequest, ActivateContactChannelResult } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link ActivateContactChannelCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface ActivateContactChannelCommandInput extends ActivateContactChannelRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link ActivateContactChannelCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface ActivateContactChannelCommandOutput extends ActivateContactChannelResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Activates a contact's contact channel. Incident Manager can't engage a contact until the
|
|
18
23
|
* contact channel has been activated.</p>
|
|
19
24
|
* @example
|
|
@@ -26,6 +31,8 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
|
|
|
26
31
|
* const response = await client.send(command);
|
|
27
32
|
* ```
|
|
28
33
|
*
|
|
34
|
+
* @param ActivateContactChannelCommandInput - {@link ActivateContactChannelCommandInput}
|
|
35
|
+
* @returns {@link ActivateContactChannelCommandOutput}
|
|
29
36
|
* @see {@link ActivateContactChannelCommandInput} for command's `input` shape.
|
|
30
37
|
* @see {@link ActivateContactChannelCommandOutput} for command's `response` shape.
|
|
31
38
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
@@ -64,11 +71,20 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
|
|
|
64
71
|
export declare class ActivateContactChannelCommand extends $Command<ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
65
72
|
readonly input: ActivateContactChannelCommandInput;
|
|
66
73
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
67
77
|
constructor(input: ActivateContactChannelCommandInput);
|
|
68
78
|
/**
|
|
69
79
|
* @internal
|
|
70
80
|
*/
|
|
71
81
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput>;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
72
85
|
private serialize;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
73
89
|
private deserialize;
|
|
74
90
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { CreateContactChannelRequest, CreateContactChannelResult } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateContactChannelCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateContactChannelCommandInput extends CreateContactChannelRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateContactChannelCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateContactChannelCommandOutput extends CreateContactChannelResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>A contact channel is the method that Incident Manager uses to engage your 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 CreateContactChannelCommandOutput extends CreateContactChannelR
|
|
|
25
30
|
* const response = await client.send(command);
|
|
26
31
|
* ```
|
|
27
32
|
*
|
|
33
|
+
* @param CreateContactChannelCommandInput - {@link CreateContactChannelCommandInput}
|
|
34
|
+
* @returns {@link CreateContactChannelCommandOutput}
|
|
28
35
|
* @see {@link CreateContactChannelCommandInput} for command's `input` shape.
|
|
29
36
|
* @see {@link CreateContactChannelCommandOutput} for command's `response` shape.
|
|
30
37
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
@@ -75,11 +82,20 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
|
|
|
75
82
|
export declare class CreateContactChannelCommand extends $Command<CreateContactChannelCommandInput, CreateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
76
83
|
readonly input: CreateContactChannelCommandInput;
|
|
77
84
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
78
88
|
constructor(input: CreateContactChannelCommandInput);
|
|
79
89
|
/**
|
|
80
90
|
* @internal
|
|
81
91
|
*/
|
|
82
92
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateContactChannelCommandInput, CreateContactChannelCommandOutput>;
|
|
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 { CreateContactRequest, CreateContactResult } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateContactCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateContactCommandInput extends CreateContactRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateContactCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateContactCommandOutput extends CreateContactResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Contacts are either the contacts that Incident Manager engages during an incident or the
|
|
18
23
|
* escalation plans that Incident Manager uses to engage contacts in phases during an
|
|
19
24
|
* incident. </p>
|
|
@@ -27,6 +32,8 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
|
|
|
27
32
|
* const response = await client.send(command);
|
|
28
33
|
* ```
|
|
29
34
|
*
|
|
35
|
+
* @param CreateContactCommandInput - {@link CreateContactCommandInput}
|
|
36
|
+
* @returns {@link CreateContactCommandOutput}
|
|
30
37
|
* @see {@link CreateContactCommandInput} for command's `input` shape.
|
|
31
38
|
* @see {@link CreateContactCommandOutput} for command's `response` shape.
|
|
32
39
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
@@ -80,11 +87,20 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
|
|
|
80
87
|
export declare class CreateContactCommand extends $Command<CreateContactCommandInput, CreateContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
81
88
|
readonly input: CreateContactCommandInput;
|
|
82
89
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
83
93
|
constructor(input: CreateContactCommandInput);
|
|
84
94
|
/**
|
|
85
95
|
* @internal
|
|
86
96
|
*/
|
|
87
97
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateContactCommandInput, CreateContactCommandOutput>;
|
|
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 { DeactivateContactChannelRequest, DeactivateContactChannelResult } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DeactivateContactChannelCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DeactivateContactChannelCommandInput extends DeactivateContactChannelRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DeactivateContactChannelCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DeactivateContactChannelCommandOutput extends DeactivateContactChannelResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>To no longer receive Incident Manager engagements to a contact channel, you can deactivate
|
|
18
23
|
* the channel.</p>
|
|
19
24
|
* @example
|
|
@@ -26,6 +31,8 @@ export interface DeactivateContactChannelCommandOutput extends DeactivateContact
|
|
|
26
31
|
* const response = await client.send(command);
|
|
27
32
|
* ```
|
|
28
33
|
*
|
|
34
|
+
* @param DeactivateContactChannelCommandInput - {@link DeactivateContactChannelCommandInput}
|
|
35
|
+
* @returns {@link DeactivateContactChannelCommandOutput}
|
|
29
36
|
* @see {@link DeactivateContactChannelCommandInput} for command's `input` shape.
|
|
30
37
|
* @see {@link DeactivateContactChannelCommandOutput} for command's `response` shape.
|
|
31
38
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
@@ -63,11 +70,20 @@ export interface DeactivateContactChannelCommandOutput extends DeactivateContact
|
|
|
63
70
|
export declare class DeactivateContactChannelCommand extends $Command<DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
64
71
|
readonly input: DeactivateContactChannelCommandInput;
|
|
65
72
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
73
|
+
/**
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
66
76
|
constructor(input: DeactivateContactChannelCommandInput);
|
|
67
77
|
/**
|
|
68
78
|
* @internal
|
|
69
79
|
*/
|
|
70
80
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput>;
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
71
84
|
private serialize;
|
|
85
|
+
/**
|
|
86
|
+
* @internal
|
|
87
|
+
*/
|
|
72
88
|
private deserialize;
|
|
73
89
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DeleteContactChannelRequest, DeleteContactChannelResult } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DeleteContactChannelCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DeleteContactChannelCommandInput extends DeleteContactChannelRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DeleteContactChannelCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DeleteContactChannelCommandOutput extends DeleteContactChannelResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>To no longer receive engagements on a contact channel, you can delete the channel from a
|
|
18
23
|
* contact. Deleting the contact channel removes it from the contact's engagement plan. If you
|
|
19
24
|
* delete the only contact channel for a contact, you won't be able to engage that contact
|
|
@@ -28,6 +33,8 @@ export interface DeleteContactChannelCommandOutput extends DeleteContactChannelR
|
|
|
28
33
|
* const response = await client.send(command);
|
|
29
34
|
* ```
|
|
30
35
|
*
|
|
36
|
+
* @param DeleteContactChannelCommandInput - {@link DeleteContactChannelCommandInput}
|
|
37
|
+
* @returns {@link DeleteContactChannelCommandOutput}
|
|
31
38
|
* @see {@link DeleteContactChannelCommandInput} for command's `input` shape.
|
|
32
39
|
* @see {@link DeleteContactChannelCommandOutput} for command's `response` shape.
|
|
33
40
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
@@ -65,11 +72,20 @@ export interface DeleteContactChannelCommandOutput extends DeleteContactChannelR
|
|
|
65
72
|
export declare class DeleteContactChannelCommand extends $Command<DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
66
73
|
readonly input: DeleteContactChannelCommandInput;
|
|
67
74
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
68
78
|
constructor(input: DeleteContactChannelCommandInput);
|
|
69
79
|
/**
|
|
70
80
|
* @internal
|
|
71
81
|
*/
|
|
72
82
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput>;
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
73
86
|
private serialize;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
74
90
|
private deserialize;
|
|
75
91
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DeleteContactRequest, DeleteContactResult } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DeleteContactCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DeleteContactCommandInput extends DeleteContactRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DeleteContactCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DeleteContactCommandOutput extends DeleteContactResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>To remove a contact from Incident Manager, you can delete the contact. Deleting a contact
|
|
18
23
|
* removes them from all escalation plans and related response plans. Deleting an escalation
|
|
19
24
|
* plan removes it from all related response plans. You will have to recreate the contact and
|
|
@@ -28,6 +33,8 @@ export interface DeleteContactCommandOutput extends DeleteContactResult, __Metad
|
|
|
28
33
|
* const response = await client.send(command);
|
|
29
34
|
* ```
|
|
30
35
|
*
|
|
36
|
+
* @param DeleteContactCommandInput - {@link DeleteContactCommandInput}
|
|
37
|
+
* @returns {@link DeleteContactCommandOutput}
|
|
31
38
|
* @see {@link DeleteContactCommandInput} for command's `input` shape.
|
|
32
39
|
* @see {@link DeleteContactCommandOutput} for command's `response` shape.
|
|
33
40
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
@@ -65,11 +72,20 @@ export interface DeleteContactCommandOutput extends DeleteContactResult, __Metad
|
|
|
65
72
|
export declare class DeleteContactCommand extends $Command<DeleteContactCommandInput, DeleteContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
66
73
|
readonly input: DeleteContactCommandInput;
|
|
67
74
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
68
78
|
constructor(input: DeleteContactCommandInput);
|
|
69
79
|
/**
|
|
70
80
|
* @internal
|
|
71
81
|
*/
|
|
72
82
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteContactCommandInput, DeleteContactCommandOutput>;
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
73
86
|
private serialize;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
74
90
|
private deserialize;
|
|
75
91
|
}
|