@aws-sdk/client-ssm-contacts 3.872.0 → 3.876.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.
|
@@ -27,10 +27,11 @@ declare const DeleteContactChannelCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>To
|
|
31
|
-
* contact. Deleting the contact channel
|
|
32
|
-
*
|
|
33
|
-
* during an
|
|
30
|
+
* <p>To stop receiving engagements on a contact channel, you can delete the channel from a
|
|
31
|
+
* contact. Deleting the contact channel does not remove it from the contact's engagement
|
|
32
|
+
* plan, but the stage that includes the channel will be ignored. If you delete the only
|
|
33
|
+
* contact channel for a contact, you'll no longer be able to engage that contact during an
|
|
34
|
+
* incident.</p>
|
|
34
35
|
* @example
|
|
35
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
37
|
* ```javascript
|
|
@@ -27,10 +27,11 @@ declare const DeleteContactCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>To remove a contact from Incident Manager, you can delete the contact.
|
|
31
|
-
*
|
|
32
|
-
* plan
|
|
33
|
-
*
|
|
30
|
+
* <p>To remove a contact from Incident Manager, you can delete the contact. However, deleting a
|
|
31
|
+
* contact does not remove it from escalation plans and related response plans. Deleting an
|
|
32
|
+
* escalation plan also does not remove it from all related response plans. To modify an
|
|
33
|
+
* escalation plan, we recommend using the <a>UpdateContact</a> action to specify a
|
|
34
|
+
* different existing contact.</p>
|
|
34
35
|
* @example
|
|
35
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
37
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the tags of
|
|
30
|
+
* <p>Lists the tags of a contact, escalation plan, rotation, or on-call schedule.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -251,8 +251,8 @@ export interface ChannelTargetInfo {
|
|
|
251
251
|
*/
|
|
252
252
|
ContactChannelId: string | undefined;
|
|
253
253
|
/**
|
|
254
|
-
* <p>The number of minutes to wait to
|
|
255
|
-
* initially
|
|
254
|
+
* <p>The number of minutes to wait before retrying to send engagement if the engagement
|
|
255
|
+
* initially failed.</p>
|
|
256
256
|
* @public
|
|
257
257
|
*/
|
|
258
258
|
RetryIntervalInMinutes?: number | undefined;
|
|
@@ -352,8 +352,21 @@ export interface Contact {
|
|
|
352
352
|
*/
|
|
353
353
|
DisplayName?: string | undefined;
|
|
354
354
|
/**
|
|
355
|
-
* <p>
|
|
356
|
-
*
|
|
355
|
+
* <p>The type of contact.</p>
|
|
356
|
+
* <ul>
|
|
357
|
+
* <li>
|
|
358
|
+
* <p>
|
|
359
|
+
* <code>PERSONAL</code>: A single, individual contact.</p>
|
|
360
|
+
* </li>
|
|
361
|
+
* <li>
|
|
362
|
+
* <p>
|
|
363
|
+
* <code>ESCALATION</code>: An escalation plan.</p>
|
|
364
|
+
* </li>
|
|
365
|
+
* <li>
|
|
366
|
+
* <p>
|
|
367
|
+
* <code>ONCALL_SCHEDULE</code>: An on-call schedule.</p>
|
|
368
|
+
* </li>
|
|
369
|
+
* </ul>
|
|
357
370
|
* @public
|
|
358
371
|
*/
|
|
359
372
|
Type: ContactType | undefined;
|
|
@@ -484,12 +497,12 @@ export interface CoverageTime {
|
|
|
484
497
|
*/
|
|
485
498
|
export interface Target {
|
|
486
499
|
/**
|
|
487
|
-
* <p>Information about the contact channel Incident Manager
|
|
500
|
+
* <p>Information about the contact channel that Incident Manager engages.</p>
|
|
488
501
|
* @public
|
|
489
502
|
*/
|
|
490
503
|
ChannelTargetInfo?: ChannelTargetInfo | undefined;
|
|
491
504
|
/**
|
|
492
|
-
* <p>Information about the contact that Incident Manager
|
|
505
|
+
* <p>Information about the contact that Incident Manager engages.</p>
|
|
493
506
|
* @public
|
|
494
507
|
*/
|
|
495
508
|
ContactTargetInfo?: ContactTargetInfo | undefined;
|
|
@@ -565,8 +578,21 @@ export interface CreateContactRequest {
|
|
|
565
578
|
*/
|
|
566
579
|
DisplayName?: string | undefined;
|
|
567
580
|
/**
|
|
568
|
-
* <p>
|
|
569
|
-
*
|
|
581
|
+
* <p>The type of contact to create.</p>
|
|
582
|
+
* <ul>
|
|
583
|
+
* <li>
|
|
584
|
+
* <p>
|
|
585
|
+
* <code>PERSONAL</code>: A single, individual contact.</p>
|
|
586
|
+
* </li>
|
|
587
|
+
* <li>
|
|
588
|
+
* <p>
|
|
589
|
+
* <code>ESCALATION</code>: An escalation plan.</p>
|
|
590
|
+
* </li>
|
|
591
|
+
* <li>
|
|
592
|
+
* <p>
|
|
593
|
+
* <code>ONCALL_SCHEDULE</code>: An on-call schedule.</p>
|
|
594
|
+
* </li>
|
|
595
|
+
* </ul>
|
|
570
596
|
* @public
|
|
571
597
|
*/
|
|
572
598
|
Type: ContactType | undefined;
|
|
@@ -795,13 +821,14 @@ export interface RecurrenceSettings {
|
|
|
795
821
|
DailySettings?: HandOffTime[] | undefined;
|
|
796
822
|
/**
|
|
797
823
|
* <p>The number of contacts, or shift team members designated to be on call concurrently
|
|
798
|
-
* during a shift. For example, in an on-call schedule
|
|
824
|
+
* during a shift. For example, in an on-call schedule that contains ten contacts, a value of
|
|
799
825
|
* <code>2</code> designates that two of them are on call at any given time.</p>
|
|
800
826
|
* @public
|
|
801
827
|
*/
|
|
802
828
|
NumberOfOnCalls: number | undefined;
|
|
803
829
|
/**
|
|
804
|
-
* <p>Information about the days of the week
|
|
830
|
+
* <p>Information about the days of the week that the on-call rotation coverage
|
|
831
|
+
* includes.</p>
|
|
805
832
|
* @public
|
|
806
833
|
*/
|
|
807
834
|
ShiftCoverages?: Partial<Record<DayOfWeek, CoverageTime[]>> | undefined;
|
|
@@ -822,6 +849,11 @@ export interface CreateRotationRequest {
|
|
|
822
849
|
Name: string | undefined;
|
|
823
850
|
/**
|
|
824
851
|
* <p>The Amazon Resource Names (ARNs) of the contacts to add to the rotation.</p>
|
|
852
|
+
* <note>
|
|
853
|
+
* <p>Only the <code>PERSONAL</code> contact type is supported. The contact types
|
|
854
|
+
* <code>ESCALATION</code> and <code>ONCALL_SCHEDULE</code> are not supported for this
|
|
855
|
+
* operation. </p>
|
|
856
|
+
* </note>
|
|
825
857
|
* <p>The order that you list the contacts in is their shift order in the rotation schedule.
|
|
826
858
|
* To change the order of the contact's shifts, use the <a>UpdateRotation</a>
|
|
827
859
|
* operation.</p>
|
|
@@ -840,7 +872,7 @@ export interface CreateRotationRequest {
|
|
|
840
872
|
* Database</a> on the IANA website.</p>
|
|
841
873
|
* <note>
|
|
842
874
|
* <p>Designators for time zones that don’t support Daylight Savings Time rules, such as
|
|
843
|
-
* Pacific Standard Time (PST)
|
|
875
|
+
* Pacific Standard Time (PST), are not supported.</p>
|
|
844
876
|
* </note>
|
|
845
877
|
* @public
|
|
846
878
|
*/
|
|
@@ -1215,7 +1247,7 @@ export interface GetContactResult {
|
|
|
1215
1247
|
*/
|
|
1216
1248
|
DisplayName?: string | undefined;
|
|
1217
1249
|
/**
|
|
1218
|
-
* <p>The type of contact
|
|
1250
|
+
* <p>The type of contact.</p>
|
|
1219
1251
|
* @public
|
|
1220
1252
|
*/
|
|
1221
1253
|
Type: ContactType | undefined;
|
|
@@ -1454,8 +1486,7 @@ export interface ListContactsRequest {
|
|
|
1454
1486
|
*/
|
|
1455
1487
|
AliasPrefix?: string | undefined;
|
|
1456
1488
|
/**
|
|
1457
|
-
* <p>The type of contact
|
|
1458
|
-
* type <code>ESCALATION</code>.</p>
|
|
1489
|
+
* <p>The type of contact.</p>
|
|
1459
1490
|
* @public
|
|
1460
1491
|
*/
|
|
1461
1492
|
Type?: ContactType | undefined;
|
|
@@ -2146,7 +2177,8 @@ export interface ListRotationShiftsResult {
|
|
|
2146
2177
|
*/
|
|
2147
2178
|
export interface ListTagsForResourceRequest {
|
|
2148
2179
|
/**
|
|
2149
|
-
* <p>The Amazon Resource Name (ARN) of the contact
|
|
2180
|
+
* <p>The Amazon Resource Name (ARN) of the contact, escalation plan, rotation, or on-call
|
|
2181
|
+
* schedule.</p>
|
|
2150
2182
|
* @public
|
|
2151
2183
|
*/
|
|
2152
2184
|
ResourceARN: string | undefined;
|
|
@@ -2378,6 +2410,11 @@ export interface UpdateRotationRequest {
|
|
|
2378
2410
|
RotationId: string | undefined;
|
|
2379
2411
|
/**
|
|
2380
2412
|
* <p>The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation. </p>
|
|
2413
|
+
* <note>
|
|
2414
|
+
* <p>Only the <code>PERSONAL</code> contact type is supported. The contact types
|
|
2415
|
+
* <code>ESCALATION</code> and <code>ONCALL_SCHEDULE</code> are not supported for this
|
|
2416
|
+
* operation. </p>
|
|
2417
|
+
* </note>
|
|
2381
2418
|
* <p>The order in which you list the contacts is their shift order in the rotation
|
|
2382
2419
|
* schedule.</p>
|
|
2383
2420
|
* @public
|
|
@@ -2395,7 +2432,7 @@ export interface UpdateRotationRequest {
|
|
|
2395
2432
|
* Database</a> on the IANA website.</p>
|
|
2396
2433
|
* <note>
|
|
2397
2434
|
* <p>Designators for time zones that don’t support Daylight Savings Time Rules, such as
|
|
2398
|
-
* Pacific Standard Time (PST)
|
|
2435
|
+
* Pacific Standard Time (PST), aren't supported.</p>
|
|
2399
2436
|
* </note>
|
|
2400
2437
|
* @public
|
|
2401
2438
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-ssm-contacts",
|
|
3
3
|
"description": "AWS SDK for JavaScript Ssm Contacts Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.876.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-ssm-contacts",
|
|
@@ -20,17 +20,17 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/core": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
25
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
26
|
-
"@aws-sdk/middleware-logger": "3.
|
|
27
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
28
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
23
|
+
"@aws-sdk/core": "3.876.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.876.0",
|
|
25
|
+
"@aws-sdk/middleware-host-header": "3.873.0",
|
|
26
|
+
"@aws-sdk/middleware-logger": "3.876.0",
|
|
27
|
+
"@aws-sdk/middleware-recursion-detection": "3.873.0",
|
|
28
|
+
"@aws-sdk/middleware-user-agent": "3.876.0",
|
|
29
|
+
"@aws-sdk/region-config-resolver": "3.873.0",
|
|
30
30
|
"@aws-sdk/types": "3.862.0",
|
|
31
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
33
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
31
|
+
"@aws-sdk/util-endpoints": "3.873.0",
|
|
32
|
+
"@aws-sdk/util-user-agent-browser": "3.873.0",
|
|
33
|
+
"@aws-sdk/util-user-agent-node": "3.876.0",
|
|
34
34
|
"@smithy/config-resolver": "^4.1.5",
|
|
35
35
|
"@smithy/core": "^3.8.0",
|
|
36
36
|
"@smithy/fetch-http-handler": "^5.1.1",
|