@aws-sdk/client-ssm-contacts 3.300.0 → 3.303.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/README.md +101 -5
- package/dist-cjs/SSMContacts.js +180 -0
- package/dist-cjs/commands/CreateRotationCommand.js +45 -0
- package/dist-cjs/commands/CreateRotationOverrideCommand.js +45 -0
- package/dist-cjs/commands/DeleteRotationCommand.js +45 -0
- package/dist-cjs/commands/DeleteRotationOverrideCommand.js +45 -0
- package/dist-cjs/commands/GetRotationCommand.js +45 -0
- package/dist-cjs/commands/GetRotationOverrideCommand.js +45 -0
- package/dist-cjs/commands/ListPageResolutionsCommand.js +45 -0
- package/dist-cjs/commands/ListPreviewRotationShiftsCommand.js +45 -0
- package/dist-cjs/commands/ListRotationOverridesCommand.js +45 -0
- package/dist-cjs/commands/ListRotationShiftsCommand.js +45 -0
- package/dist-cjs/commands/ListRotationsCommand.js +45 -0
- package/dist-cjs/commands/UpdateRotationCommand.js +45 -0
- package/dist-cjs/commands/index.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +50 -42
- package/dist-cjs/pagination/ListPageResolutionsPaginator.js +28 -0
- package/dist-cjs/pagination/ListPreviewRotationShiftsPaginator.js +29 -0
- package/dist-cjs/pagination/ListRotationOverridesPaginator.js +29 -0
- package/dist-cjs/pagination/ListRotationShiftsPaginator.js +29 -0
- package/dist-cjs/pagination/ListRotationsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +5 -0
- package/dist-cjs/protocols/Aws_json1_1.js +1327 -107
- package/dist-es/SSMContacts.js +180 -0
- package/dist-es/commands/CreateRotationCommand.js +41 -0
- package/dist-es/commands/CreateRotationOverrideCommand.js +41 -0
- package/dist-es/commands/DeleteRotationCommand.js +41 -0
- package/dist-es/commands/DeleteRotationOverrideCommand.js +41 -0
- package/dist-es/commands/GetRotationCommand.js +41 -0
- package/dist-es/commands/GetRotationOverrideCommand.js +41 -0
- package/dist-es/commands/ListPageResolutionsCommand.js +41 -0
- package/dist-es/commands/ListPreviewRotationShiftsCommand.js +41 -0
- package/dist-es/commands/ListRotationOverridesCommand.js +41 -0
- package/dist-es/commands/ListRotationShiftsCommand.js +41 -0
- package/dist-es/commands/ListRotationsCommand.js +41 -0
- package/dist-es/commands/UpdateRotationCommand.js +41 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +49 -41
- package/dist-es/pagination/ListPageResolutionsPaginator.js +24 -0
- package/dist-es/pagination/ListPreviewRotationShiftsPaginator.js +25 -0
- package/dist-es/pagination/ListRotationOverridesPaginator.js +25 -0
- package/dist-es/pagination/ListRotationShiftsPaginator.js +25 -0
- package/dist-es/pagination/ListRotationsPaginator.js +25 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/protocols/Aws_json1_1.js +1306 -110
- package/dist-types/SSMContacts.d.ts +114 -10
- package/dist-types/SSMContactsClient.d.ts +19 -7
- package/dist-types/commands/AcceptPageCommand.d.ts +4 -18
- package/dist-types/commands/ActivateContactChannelCommand.d.ts +2 -15
- package/dist-types/commands/CreateContactChannelCommand.d.ts +4 -26
- package/dist-types/commands/CreateContactCommand.d.ts +16 -35
- package/dist-types/commands/CreateRotationCommand.d.ts +130 -0
- package/dist-types/commands/CreateRotationOverrideCommand.d.ts +88 -0
- package/dist-types/commands/DeactivateContactChannelCommand.d.ts +2 -14
- package/dist-types/commands/DeleteContactChannelCommand.d.ts +2 -14
- package/dist-types/commands/DeleteContactCommand.d.ts +5 -14
- package/dist-types/commands/DeleteRotationCommand.d.ts +83 -0
- package/dist-types/commands/DeleteRotationOverrideCommand.d.ts +80 -0
- package/dist-types/commands/DescribeEngagementCommand.d.ts +2 -26
- package/dist-types/commands/DescribePageCommand.d.ts +2 -29
- package/dist-types/commands/GetContactChannelCommand.d.ts +2 -26
- package/dist-types/commands/GetContactCommand.d.ts +2 -115
- package/dist-types/commands/GetContactPolicyCommand.d.ts +2 -20
- package/dist-types/commands/GetRotationCommand.d.ts +79 -0
- package/dist-types/commands/GetRotationOverrideCommand.d.ts +80 -0
- package/dist-types/commands/ListContactChannelsCommand.d.ts +2 -30
- package/dist-types/commands/ListContactsCommand.d.ts +3 -43
- package/dist-types/commands/ListEngagementsCommand.d.ts +3 -43
- package/dist-types/commands/ListPageReceiptsCommand.d.ts +3 -39
- package/dist-types/commands/ListPageResolutionsCommand.d.ts +84 -0
- package/dist-types/commands/ListPagesByContactCommand.d.ts +2 -29
- package/dist-types/commands/ListPagesByEngagementCommand.d.ts +2 -27
- package/dist-types/commands/ListPreviewRotationShiftsCommand.d.ts +132 -0
- package/dist-types/commands/ListRotationOverridesCommand.d.ts +83 -0
- package/dist-types/commands/ListRotationShiftsCommand.d.ts +86 -0
- package/dist-types/commands/ListRotationsCommand.d.ts +81 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -24
- package/dist-types/commands/PutContactPolicyCommand.d.ts +2 -15
- package/dist-types/commands/SendActivationCodeCommand.d.ts +2 -14
- package/dist-types/commands/StartEngagementCommand.d.ts +2 -45
- package/dist-types/commands/StopEngagementCommand.d.ts +2 -14
- package/dist-types/commands/TagResourceCommand.d.ts +5 -23
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -19
- package/dist-types/commands/UpdateContactChannelCommand.d.ts +3 -19
- package/dist-types/commands/UpdateContactCommand.d.ts +13 -59
- package/dist-types/commands/UpdateRotationCommand.d.ts +123 -0
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/models/models_0.d.ts +835 -58
- package/dist-types/pagination/ListPageResolutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPreviewRotationShiftsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRotationOverridesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRotationShiftsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRotationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
- package/dist-types/ts3.4/SSMContacts.d.ts +204 -0
- package/dist-types/ts3.4/SSMContactsClient.d.ts +74 -2
- package/dist-types/ts3.4/commands/CreateRotationCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/CreateRotationOverrideCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DeleteRotationCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DeleteRotationOverrideCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetRotationCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/GetRotationOverrideCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListPageResolutionsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListPreviewRotationShiftsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListRotationOverridesCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListRotationShiftsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListRotationsCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/UpdateRotationCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/models/models_0.d.ts +241 -34
- package/dist-types/ts3.4/pagination/ListPageResolutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPreviewRotationShiftsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRotationOverridesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRotationShiftsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRotationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +144 -0
- package/package.json +34 -34
|
@@ -3,20 +3,31 @@ import { AcceptPageCommandInput, AcceptPageCommandOutput } from "./commands/Acce
|
|
|
3
3
|
import { ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput } from "./commands/ActivateContactChannelCommand";
|
|
4
4
|
import { CreateContactChannelCommandInput, CreateContactChannelCommandOutput } from "./commands/CreateContactChannelCommand";
|
|
5
5
|
import { CreateContactCommandInput, CreateContactCommandOutput } from "./commands/CreateContactCommand";
|
|
6
|
+
import { CreateRotationCommandInput, CreateRotationCommandOutput } from "./commands/CreateRotationCommand";
|
|
7
|
+
import { CreateRotationOverrideCommandInput, CreateRotationOverrideCommandOutput } from "./commands/CreateRotationOverrideCommand";
|
|
6
8
|
import { DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput } from "./commands/DeactivateContactChannelCommand";
|
|
7
9
|
import { DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput } from "./commands/DeleteContactChannelCommand";
|
|
8
10
|
import { DeleteContactCommandInput, DeleteContactCommandOutput } from "./commands/DeleteContactCommand";
|
|
11
|
+
import { DeleteRotationCommandInput, DeleteRotationCommandOutput } from "./commands/DeleteRotationCommand";
|
|
12
|
+
import { DeleteRotationOverrideCommandInput, DeleteRotationOverrideCommandOutput } from "./commands/DeleteRotationOverrideCommand";
|
|
9
13
|
import { DescribeEngagementCommandInput, DescribeEngagementCommandOutput } from "./commands/DescribeEngagementCommand";
|
|
10
14
|
import { DescribePageCommandInput, DescribePageCommandOutput } from "./commands/DescribePageCommand";
|
|
11
15
|
import { GetContactChannelCommandInput, GetContactChannelCommandOutput } from "./commands/GetContactChannelCommand";
|
|
12
16
|
import { GetContactCommandInput, GetContactCommandOutput } from "./commands/GetContactCommand";
|
|
13
17
|
import { GetContactPolicyCommandInput, GetContactPolicyCommandOutput } from "./commands/GetContactPolicyCommand";
|
|
18
|
+
import { GetRotationCommandInput, GetRotationCommandOutput } from "./commands/GetRotationCommand";
|
|
19
|
+
import { GetRotationOverrideCommandInput, GetRotationOverrideCommandOutput } from "./commands/GetRotationOverrideCommand";
|
|
14
20
|
import { ListContactChannelsCommandInput, ListContactChannelsCommandOutput } from "./commands/ListContactChannelsCommand";
|
|
15
21
|
import { ListContactsCommandInput, ListContactsCommandOutput } from "./commands/ListContactsCommand";
|
|
16
22
|
import { ListEngagementsCommandInput, ListEngagementsCommandOutput } from "./commands/ListEngagementsCommand";
|
|
17
23
|
import { ListPageReceiptsCommandInput, ListPageReceiptsCommandOutput } from "./commands/ListPageReceiptsCommand";
|
|
24
|
+
import { ListPageResolutionsCommandInput, ListPageResolutionsCommandOutput } from "./commands/ListPageResolutionsCommand";
|
|
18
25
|
import { ListPagesByContactCommandInput, ListPagesByContactCommandOutput } from "./commands/ListPagesByContactCommand";
|
|
19
26
|
import { ListPagesByEngagementCommandInput, ListPagesByEngagementCommandOutput } from "./commands/ListPagesByEngagementCommand";
|
|
27
|
+
import { ListPreviewRotationShiftsCommandInput, ListPreviewRotationShiftsCommandOutput } from "./commands/ListPreviewRotationShiftsCommand";
|
|
28
|
+
import { ListRotationOverridesCommandInput, ListRotationOverridesCommandOutput } from "./commands/ListRotationOverridesCommand";
|
|
29
|
+
import { ListRotationsCommandInput, ListRotationsCommandOutput } from "./commands/ListRotationsCommand";
|
|
30
|
+
import { ListRotationShiftsCommandInput, ListRotationShiftsCommandOutput } from "./commands/ListRotationShiftsCommand";
|
|
20
31
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
21
32
|
import { PutContactPolicyCommandInput, PutContactPolicyCommandOutput } from "./commands/PutContactPolicyCommand";
|
|
22
33
|
import { SendActivationCodeCommandInput, SendActivationCodeCommandOutput } from "./commands/SendActivationCodeCommand";
|
|
@@ -26,17 +37,18 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
|
|
|
26
37
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
27
38
|
import { UpdateContactChannelCommandInput, UpdateContactChannelCommandOutput } from "./commands/UpdateContactChannelCommand";
|
|
28
39
|
import { UpdateContactCommandInput, UpdateContactCommandOutput } from "./commands/UpdateContactCommand";
|
|
40
|
+
import { UpdateRotationCommandInput, UpdateRotationCommandOutput } from "./commands/UpdateRotationCommand";
|
|
29
41
|
import { SSMContactsClient } from "./SSMContactsClient";
|
|
30
42
|
/**
|
|
31
43
|
* @public
|
|
32
44
|
* <p>Systems Manager Incident Manager is an incident management console designed to help users
|
|
33
45
|
* mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.
|
|
34
|
-
* An incident is any unplanned interruption or reduction in quality of services
|
|
35
|
-
* <p>Incident Manager increases incident resolution by notifying responders of
|
|
36
|
-
* highlighting relevant troubleshooting data, and providing collaboration tools to
|
|
37
|
-
* services back up and running. To achieve the primary goal of reducing the
|
|
46
|
+
* An incident is any unplanned interruption or reduction in quality of services.</p>
|
|
47
|
+
* <p>Incident Manager increases incident resolution by notifying responders of
|
|
48
|
+
* impact, highlighting relevant troubleshooting data, and providing collaboration tools to
|
|
49
|
+
* get services back up and running. To achieve the primary goal of reducing the
|
|
38
50
|
* time-to-resolution of critical incidents, Incident Manager automates response plans
|
|
39
|
-
* and enables responder team escalation
|
|
51
|
+
* and enables responder team escalation.</p>
|
|
40
52
|
*/
|
|
41
53
|
export declare class SSMContacts extends SSMContactsClient {
|
|
42
54
|
/**
|
|
@@ -58,7 +70,7 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
58
70
|
* @public
|
|
59
71
|
* <p>Contacts are either the contacts that Incident Manager engages during an incident or the
|
|
60
72
|
* escalation plans that Incident Manager uses to engage contacts in phases during an
|
|
61
|
-
* incident
|
|
73
|
+
* incident.</p>
|
|
62
74
|
*/
|
|
63
75
|
createContact(args: CreateContactCommandInput, options?: __HttpHandlerOptions): Promise<CreateContactCommandOutput>;
|
|
64
76
|
createContact(args: CreateContactCommandInput, cb: (err: any, data?: CreateContactCommandOutput) => void): void;
|
|
@@ -70,6 +82,20 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
70
82
|
createContactChannel(args: CreateContactChannelCommandInput, options?: __HttpHandlerOptions): Promise<CreateContactChannelCommandOutput>;
|
|
71
83
|
createContactChannel(args: CreateContactChannelCommandInput, cb: (err: any, data?: CreateContactChannelCommandOutput) => void): void;
|
|
72
84
|
createContactChannel(args: CreateContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactChannelCommandOutput) => void): void;
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
* <p>Creates a rotation in an on-call schedule.</p>
|
|
88
|
+
*/
|
|
89
|
+
createRotation(args: CreateRotationCommandInput, options?: __HttpHandlerOptions): Promise<CreateRotationCommandOutput>;
|
|
90
|
+
createRotation(args: CreateRotationCommandInput, cb: (err: any, data?: CreateRotationCommandOutput) => void): void;
|
|
91
|
+
createRotation(args: CreateRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRotationCommandOutput) => void): void;
|
|
92
|
+
/**
|
|
93
|
+
* @public
|
|
94
|
+
* <p>Creates an override for a rotation in an on-call schedule.</p>
|
|
95
|
+
*/
|
|
96
|
+
createRotationOverride(args: CreateRotationOverrideCommandInput, options?: __HttpHandlerOptions): Promise<CreateRotationOverrideCommandOutput>;
|
|
97
|
+
createRotationOverride(args: CreateRotationOverrideCommandInput, cb: (err: any, data?: CreateRotationOverrideCommandOutput) => void): void;
|
|
98
|
+
createRotationOverride(args: CreateRotationOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRotationOverrideCommandOutput) => void): void;
|
|
73
99
|
/**
|
|
74
100
|
* @public
|
|
75
101
|
* <p>To no longer receive Incident Manager engagements to a contact channel, you can deactivate
|
|
@@ -98,6 +124,21 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
98
124
|
deleteContactChannel(args: DeleteContactChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteContactChannelCommandOutput>;
|
|
99
125
|
deleteContactChannel(args: DeleteContactChannelCommandInput, cb: (err: any, data?: DeleteContactChannelCommandOutput) => void): void;
|
|
100
126
|
deleteContactChannel(args: DeleteContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactChannelCommandOutput) => void): void;
|
|
127
|
+
/**
|
|
128
|
+
* @public
|
|
129
|
+
* <p>Deletes a rotation from the system. If a rotation belongs to more than one on-call
|
|
130
|
+
* schedule, this operation deletes it from all of them.</p>
|
|
131
|
+
*/
|
|
132
|
+
deleteRotation(args: DeleteRotationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRotationCommandOutput>;
|
|
133
|
+
deleteRotation(args: DeleteRotationCommandInput, cb: (err: any, data?: DeleteRotationCommandOutput) => void): void;
|
|
134
|
+
deleteRotation(args: DeleteRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRotationCommandOutput) => void): void;
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
* <p>Deletes an existing override for an on-call rotation.</p>
|
|
138
|
+
*/
|
|
139
|
+
deleteRotationOverride(args: DeleteRotationOverrideCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRotationOverrideCommandOutput>;
|
|
140
|
+
deleteRotationOverride(args: DeleteRotationOverrideCommandInput, cb: (err: any, data?: DeleteRotationOverrideCommandOutput) => void): void;
|
|
141
|
+
deleteRotationOverride(args: DeleteRotationOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRotationOverrideCommandOutput) => void): void;
|
|
101
142
|
/**
|
|
102
143
|
* @public
|
|
103
144
|
* <p>Incident Manager uses engagements to engage contacts and escalation plans during an incident.
|
|
@@ -135,6 +176,20 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
135
176
|
getContactPolicy(args: GetContactPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetContactPolicyCommandOutput>;
|
|
136
177
|
getContactPolicy(args: GetContactPolicyCommandInput, cb: (err: any, data?: GetContactPolicyCommandOutput) => void): void;
|
|
137
178
|
getContactPolicy(args: GetContactPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactPolicyCommandOutput) => void): void;
|
|
179
|
+
/**
|
|
180
|
+
* @public
|
|
181
|
+
* <p>Retrieves information about an on-call rotation.</p>
|
|
182
|
+
*/
|
|
183
|
+
getRotation(args: GetRotationCommandInput, options?: __HttpHandlerOptions): Promise<GetRotationCommandOutput>;
|
|
184
|
+
getRotation(args: GetRotationCommandInput, cb: (err: any, data?: GetRotationCommandOutput) => void): void;
|
|
185
|
+
getRotation(args: GetRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRotationCommandOutput) => void): void;
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
* <p>Retrieves information about an override to an on-call rotation.</p>
|
|
189
|
+
*/
|
|
190
|
+
getRotationOverride(args: GetRotationOverrideCommandInput, options?: __HttpHandlerOptions): Promise<GetRotationOverrideCommandOutput>;
|
|
191
|
+
getRotationOverride(args: GetRotationOverrideCommandInput, cb: (err: any, data?: GetRotationOverrideCommandOutput) => void): void;
|
|
192
|
+
getRotationOverride(args: GetRotationOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRotationOverrideCommandOutput) => void): void;
|
|
138
193
|
/**
|
|
139
194
|
* @public
|
|
140
195
|
* <p>Lists all contact channels for the specified contact.</p>
|
|
@@ -158,11 +213,22 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
158
213
|
listEngagements(args: ListEngagementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEngagementsCommandOutput) => void): void;
|
|
159
214
|
/**
|
|
160
215
|
* @public
|
|
161
|
-
* <p>Lists all of the engagements to contact channels that have been acknowledged
|
|
216
|
+
* <p>Lists all of the engagements to contact channels that have been acknowledged.</p>
|
|
162
217
|
*/
|
|
163
218
|
listPageReceipts(args: ListPageReceiptsCommandInput, options?: __HttpHandlerOptions): Promise<ListPageReceiptsCommandOutput>;
|
|
164
219
|
listPageReceipts(args: ListPageReceiptsCommandInput, cb: (err: any, data?: ListPageReceiptsCommandOutput) => void): void;
|
|
165
220
|
listPageReceipts(args: ListPageReceiptsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPageReceiptsCommandOutput) => void): void;
|
|
221
|
+
/**
|
|
222
|
+
* @public
|
|
223
|
+
* <p>Returns the resolution path of an engagement. For example, the escalation plan engaged
|
|
224
|
+
* in an incident might target an on-call schedule that includes several contacts in a
|
|
225
|
+
* rotation, but just one contact on-call when the incident starts. The resolution path
|
|
226
|
+
* indicates the hierarchy of <i>escalation plan > on-call schedule >
|
|
227
|
+
* contact</i>.</p>
|
|
228
|
+
*/
|
|
229
|
+
listPageResolutions(args: ListPageResolutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListPageResolutionsCommandOutput>;
|
|
230
|
+
listPageResolutions(args: ListPageResolutionsCommandInput, cb: (err: any, data?: ListPageResolutionsCommandOutput) => void): void;
|
|
231
|
+
listPageResolutions(args: ListPageResolutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPageResolutionsCommandOutput) => void): void;
|
|
166
232
|
/**
|
|
167
233
|
* @public
|
|
168
234
|
* <p>Lists the engagements to a contact's contact channels.</p>
|
|
@@ -177,6 +243,37 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
177
243
|
listPagesByEngagement(args: ListPagesByEngagementCommandInput, options?: __HttpHandlerOptions): Promise<ListPagesByEngagementCommandOutput>;
|
|
178
244
|
listPagesByEngagement(args: ListPagesByEngagementCommandInput, cb: (err: any, data?: ListPagesByEngagementCommandOutput) => void): void;
|
|
179
245
|
listPagesByEngagement(args: ListPagesByEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPagesByEngagementCommandOutput) => void): void;
|
|
246
|
+
/**
|
|
247
|
+
* @public
|
|
248
|
+
* <p>Returns a list of shifts based on rotation configuration parameters.</p>
|
|
249
|
+
* <note>
|
|
250
|
+
* <p>The Incident Manager primarily uses this operation to populate the <b>Preview</b> calendar. It is not typically run by end users.</p>
|
|
251
|
+
* </note>
|
|
252
|
+
*/
|
|
253
|
+
listPreviewRotationShifts(args: ListPreviewRotationShiftsCommandInput, options?: __HttpHandlerOptions): Promise<ListPreviewRotationShiftsCommandOutput>;
|
|
254
|
+
listPreviewRotationShifts(args: ListPreviewRotationShiftsCommandInput, cb: (err: any, data?: ListPreviewRotationShiftsCommandOutput) => void): void;
|
|
255
|
+
listPreviewRotationShifts(args: ListPreviewRotationShiftsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPreviewRotationShiftsCommandOutput) => void): void;
|
|
256
|
+
/**
|
|
257
|
+
* @public
|
|
258
|
+
* <p>Retrieves a list of overrides currently specified for an on-call rotation.</p>
|
|
259
|
+
*/
|
|
260
|
+
listRotationOverrides(args: ListRotationOverridesCommandInput, options?: __HttpHandlerOptions): Promise<ListRotationOverridesCommandOutput>;
|
|
261
|
+
listRotationOverrides(args: ListRotationOverridesCommandInput, cb: (err: any, data?: ListRotationOverridesCommandOutput) => void): void;
|
|
262
|
+
listRotationOverrides(args: ListRotationOverridesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRotationOverridesCommandOutput) => void): void;
|
|
263
|
+
/**
|
|
264
|
+
* @public
|
|
265
|
+
* <p>Retrieves a list of on-call rotations.</p>
|
|
266
|
+
*/
|
|
267
|
+
listRotations(args: ListRotationsCommandInput, options?: __HttpHandlerOptions): Promise<ListRotationsCommandOutput>;
|
|
268
|
+
listRotations(args: ListRotationsCommandInput, cb: (err: any, data?: ListRotationsCommandOutput) => void): void;
|
|
269
|
+
listRotations(args: ListRotationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRotationsCommandOutput) => void): void;
|
|
270
|
+
/**
|
|
271
|
+
* @public
|
|
272
|
+
* <p>Returns a list of shifts generated by an existing rotation in the system.</p>
|
|
273
|
+
*/
|
|
274
|
+
listRotationShifts(args: ListRotationShiftsCommandInput, options?: __HttpHandlerOptions): Promise<ListRotationShiftsCommandOutput>;
|
|
275
|
+
listRotationShifts(args: ListRotationShiftsCommandInput, cb: (err: any, data?: ListRotationShiftsCommandOutput) => void): void;
|
|
276
|
+
listRotationShifts(args: ListRotationShiftsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRotationShiftsCommandOutput) => void): void;
|
|
180
277
|
/**
|
|
181
278
|
* @public
|
|
182
279
|
* <p>Lists the tags of an escalation plan or contact.</p>
|
|
@@ -221,21 +318,21 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
221
318
|
/**
|
|
222
319
|
* @public
|
|
223
320
|
* <p>Tags a contact or escalation plan. You can tag only contacts and escalation plans in the
|
|
224
|
-
* first region of your replication set
|
|
321
|
+
* first region of your replication set.</p>
|
|
225
322
|
*/
|
|
226
323
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
227
324
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
228
325
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
229
326
|
/**
|
|
230
327
|
* @public
|
|
231
|
-
* <p>Removes tags from the specified resource
|
|
328
|
+
* <p>Removes tags from the specified resource.</p>
|
|
232
329
|
*/
|
|
233
330
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
234
331
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
235
332
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
236
333
|
/**
|
|
237
334
|
* @public
|
|
238
|
-
* <p>Updates the contact or escalation plan specified
|
|
335
|
+
* <p>Updates the contact or escalation plan specified.</p>
|
|
239
336
|
*/
|
|
240
337
|
updateContact(args: UpdateContactCommandInput, options?: __HttpHandlerOptions): Promise<UpdateContactCommandOutput>;
|
|
241
338
|
updateContact(args: UpdateContactCommandInput, cb: (err: any, data?: UpdateContactCommandOutput) => void): void;
|
|
@@ -247,4 +344,11 @@ export declare class SSMContacts extends SSMContactsClient {
|
|
|
247
344
|
updateContactChannel(args: UpdateContactChannelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateContactChannelCommandOutput>;
|
|
248
345
|
updateContactChannel(args: UpdateContactChannelCommandInput, cb: (err: any, data?: UpdateContactChannelCommandOutput) => void): void;
|
|
249
346
|
updateContactChannel(args: UpdateContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactChannelCommandOutput) => void): void;
|
|
347
|
+
/**
|
|
348
|
+
* @public
|
|
349
|
+
* <p>Updates the information specified for an on-call rotation.</p>
|
|
350
|
+
*/
|
|
351
|
+
updateRotation(args: UpdateRotationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRotationCommandOutput>;
|
|
352
|
+
updateRotation(args: UpdateRotationCommandInput, cb: (err: any, data?: UpdateRotationCommandOutput) => void): void;
|
|
353
|
+
updateRotation(args: UpdateRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRotationCommandOutput) => void): void;
|
|
250
354
|
}
|
|
@@ -11,20 +11,31 @@ import { AcceptPageCommandInput, AcceptPageCommandOutput } from "./commands/Acce
|
|
|
11
11
|
import { ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput } from "./commands/ActivateContactChannelCommand";
|
|
12
12
|
import { CreateContactChannelCommandInput, CreateContactChannelCommandOutput } from "./commands/CreateContactChannelCommand";
|
|
13
13
|
import { CreateContactCommandInput, CreateContactCommandOutput } from "./commands/CreateContactCommand";
|
|
14
|
+
import { CreateRotationCommandInput, CreateRotationCommandOutput } from "./commands/CreateRotationCommand";
|
|
15
|
+
import { CreateRotationOverrideCommandInput, CreateRotationOverrideCommandOutput } from "./commands/CreateRotationOverrideCommand";
|
|
14
16
|
import { DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput } from "./commands/DeactivateContactChannelCommand";
|
|
15
17
|
import { DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput } from "./commands/DeleteContactChannelCommand";
|
|
16
18
|
import { DeleteContactCommandInput, DeleteContactCommandOutput } from "./commands/DeleteContactCommand";
|
|
19
|
+
import { DeleteRotationCommandInput, DeleteRotationCommandOutput } from "./commands/DeleteRotationCommand";
|
|
20
|
+
import { DeleteRotationOverrideCommandInput, DeleteRotationOverrideCommandOutput } from "./commands/DeleteRotationOverrideCommand";
|
|
17
21
|
import { DescribeEngagementCommandInput, DescribeEngagementCommandOutput } from "./commands/DescribeEngagementCommand";
|
|
18
22
|
import { DescribePageCommandInput, DescribePageCommandOutput } from "./commands/DescribePageCommand";
|
|
19
23
|
import { GetContactChannelCommandInput, GetContactChannelCommandOutput } from "./commands/GetContactChannelCommand";
|
|
20
24
|
import { GetContactCommandInput, GetContactCommandOutput } from "./commands/GetContactCommand";
|
|
21
25
|
import { GetContactPolicyCommandInput, GetContactPolicyCommandOutput } from "./commands/GetContactPolicyCommand";
|
|
26
|
+
import { GetRotationCommandInput, GetRotationCommandOutput } from "./commands/GetRotationCommand";
|
|
27
|
+
import { GetRotationOverrideCommandInput, GetRotationOverrideCommandOutput } from "./commands/GetRotationOverrideCommand";
|
|
22
28
|
import { ListContactChannelsCommandInput, ListContactChannelsCommandOutput } from "./commands/ListContactChannelsCommand";
|
|
23
29
|
import { ListContactsCommandInput, ListContactsCommandOutput } from "./commands/ListContactsCommand";
|
|
24
30
|
import { ListEngagementsCommandInput, ListEngagementsCommandOutput } from "./commands/ListEngagementsCommand";
|
|
25
31
|
import { ListPageReceiptsCommandInput, ListPageReceiptsCommandOutput } from "./commands/ListPageReceiptsCommand";
|
|
32
|
+
import { ListPageResolutionsCommandInput, ListPageResolutionsCommandOutput } from "./commands/ListPageResolutionsCommand";
|
|
26
33
|
import { ListPagesByContactCommandInput, ListPagesByContactCommandOutput } from "./commands/ListPagesByContactCommand";
|
|
27
34
|
import { ListPagesByEngagementCommandInput, ListPagesByEngagementCommandOutput } from "./commands/ListPagesByEngagementCommand";
|
|
35
|
+
import { ListPreviewRotationShiftsCommandInput, ListPreviewRotationShiftsCommandOutput } from "./commands/ListPreviewRotationShiftsCommand";
|
|
36
|
+
import { ListRotationOverridesCommandInput, ListRotationOverridesCommandOutput } from "./commands/ListRotationOverridesCommand";
|
|
37
|
+
import { ListRotationsCommandInput, ListRotationsCommandOutput } from "./commands/ListRotationsCommand";
|
|
38
|
+
import { ListRotationShiftsCommandInput, ListRotationShiftsCommandOutput } from "./commands/ListRotationShiftsCommand";
|
|
28
39
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
29
40
|
import { PutContactPolicyCommandInput, PutContactPolicyCommandOutput } from "./commands/PutContactPolicyCommand";
|
|
30
41
|
import { SendActivationCodeCommandInput, SendActivationCodeCommandOutput } from "./commands/SendActivationCodeCommand";
|
|
@@ -34,15 +45,16 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
|
|
|
34
45
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
35
46
|
import { UpdateContactChannelCommandInput, UpdateContactChannelCommandOutput } from "./commands/UpdateContactChannelCommand";
|
|
36
47
|
import { UpdateContactCommandInput, UpdateContactCommandOutput } from "./commands/UpdateContactCommand";
|
|
48
|
+
import { UpdateRotationCommandInput, UpdateRotationCommandOutput } from "./commands/UpdateRotationCommand";
|
|
37
49
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
38
50
|
/**
|
|
39
51
|
* @public
|
|
40
52
|
*/
|
|
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;
|
|
53
|
+
export type ServiceInputTypes = AcceptPageCommandInput | ActivateContactChannelCommandInput | CreateContactChannelCommandInput | CreateContactCommandInput | CreateRotationCommandInput | CreateRotationOverrideCommandInput | DeactivateContactChannelCommandInput | DeleteContactChannelCommandInput | DeleteContactCommandInput | DeleteRotationCommandInput | DeleteRotationOverrideCommandInput | DescribeEngagementCommandInput | DescribePageCommandInput | GetContactChannelCommandInput | GetContactCommandInput | GetContactPolicyCommandInput | GetRotationCommandInput | GetRotationOverrideCommandInput | ListContactChannelsCommandInput | ListContactsCommandInput | ListEngagementsCommandInput | ListPageReceiptsCommandInput | ListPageResolutionsCommandInput | ListPagesByContactCommandInput | ListPagesByEngagementCommandInput | ListPreviewRotationShiftsCommandInput | ListRotationOverridesCommandInput | ListRotationShiftsCommandInput | ListRotationsCommandInput | ListTagsForResourceCommandInput | PutContactPolicyCommandInput | SendActivationCodeCommandInput | StartEngagementCommandInput | StopEngagementCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateContactChannelCommandInput | UpdateContactCommandInput | UpdateRotationCommandInput;
|
|
42
54
|
/**
|
|
43
55
|
* @public
|
|
44
56
|
*/
|
|
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;
|
|
57
|
+
export type ServiceOutputTypes = AcceptPageCommandOutput | ActivateContactChannelCommandOutput | CreateContactChannelCommandOutput | CreateContactCommandOutput | CreateRotationCommandOutput | CreateRotationOverrideCommandOutput | DeactivateContactChannelCommandOutput | DeleteContactChannelCommandOutput | DeleteContactCommandOutput | DeleteRotationCommandOutput | DeleteRotationOverrideCommandOutput | DescribeEngagementCommandOutput | DescribePageCommandOutput | GetContactChannelCommandOutput | GetContactCommandOutput | GetContactPolicyCommandOutput | GetRotationCommandOutput | GetRotationOverrideCommandOutput | ListContactChannelsCommandOutput | ListContactsCommandOutput | ListEngagementsCommandOutput | ListPageReceiptsCommandOutput | ListPageResolutionsCommandOutput | ListPagesByContactCommandOutput | ListPagesByEngagementCommandOutput | ListPreviewRotationShiftsCommandOutput | ListRotationOverridesCommandOutput | ListRotationShiftsCommandOutput | ListRotationsCommandOutput | ListTagsForResourceCommandOutput | PutContactPolicyCommandOutput | SendActivationCodeCommandOutput | StartEngagementCommandOutput | StopEngagementCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateContactChannelCommandOutput | UpdateContactCommandOutput | UpdateRotationCommandOutput;
|
|
46
58
|
/**
|
|
47
59
|
* @public
|
|
48
60
|
*/
|
|
@@ -172,12 +184,12 @@ export interface SSMContactsClientResolvedConfig extends SSMContactsClientResolv
|
|
|
172
184
|
* @public
|
|
173
185
|
* <p>Systems Manager Incident Manager is an incident management console designed to help users
|
|
174
186
|
* mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.
|
|
175
|
-
* An incident is any unplanned interruption or reduction in quality of services
|
|
176
|
-
* <p>Incident Manager increases incident resolution by notifying responders of
|
|
177
|
-
* highlighting relevant troubleshooting data, and providing collaboration tools to
|
|
178
|
-
* services back up and running. To achieve the primary goal of reducing the
|
|
187
|
+
* An incident is any unplanned interruption or reduction in quality of services.</p>
|
|
188
|
+
* <p>Incident Manager increases incident resolution by notifying responders of
|
|
189
|
+
* impact, highlighting relevant troubleshooting data, and providing collaboration tools to
|
|
190
|
+
* get services back up and running. To achieve the primary goal of reducing the
|
|
179
191
|
* time-to-resolution of critical incidents, Incident Manager automates response plans
|
|
180
|
-
* and enables responder team escalation
|
|
192
|
+
* and enables responder team escalation.</p>
|
|
181
193
|
*/
|
|
182
194
|
export declare class SSMContactsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig> {
|
|
183
195
|
/**
|
|
@@ -26,13 +26,13 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
|
|
|
26
26
|
* import { SSMContactsClient, AcceptPageCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
|
|
27
27
|
* // const { SSMContactsClient, AcceptPageCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
|
|
28
28
|
* const client = new SSMContactsClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // AcceptPageRequest
|
|
30
30
|
* PageId: "STRING_VALUE", // required
|
|
31
31
|
* ContactChannelId: "STRING_VALUE",
|
|
32
|
-
* AcceptType: "
|
|
32
|
+
* AcceptType: "DELIVERED" || "READ", // required
|
|
33
33
|
* Note: "STRING_VALUE",
|
|
34
34
|
* AcceptCode: "STRING_VALUE", // required
|
|
35
|
-
* AcceptCodeValidation: "
|
|
35
|
+
* AcceptCodeValidation: "IGNORE" || "ENFORCE",
|
|
36
36
|
* };
|
|
37
37
|
* const command = new AcceptPageCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
@@ -48,8 +48,7 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
|
|
|
48
48
|
* <p>You don't have sufficient access to perform this operation.</p>
|
|
49
49
|
*
|
|
50
50
|
* @throws {@link InternalServerException} (server fault)
|
|
51
|
-
* <p>Unexpected error occurred while
|
|
52
|
-
* processing the request.</p>
|
|
51
|
+
* <p>Unexpected error occurred while processing the request.</p>
|
|
53
52
|
*
|
|
54
53
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
55
54
|
* <p>Request references a resource that doesn't exist.</p>
|
|
@@ -62,19 +61,6 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
|
|
|
62
61
|
* service.</p>
|
|
63
62
|
*
|
|
64
63
|
*
|
|
65
|
-
* @example To accept a page during and engagement
|
|
66
|
-
* ```javascript
|
|
67
|
-
* // The following accept-page operation uses an accept code sent to the contact channel to accept a page.
|
|
68
|
-
* const input = {
|
|
69
|
-
* "AcceptCode": "425440",
|
|
70
|
-
* "AcceptType": "READ",
|
|
71
|
-
* "PageId": "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"
|
|
72
|
-
* };
|
|
73
|
-
* const command = new AcceptPageCommand(input);
|
|
74
|
-
* await client.send(command);
|
|
75
|
-
* // example id: to-accept-a-page-during-and-engagement-1630357840187
|
|
76
|
-
* ```
|
|
77
|
-
*
|
|
78
64
|
*/
|
|
79
65
|
export declare class AcceptPageCommand extends $Command<AcceptPageCommandInput, AcceptPageCommandOutput, SSMContactsClientResolvedConfig> {
|
|
80
66
|
readonly input: AcceptPageCommandInput;
|
|
@@ -27,7 +27,7 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
|
|
|
27
27
|
* import { SSMContactsClient, ActivateContactChannelCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
|
|
28
28
|
* // const { SSMContactsClient, ActivateContactChannelCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
|
|
29
29
|
* const client = new SSMContactsClient(config);
|
|
30
|
-
* const input = {
|
|
30
|
+
* const input = { // ActivateContactChannelRequest
|
|
31
31
|
* ContactChannelId: "STRING_VALUE", // required
|
|
32
32
|
* ActivationCode: "STRING_VALUE", // required
|
|
33
33
|
* };
|
|
@@ -45,8 +45,7 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
|
|
|
45
45
|
* <p>You don't have sufficient access to perform this operation.</p>
|
|
46
46
|
*
|
|
47
47
|
* @throws {@link InternalServerException} (server fault)
|
|
48
|
-
* <p>Unexpected error occurred while
|
|
49
|
-
* processing the request.</p>
|
|
48
|
+
* <p>Unexpected error occurred while processing the request.</p>
|
|
50
49
|
*
|
|
51
50
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
52
51
|
* <p>Request references a resource that doesn't exist.</p>
|
|
@@ -59,18 +58,6 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
|
|
|
59
58
|
* service.</p>
|
|
60
59
|
*
|
|
61
60
|
*
|
|
62
|
-
* @example Activate a contact's contact channel
|
|
63
|
-
* ```javascript
|
|
64
|
-
* // The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.
|
|
65
|
-
* const input = {
|
|
66
|
-
* "ActivationCode": "466136",
|
|
67
|
-
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
|
|
68
|
-
* };
|
|
69
|
-
* const command = new ActivateContactChannelCommand(input);
|
|
70
|
-
* await client.send(command);
|
|
71
|
-
* // example id: activate-a-contacts-contact-channel-1630359780075
|
|
72
|
-
* ```
|
|
73
|
-
*
|
|
74
61
|
*/
|
|
75
62
|
export declare class ActivateContactChannelCommand extends $Command<ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
76
63
|
readonly input: ActivateContactChannelCommandInput;
|
|
@@ -26,11 +26,11 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
|
|
|
26
26
|
* import { SSMContactsClient, CreateContactChannelCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
|
|
27
27
|
* // const { SSMContactsClient, CreateContactChannelCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
|
|
28
28
|
* const client = new SSMContactsClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // CreateContactChannelRequest
|
|
30
30
|
* ContactId: "STRING_VALUE", // required
|
|
31
31
|
* Name: "STRING_VALUE", // required
|
|
32
|
-
* Type: "
|
|
33
|
-
* DeliveryAddress: {
|
|
32
|
+
* Type: "SMS" || "VOICE" || "EMAIL", // required
|
|
33
|
+
* DeliveryAddress: { // ContactChannelAddress
|
|
34
34
|
* SimpleAddress: "STRING_VALUE",
|
|
35
35
|
* },
|
|
36
36
|
* DeferActivation: true || false,
|
|
@@ -56,8 +56,7 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
|
|
|
56
56
|
* <p>The operation failed to due an encryption key error.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link InternalServerException} (server fault)
|
|
59
|
-
* <p>Unexpected error occurred while
|
|
60
|
-
* processing the request.</p>
|
|
59
|
+
* <p>Unexpected error occurred while processing the request.</p>
|
|
61
60
|
*
|
|
62
61
|
* @throws {@link ThrottlingException} (client fault)
|
|
63
62
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -67,27 +66,6 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
|
|
|
67
66
|
* service.</p>
|
|
68
67
|
*
|
|
69
68
|
*
|
|
70
|
-
* @example To create a contact channel
|
|
71
|
-
* ```javascript
|
|
72
|
-
* // Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.
|
|
73
|
-
* const input = {
|
|
74
|
-
* "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
|
75
|
-
* "DeliveryAddress": {
|
|
76
|
-
* "SimpleAddress": "+15005550199"
|
|
77
|
-
* },
|
|
78
|
-
* "Name": "akuas sms-test",
|
|
79
|
-
* "Type": "SMS"
|
|
80
|
-
* };
|
|
81
|
-
* const command = new CreateContactChannelCommand(input);
|
|
82
|
-
* const response = await client.send(command);
|
|
83
|
-
* /* response ==
|
|
84
|
-
* {
|
|
85
|
-
* "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024"
|
|
86
|
-
* }
|
|
87
|
-
* *\/
|
|
88
|
-
* // example id: to-create-a-contact-channel-1630360447010
|
|
89
|
-
* ```
|
|
90
|
-
*
|
|
91
69
|
*/
|
|
92
70
|
export declare class CreateContactChannelCommand extends $Command<CreateContactChannelCommandInput, CreateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
93
71
|
readonly input: CreateContactChannelCommandInput;
|
|
@@ -21,28 +21,28 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Contacts are either the contacts that Incident Manager engages during an incident or the
|
|
23
23
|
* escalation plans that Incident Manager uses to engage contacts in phases during an
|
|
24
|
-
* incident
|
|
24
|
+
* incident.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
28
28
|
* import { SSMContactsClient, CreateContactCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
|
|
29
29
|
* // const { SSMContactsClient, CreateContactCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
|
|
30
30
|
* const client = new SSMContactsClient(config);
|
|
31
|
-
* const input = {
|
|
31
|
+
* const input = { // CreateContactRequest
|
|
32
32
|
* Alias: "STRING_VALUE", // required
|
|
33
33
|
* DisplayName: "STRING_VALUE",
|
|
34
|
-
* Type: "
|
|
35
|
-
* Plan: {
|
|
36
|
-
* Stages: [ //
|
|
37
|
-
* {
|
|
34
|
+
* Type: "PERSONAL" || "ESCALATION" || "ONCALL_SCHEDULE", // required
|
|
35
|
+
* Plan: { // Plan
|
|
36
|
+
* Stages: [ // StagesList
|
|
37
|
+
* { // Stage
|
|
38
38
|
* DurationInMinutes: Number("int"), // required
|
|
39
|
-
* Targets: [ // required
|
|
40
|
-
* {
|
|
41
|
-
* ChannelTargetInfo: {
|
|
39
|
+
* Targets: [ // TargetsList // required
|
|
40
|
+
* { // Target
|
|
41
|
+
* ChannelTargetInfo: { // ChannelTargetInfo
|
|
42
42
|
* ContactChannelId: "STRING_VALUE", // required
|
|
43
43
|
* RetryIntervalInMinutes: Number("int"),
|
|
44
44
|
* },
|
|
45
|
-
* ContactTargetInfo: {
|
|
45
|
+
* ContactTargetInfo: { // ContactTargetInfo
|
|
46
46
|
* ContactId: "STRING_VALUE",
|
|
47
47
|
* IsEssential: true || false, // required
|
|
48
48
|
* },
|
|
@@ -50,9 +50,12 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
|
|
|
50
50
|
* ],
|
|
51
51
|
* },
|
|
52
52
|
* ],
|
|
53
|
+
* RotationIds: [ // SsmContactsArnList
|
|
54
|
+
* "STRING_VALUE",
|
|
55
|
+
* ],
|
|
53
56
|
* },
|
|
54
|
-
* Tags: [
|
|
55
|
-
* {
|
|
57
|
+
* Tags: [ // TagsList
|
|
58
|
+
* { // Tag
|
|
56
59
|
* Key: "STRING_VALUE",
|
|
57
60
|
* Value: "STRING_VALUE",
|
|
58
61
|
* },
|
|
@@ -79,8 +82,7 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
|
|
|
79
82
|
* <p>The operation failed to due an encryption key error.</p>
|
|
80
83
|
*
|
|
81
84
|
* @throws {@link InternalServerException} (server fault)
|
|
82
|
-
* <p>Unexpected error occurred while
|
|
83
|
-
* processing the request.</p>
|
|
85
|
+
* <p>Unexpected error occurred while processing the request.</p>
|
|
84
86
|
*
|
|
85
87
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
86
88
|
* <p>Request would cause a service quota to be exceeded.</p>
|
|
@@ -93,27 +95,6 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
|
|
|
93
95
|
* service.</p>
|
|
94
96
|
*
|
|
95
97
|
*
|
|
96
|
-
* @example To create a contact
|
|
97
|
-
* ```javascript
|
|
98
|
-
* // The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you have created contact channels for this contact use update-contact to update the plan.
|
|
99
|
-
* const input = {
|
|
100
|
-
* "Alias": "akuam",
|
|
101
|
-
* "DisplayName": "Akua Mansa",
|
|
102
|
-
* "Plan": {
|
|
103
|
-
* "Stages": []
|
|
104
|
-
* },
|
|
105
|
-
* "Type": "PERSONAL"
|
|
106
|
-
* };
|
|
107
|
-
* const command = new CreateContactCommand(input);
|
|
108
|
-
* const response = await client.send(command);
|
|
109
|
-
* /* response ==
|
|
110
|
-
* {
|
|
111
|
-
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
|
|
112
|
-
* }
|
|
113
|
-
* *\/
|
|
114
|
-
* // example id: to-create-a-contact-1630360152750
|
|
115
|
-
* ```
|
|
116
|
-
*
|
|
117
98
|
*/
|
|
118
99
|
export declare class CreateContactCommand extends $Command<CreateContactCommandInput, CreateContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
119
100
|
readonly input: CreateContactCommandInput;
|