@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.
Files changed (121) hide show
  1. package/README.md +101 -5
  2. package/dist-cjs/SSMContacts.js +180 -0
  3. package/dist-cjs/commands/CreateRotationCommand.js +45 -0
  4. package/dist-cjs/commands/CreateRotationOverrideCommand.js +45 -0
  5. package/dist-cjs/commands/DeleteRotationCommand.js +45 -0
  6. package/dist-cjs/commands/DeleteRotationOverrideCommand.js +45 -0
  7. package/dist-cjs/commands/GetRotationCommand.js +45 -0
  8. package/dist-cjs/commands/GetRotationOverrideCommand.js +45 -0
  9. package/dist-cjs/commands/ListPageResolutionsCommand.js +45 -0
  10. package/dist-cjs/commands/ListPreviewRotationShiftsCommand.js +45 -0
  11. package/dist-cjs/commands/ListRotationOverridesCommand.js +45 -0
  12. package/dist-cjs/commands/ListRotationShiftsCommand.js +45 -0
  13. package/dist-cjs/commands/ListRotationsCommand.js +45 -0
  14. package/dist-cjs/commands/UpdateRotationCommand.js +45 -0
  15. package/dist-cjs/commands/index.js +12 -0
  16. package/dist-cjs/endpoint/ruleset.js +3 -3
  17. package/dist-cjs/models/models_0.js +50 -42
  18. package/dist-cjs/pagination/ListPageResolutionsPaginator.js +28 -0
  19. package/dist-cjs/pagination/ListPreviewRotationShiftsPaginator.js +29 -0
  20. package/dist-cjs/pagination/ListRotationOverridesPaginator.js +29 -0
  21. package/dist-cjs/pagination/ListRotationShiftsPaginator.js +29 -0
  22. package/dist-cjs/pagination/ListRotationsPaginator.js +29 -0
  23. package/dist-cjs/pagination/index.js +5 -0
  24. package/dist-cjs/protocols/Aws_json1_1.js +1327 -107
  25. package/dist-es/SSMContacts.js +180 -0
  26. package/dist-es/commands/CreateRotationCommand.js +41 -0
  27. package/dist-es/commands/CreateRotationOverrideCommand.js +41 -0
  28. package/dist-es/commands/DeleteRotationCommand.js +41 -0
  29. package/dist-es/commands/DeleteRotationOverrideCommand.js +41 -0
  30. package/dist-es/commands/GetRotationCommand.js +41 -0
  31. package/dist-es/commands/GetRotationOverrideCommand.js +41 -0
  32. package/dist-es/commands/ListPageResolutionsCommand.js +41 -0
  33. package/dist-es/commands/ListPreviewRotationShiftsCommand.js +41 -0
  34. package/dist-es/commands/ListRotationOverridesCommand.js +41 -0
  35. package/dist-es/commands/ListRotationShiftsCommand.js +41 -0
  36. package/dist-es/commands/ListRotationsCommand.js +41 -0
  37. package/dist-es/commands/UpdateRotationCommand.js +41 -0
  38. package/dist-es/commands/index.js +12 -0
  39. package/dist-es/endpoint/ruleset.js +3 -3
  40. package/dist-es/models/models_0.js +49 -41
  41. package/dist-es/pagination/ListPageResolutionsPaginator.js +24 -0
  42. package/dist-es/pagination/ListPreviewRotationShiftsPaginator.js +25 -0
  43. package/dist-es/pagination/ListRotationOverridesPaginator.js +25 -0
  44. package/dist-es/pagination/ListRotationShiftsPaginator.js +25 -0
  45. package/dist-es/pagination/ListRotationsPaginator.js +25 -0
  46. package/dist-es/pagination/index.js +5 -0
  47. package/dist-es/protocols/Aws_json1_1.js +1306 -110
  48. package/dist-types/SSMContacts.d.ts +114 -10
  49. package/dist-types/SSMContactsClient.d.ts +19 -7
  50. package/dist-types/commands/AcceptPageCommand.d.ts +4 -18
  51. package/dist-types/commands/ActivateContactChannelCommand.d.ts +2 -15
  52. package/dist-types/commands/CreateContactChannelCommand.d.ts +4 -26
  53. package/dist-types/commands/CreateContactCommand.d.ts +16 -35
  54. package/dist-types/commands/CreateRotationCommand.d.ts +130 -0
  55. package/dist-types/commands/CreateRotationOverrideCommand.d.ts +88 -0
  56. package/dist-types/commands/DeactivateContactChannelCommand.d.ts +2 -14
  57. package/dist-types/commands/DeleteContactChannelCommand.d.ts +2 -14
  58. package/dist-types/commands/DeleteContactCommand.d.ts +5 -14
  59. package/dist-types/commands/DeleteRotationCommand.d.ts +83 -0
  60. package/dist-types/commands/DeleteRotationOverrideCommand.d.ts +80 -0
  61. package/dist-types/commands/DescribeEngagementCommand.d.ts +2 -26
  62. package/dist-types/commands/DescribePageCommand.d.ts +2 -29
  63. package/dist-types/commands/GetContactChannelCommand.d.ts +2 -26
  64. package/dist-types/commands/GetContactCommand.d.ts +2 -115
  65. package/dist-types/commands/GetContactPolicyCommand.d.ts +2 -20
  66. package/dist-types/commands/GetRotationCommand.d.ts +79 -0
  67. package/dist-types/commands/GetRotationOverrideCommand.d.ts +80 -0
  68. package/dist-types/commands/ListContactChannelsCommand.d.ts +2 -30
  69. package/dist-types/commands/ListContactsCommand.d.ts +3 -43
  70. package/dist-types/commands/ListEngagementsCommand.d.ts +3 -43
  71. package/dist-types/commands/ListPageReceiptsCommand.d.ts +3 -39
  72. package/dist-types/commands/ListPageResolutionsCommand.d.ts +84 -0
  73. package/dist-types/commands/ListPagesByContactCommand.d.ts +2 -29
  74. package/dist-types/commands/ListPagesByEngagementCommand.d.ts +2 -27
  75. package/dist-types/commands/ListPreviewRotationShiftsCommand.d.ts +132 -0
  76. package/dist-types/commands/ListRotationOverridesCommand.d.ts +83 -0
  77. package/dist-types/commands/ListRotationShiftsCommand.d.ts +86 -0
  78. package/dist-types/commands/ListRotationsCommand.d.ts +81 -0
  79. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -24
  80. package/dist-types/commands/PutContactPolicyCommand.d.ts +2 -15
  81. package/dist-types/commands/SendActivationCodeCommand.d.ts +2 -14
  82. package/dist-types/commands/StartEngagementCommand.d.ts +2 -45
  83. package/dist-types/commands/StopEngagementCommand.d.ts +2 -14
  84. package/dist-types/commands/TagResourceCommand.d.ts +5 -23
  85. package/dist-types/commands/UntagResourceCommand.d.ts +4 -19
  86. package/dist-types/commands/UpdateContactChannelCommand.d.ts +3 -19
  87. package/dist-types/commands/UpdateContactCommand.d.ts +13 -59
  88. package/dist-types/commands/UpdateRotationCommand.d.ts +123 -0
  89. package/dist-types/commands/index.d.ts +12 -0
  90. package/dist-types/models/models_0.d.ts +835 -58
  91. package/dist-types/pagination/ListPageResolutionsPaginator.d.ts +7 -0
  92. package/dist-types/pagination/ListPreviewRotationShiftsPaginator.d.ts +7 -0
  93. package/dist-types/pagination/ListRotationOverridesPaginator.d.ts +7 -0
  94. package/dist-types/pagination/ListRotationShiftsPaginator.d.ts +7 -0
  95. package/dist-types/pagination/ListRotationsPaginator.d.ts +7 -0
  96. package/dist-types/pagination/index.d.ts +5 -0
  97. package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
  98. package/dist-types/ts3.4/SSMContacts.d.ts +204 -0
  99. package/dist-types/ts3.4/SSMContactsClient.d.ts +74 -2
  100. package/dist-types/ts3.4/commands/CreateRotationCommand.d.ts +37 -0
  101. package/dist-types/ts3.4/commands/CreateRotationOverrideCommand.d.ts +41 -0
  102. package/dist-types/ts3.4/commands/DeleteRotationCommand.d.ts +37 -0
  103. package/dist-types/ts3.4/commands/DeleteRotationOverrideCommand.d.ts +41 -0
  104. package/dist-types/ts3.4/commands/GetRotationCommand.d.ts +34 -0
  105. package/dist-types/ts3.4/commands/GetRotationOverrideCommand.d.ts +38 -0
  106. package/dist-types/ts3.4/commands/ListPageResolutionsCommand.d.ts +38 -0
  107. package/dist-types/ts3.4/commands/ListPreviewRotationShiftsCommand.d.ts +41 -0
  108. package/dist-types/ts3.4/commands/ListRotationOverridesCommand.d.ts +41 -0
  109. package/dist-types/ts3.4/commands/ListRotationShiftsCommand.d.ts +38 -0
  110. package/dist-types/ts3.4/commands/ListRotationsCommand.d.ts +34 -0
  111. package/dist-types/ts3.4/commands/UpdateRotationCommand.d.ts +37 -0
  112. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  113. package/dist-types/ts3.4/models/models_0.d.ts +241 -34
  114. package/dist-types/ts3.4/pagination/ListPageResolutionsPaginator.d.ts +11 -0
  115. package/dist-types/ts3.4/pagination/ListPreviewRotationShiftsPaginator.d.ts +11 -0
  116. package/dist-types/ts3.4/pagination/ListRotationOverridesPaginator.d.ts +11 -0
  117. package/dist-types/ts3.4/pagination/ListRotationShiftsPaginator.d.ts +11 -0
  118. package/dist-types/ts3.4/pagination/ListRotationsPaginator.d.ts +11 -0
  119. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  120. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +144 -0
  121. package/package.json +34 -34
@@ -28,7 +28,7 @@ export interface SendActivationCodeCommandOutput extends SendActivationCodeResul
28
28
  * import { SSMContactsClient, SendActivationCodeCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
29
29
  * // const { SSMContactsClient, SendActivationCodeCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
30
30
  * const client = new SSMContactsClient(config);
31
- * const input = {
31
+ * const input = { // SendActivationCodeRequest
32
32
  * ContactChannelId: "STRING_VALUE", // required
33
33
  * };
34
34
  * const command = new SendActivationCodeCommand(input);
@@ -48,8 +48,7 @@ export interface SendActivationCodeCommandOutput extends SendActivationCodeResul
48
48
  * <p>The operation failed to due an encryption key error.</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>
@@ -65,17 +64,6 @@ export interface SendActivationCodeCommandOutput extends SendActivationCodeResul
65
64
  * service.</p>
66
65
  *
67
66
  *
68
- * @example To send an activation code
69
- * ```javascript
70
- * // The following send-activation-code example sends an activation code and message to the specified contact channel.
71
- * const input = {
72
- * "ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400"
73
- * };
74
- * const command = new SendActivationCodeCommand(input);
75
- * await client.send(command);
76
- * // example id: to-send-an-activation-code-1630436453574
77
- * ```
78
- *
79
67
  */
80
68
  export declare class SendActivationCodeCommand extends $Command<SendActivationCodeCommandInput, SendActivationCodeCommandOutput, SSMContactsClientResolvedConfig> {
81
69
  readonly input: SendActivationCodeCommandInput;
@@ -27,7 +27,7 @@ export interface StartEngagementCommandOutput extends StartEngagementResult, __M
27
27
  * import { SSMContactsClient, StartEngagementCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
28
28
  * // const { SSMContactsClient, StartEngagementCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
29
29
  * const client = new SSMContactsClient(config);
30
- * const input = {
30
+ * const input = { // StartEngagementRequest
31
31
  * ContactId: "STRING_VALUE", // required
32
32
  * Sender: "STRING_VALUE", // required
33
33
  * Subject: "STRING_VALUE", // required
@@ -54,8 +54,7 @@ export interface StartEngagementCommandOutput extends StartEngagementResult, __M
54
54
  * <p>The operation failed to due an encryption key error.</p>
55
55
  *
56
56
  * @throws {@link InternalServerException} (server fault)
57
- * <p>Unexpected error occurred while
58
- * processing the request.</p>
57
+ * <p>Unexpected error occurred while processing the request.</p>
59
58
  *
60
59
  * @throws {@link ResourceNotFoundException} (client fault)
61
60
  * <p>Request references a resource that doesn't exist.</p>
@@ -68,48 +67,6 @@ export interface StartEngagementCommandOutput extends StartEngagementResult, __M
68
67
  * service.</p>
69
68
  *
70
69
  *
71
- * @example Example 1: To page a contact's contact channels
72
- * ```javascript
73
- * // The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels. Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to track who started the engagement.
74
- * const input = {
75
- * "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
76
- * "Content": "Testing engagements",
77
- * "PublicContent": "Testing engagements",
78
- * "PublicSubject": "test",
79
- * "Sender": "tester",
80
- * "Subject": "test"
81
- * };
82
- * const command = new StartEngagementCommand(input);
83
- * const response = await client.send(command);
84
- * /* response ==
85
- * {
86
- * "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f"
87
- * }
88
- * *\/
89
- * // example id: example-1-to-page-a-contacts-contact-channels-1630436634872
90
- * ```
91
- *
92
- * @example Example 2: To page a contact in the provided escalation plan.
93
- * ```javascript
94
- * // The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their engagement plan.
95
- * const input = {
96
- * "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
97
- * "Content": "Testing engagements",
98
- * "PublicContent": "Testing engagements",
99
- * "PublicSubject": "test",
100
- * "Sender": "tester",
101
- * "Subject": "test"
102
- * };
103
- * const command = new StartEngagementCommand(input);
104
- * const response = await client.send(command);
105
- * /* response ==
106
- * {
107
- * "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
108
- * }
109
- * *\/
110
- * // example id: example-2-to-page-a-contact-in-the-provided-escalation-plan-1630436808480
111
- * ```
112
- *
113
70
  */
114
71
  export declare class StartEngagementCommand extends $Command<StartEngagementCommandInput, StartEngagementCommandOutput, SSMContactsClientResolvedConfig> {
115
72
  readonly input: StartEngagementCommandInput;
@@ -27,7 +27,7 @@ export interface StopEngagementCommandOutput extends StopEngagementResult, __Met
27
27
  * import { SSMContactsClient, StopEngagementCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
28
28
  * // const { SSMContactsClient, StopEngagementCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
29
29
  * const client = new SSMContactsClient(config);
30
- * const input = {
30
+ * const input = { // StopEngagementRequest
31
31
  * EngagementId: "STRING_VALUE", // required
32
32
  * Reason: "STRING_VALUE",
33
33
  * };
@@ -45,8 +45,7 @@ export interface StopEngagementCommandOutput extends StopEngagementResult, __Met
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,17 +58,6 @@ export interface StopEngagementCommandOutput extends StopEngagementResult, __Met
59
58
  * service.</p>
60
59
  *
61
60
  *
62
- * @example To stop an engagement
63
- * ```javascript
64
- * // The following stop-engagement example stops an engagement from paging further contacts and contact channels.
65
- * const input = {
66
- * "EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
67
- * };
68
- * const command = new StopEngagementCommand(input);
69
- * await client.send(command);
70
- * // example id: to-stop-an-engagement-1630436882864
71
- * ```
72
- *
73
61
  */
74
62
  export declare class StopEngagementCommand extends $Command<StopEngagementCommandInput, StopEngagementCommandOutput, SSMContactsClientResolvedConfig> {
75
63
  readonly input: StopEngagementCommandInput;
@@ -20,17 +20,17 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
20
20
  /**
21
21
  * @public
22
22
  * <p>Tags a contact or escalation plan. You can tag only contacts and escalation plans in the
23
- * first region of your replication set. </p>
23
+ * first region of your replication set.</p>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
26
26
  * ```javascript
27
27
  * import { SSMContactsClient, TagResourceCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
28
28
  * // const { SSMContactsClient, TagResourceCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
29
29
  * const client = new SSMContactsClient(config);
30
- * const input = {
30
+ * const input = { // TagResourceRequest
31
31
  * ResourceARN: "STRING_VALUE", // required
32
- * Tags: [ // required
33
- * {
32
+ * Tags: [ // TagsList // required
33
+ * { // Tag
34
34
  * Key: "STRING_VALUE",
35
35
  * Value: "STRING_VALUE",
36
36
  * },
@@ -50,8 +50,7 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
50
50
  * <p>You don't have sufficient access to perform this operation.</p>
51
51
  *
52
52
  * @throws {@link InternalServerException} (server fault)
53
- * <p>Unexpected error occurred while
54
- * processing the request.</p>
53
+ * <p>Unexpected error occurred while processing the request.</p>
55
54
  *
56
55
  * @throws {@link ResourceNotFoundException} (client fault)
57
56
  * <p>Request references a resource that doesn't exist.</p>
@@ -67,23 +66,6 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
67
66
  * service.</p>
68
67
  *
69
68
  *
70
- * @example To tag a contact
71
- * ```javascript
72
- * // The following tag-resource example tags a specified contact with the provided tag key value pair.
73
- * const input = {
74
- * "ResourceARN": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
75
- * "Tags": [
76
- * {
77
- * "Key": "group1",
78
- * "Value": "1"
79
- * }
80
- * ]
81
- * };
82
- * const command = new TagResourceCommand(input);
83
- * await client.send(command);
84
- * // example id: to-tag-a-contact-1630437124572
85
- * ```
86
- *
87
69
  */
88
70
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SSMContactsClientResolvedConfig> {
89
71
  readonly input: TagResourceCommandInput;
@@ -19,16 +19,16 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Removes tags from the specified resource. </p>
22
+ * <p>Removes tags from the specified resource.</p>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
25
25
  * ```javascript
26
26
  * import { SSMContactsClient, UntagResourceCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
27
27
  * // const { SSMContactsClient, UntagResourceCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
28
28
  * const client = new SSMContactsClient(config);
29
- * const input = {
29
+ * const input = { // UntagResourceRequest
30
30
  * ResourceARN: "STRING_VALUE", // required
31
- * TagKeys: [ // required
31
+ * TagKeys: [ // TagKeyList // required
32
32
  * "STRING_VALUE",
33
33
  * ],
34
34
  * };
@@ -46,8 +46,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
46
46
  * <p>You don't have sufficient access to perform this operation.</p>
47
47
  *
48
48
  * @throws {@link InternalServerException} (server fault)
49
- * <p>Unexpected error occurred while
50
- * processing the request.</p>
49
+ * <p>Unexpected error occurred while processing the request.</p>
51
50
  *
52
51
  * @throws {@link ResourceNotFoundException} (client fault)
53
52
  * <p>Request references a resource that doesn't exist.</p>
@@ -60,20 +59,6 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
60
59
  * service.</p>
61
60
  *
62
61
  *
63
- * @example To remove tags from a contact
64
- * ```javascript
65
- * // The following untag-resource example removes the group1 tag from the specified contact.
66
- * const input = {
67
- * "ResourceARN": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
68
- * "TagKeys": [
69
- * "group1"
70
- * ]
71
- * };
72
- * const command = new UntagResourceCommand(input);
73
- * await client.send(command);
74
- * // example id: to-remove-tags-from-a-contact-1630437251110
75
- * ```
76
- *
77
62
  */
78
63
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SSMContactsClientResolvedConfig> {
79
64
  readonly input: UntagResourceCommandInput;
@@ -26,10 +26,10 @@ export interface UpdateContactChannelCommandOutput extends UpdateContactChannelR
26
26
  * import { SSMContactsClient, UpdateContactChannelCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
27
27
  * // const { SSMContactsClient, UpdateContactChannelCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
28
28
  * const client = new SSMContactsClient(config);
29
- * const input = {
29
+ * const input = { // UpdateContactChannelRequest
30
30
  * ContactChannelId: "STRING_VALUE", // required
31
31
  * Name: "STRING_VALUE",
32
- * DeliveryAddress: {
32
+ * DeliveryAddress: { // ContactChannelAddress
33
33
  * SimpleAddress: "STRING_VALUE",
34
34
  * },
35
35
  * };
@@ -53,8 +53,7 @@ export interface UpdateContactChannelCommandOutput extends UpdateContactChannelR
53
53
  * <p>The operation failed to due an encryption key error.</p>
54
54
  *
55
55
  * @throws {@link InternalServerException} (server fault)
56
- * <p>Unexpected error occurred while
57
- * processing the request.</p>
56
+ * <p>Unexpected error occurred while processing the request.</p>
58
57
  *
59
58
  * @throws {@link ResourceNotFoundException} (client fault)
60
59
  * <p>Request references a resource that doesn't exist.</p>
@@ -67,21 +66,6 @@ export interface UpdateContactChannelCommandOutput extends UpdateContactChannelR
67
66
  * service.</p>
68
67
  *
69
68
  *
70
- * @example To update a contact channel
71
- * ```javascript
72
- * // The following update-contact-channel example updates the name and delivery address of a contact channel.
73
- * const input = {
74
- * "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
75
- * "DeliveryAddress": {
76
- * "SimpleAddress": "+15005550198"
77
- * },
78
- * "Name": "akuas voice channel"
79
- * };
80
- * const command = new UpdateContactChannelCommand(input);
81
- * await client.send(command);
82
- * // example id: to-update-a-contact-channel-1630437610256
83
- * ```
84
- *
85
69
  */
86
70
  export declare class UpdateContactChannelCommand extends $Command<UpdateContactChannelCommandInput, UpdateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
87
71
  readonly input: UpdateContactChannelCommandInput;
@@ -19,27 +19,27 @@ export interface UpdateContactCommandOutput extends UpdateContactResult, __Metad
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Updates the contact or escalation plan specified. </p>
22
+ * <p>Updates the contact or escalation plan specified.</p>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
25
25
  * ```javascript
26
26
  * import { SSMContactsClient, UpdateContactCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
27
27
  * // const { SSMContactsClient, UpdateContactCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
28
28
  * const client = new SSMContactsClient(config);
29
- * const input = {
29
+ * const input = { // UpdateContactRequest
30
30
  * ContactId: "STRING_VALUE", // required
31
31
  * DisplayName: "STRING_VALUE",
32
- * Plan: {
33
- * Stages: [ // required
34
- * {
32
+ * Plan: { // Plan
33
+ * Stages: [ // StagesList
34
+ * { // Stage
35
35
  * DurationInMinutes: Number("int"), // required
36
- * Targets: [ // required
37
- * {
38
- * ChannelTargetInfo: {
36
+ * Targets: [ // TargetsList // required
37
+ * { // Target
38
+ * ChannelTargetInfo: { // ChannelTargetInfo
39
39
  * ContactChannelId: "STRING_VALUE", // required
40
40
  * RetryIntervalInMinutes: Number("int"),
41
41
  * },
42
- * ContactTargetInfo: {
42
+ * ContactTargetInfo: { // ContactTargetInfo
43
43
  * ContactId: "STRING_VALUE",
44
44
  * IsEssential: true || false, // required
45
45
  * },
@@ -47,6 +47,9 @@ export interface UpdateContactCommandOutput extends UpdateContactResult, __Metad
47
47
  * ],
48
48
  * },
49
49
  * ],
50
+ * RotationIds: [ // SsmContactsArnList
51
+ * "STRING_VALUE",
52
+ * ],
50
53
  * },
51
54
  * };
52
55
  * const command = new UpdateContactCommand(input);
@@ -66,8 +69,7 @@ export interface UpdateContactCommandOutput extends UpdateContactResult, __Metad
66
69
  * <p>The operation failed to due an encryption key error.</p>
67
70
  *
68
71
  * @throws {@link InternalServerException} (server fault)
69
- * <p>Unexpected error occurred while
70
- * processing the request.</p>
72
+ * <p>Unexpected error occurred while processing the request.</p>
71
73
  *
72
74
  * @throws {@link ResourceNotFoundException} (client fault)
73
75
  * <p>Request references a resource that doesn't exist.</p>
@@ -83,54 +85,6 @@ export interface UpdateContactCommandOutput extends UpdateContactResult, __Metad
83
85
  * service.</p>
84
86
  *
85
87
  *
86
- * @example To update the engagement plan of contact
87
- * ```javascript
88
- * // The following update-contact example updates the engagement plan of the contact Akua to include the three types of contacts channels. This is done after creating contact channels for Akua.
89
- * const input = {
90
- * "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
91
- * "Plan": {
92
- * "Stages": [
93
- * {
94
- * "DurationInMinutes": 5,
95
- * "Targets": [
96
- * {
97
- * "ChannelTargetInfo": {
98
- * "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
99
- * "RetryIntervalInMinutes": 1
100
- * }
101
- * }
102
- * ]
103
- * },
104
- * {
105
- * "DurationInMinutes": 5,
106
- * "Targets": [
107
- * {
108
- * "ChannelTargetInfo": {
109
- * "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
110
- * "RetryIntervalInMinutes": 1
111
- * }
112
- * }
113
- * ]
114
- * },
115
- * {
116
- * "DurationInMinutes": 5,
117
- * "Targets": [
118
- * {
119
- * "ChannelTargetInfo": {
120
- * "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
121
- * "RetryIntervalInMinutes": 1
122
- * }
123
- * }
124
- * ]
125
- * }
126
- * ]
127
- * }
128
- * };
129
- * const command = new UpdateContactCommand(input);
130
- * await client.send(command);
131
- * // example id: to-update-the-engagement-plan-of-contact-1630437436599
132
- * ```
133
- *
134
88
  */
135
89
  export declare class UpdateContactCommand extends $Command<UpdateContactCommandInput, UpdateContactCommandOutput, SSMContactsClientResolvedConfig> {
136
90
  readonly input: UpdateContactCommandInput;
@@ -0,0 +1,123 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { UpdateRotationRequest, UpdateRotationResult } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link UpdateRotationCommand}.
10
+ */
11
+ export interface UpdateRotationCommandInput extends UpdateRotationRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link UpdateRotationCommand}.
17
+ */
18
+ export interface UpdateRotationCommandOutput extends UpdateRotationResult, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Updates the information specified for an on-call rotation.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { SSMContactsClient, UpdateRotationCommand } from "@aws-sdk/client-ssm-contacts"; // ES Modules import
27
+ * // const { SSMContactsClient, UpdateRotationCommand } = require("@aws-sdk/client-ssm-contacts"); // CommonJS import
28
+ * const client = new SSMContactsClient(config);
29
+ * const input = { // UpdateRotationRequest
30
+ * RotationId: "STRING_VALUE", // required
31
+ * ContactIds: [ // RotationContactsArnList
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * StartTime: new Date("TIMESTAMP"),
35
+ * TimeZoneId: "STRING_VALUE",
36
+ * Recurrence: { // RecurrenceSettings
37
+ * MonthlySettings: [ // MonthlySettings
38
+ * { // MonthlySetting
39
+ * DayOfMonth: Number("int"), // required
40
+ * HandOffTime: { // HandOffTime
41
+ * HourOfDay: Number("int"), // required
42
+ * MinuteOfHour: Number("int"), // required
43
+ * },
44
+ * },
45
+ * ],
46
+ * WeeklySettings: [ // WeeklySettings
47
+ * { // WeeklySetting
48
+ * DayOfWeek: "MON" || "TUE" || "WED" || "THU" || "FRI" || "SAT" || "SUN", // required
49
+ * HandOffTime: {
50
+ * HourOfDay: Number("int"), // required
51
+ * MinuteOfHour: Number("int"), // required
52
+ * },
53
+ * },
54
+ * ],
55
+ * DailySettings: [ // DailySettings
56
+ * {
57
+ * HourOfDay: Number("int"), // required
58
+ * MinuteOfHour: Number("int"), // required
59
+ * },
60
+ * ],
61
+ * NumberOfOnCalls: Number("int"), // required
62
+ * ShiftCoverages: { // ShiftCoveragesMap
63
+ * "<keys>": [ // CoverageTimes
64
+ * { // CoverageTime
65
+ * Start: "<HandOffTime>",
66
+ * End: "<HandOffTime>",
67
+ * },
68
+ * ],
69
+ * },
70
+ * RecurrenceMultiplier: Number("int"), // required
71
+ * },
72
+ * };
73
+ * const command = new UpdateRotationCommand(input);
74
+ * const response = await client.send(command);
75
+ * ```
76
+ *
77
+ * @param UpdateRotationCommandInput - {@link UpdateRotationCommandInput}
78
+ * @returns {@link UpdateRotationCommandOutput}
79
+ * @see {@link UpdateRotationCommandInput} for command's `input` shape.
80
+ * @see {@link UpdateRotationCommandOutput} for command's `response` shape.
81
+ * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
82
+ *
83
+ * @throws {@link AccessDeniedException} (client fault)
84
+ * <p>You don't have sufficient access to perform this operation.</p>
85
+ *
86
+ * @throws {@link ConflictException} (client fault)
87
+ * <p>Updating or deleting a resource causes an inconsistent state.</p>
88
+ *
89
+ * @throws {@link InternalServerException} (server fault)
90
+ * <p>Unexpected error occurred while processing the request.</p>
91
+ *
92
+ * @throws {@link ResourceNotFoundException} (client fault)
93
+ * <p>Request references a resource that doesn't exist.</p>
94
+ *
95
+ * @throws {@link ThrottlingException} (client fault)
96
+ * <p>The request was denied due to request throttling.</p>
97
+ *
98
+ * @throws {@link ValidationException} (client fault)
99
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
100
+ * service.</p>
101
+ *
102
+ *
103
+ */
104
+ export declare class UpdateRotationCommand extends $Command<UpdateRotationCommandInput, UpdateRotationCommandOutput, SSMContactsClientResolvedConfig> {
105
+ readonly input: UpdateRotationCommandInput;
106
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
107
+ /**
108
+ * @public
109
+ */
110
+ constructor(input: UpdateRotationCommandInput);
111
+ /**
112
+ * @internal
113
+ */
114
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRotationCommandInput, UpdateRotationCommandOutput>;
115
+ /**
116
+ * @internal
117
+ */
118
+ private serialize;
119
+ /**
120
+ * @internal
121
+ */
122
+ private deserialize;
123
+ }
@@ -2,20 +2,31 @@ export * from "./AcceptPageCommand";
2
2
  export * from "./ActivateContactChannelCommand";
3
3
  export * from "./CreateContactChannelCommand";
4
4
  export * from "./CreateContactCommand";
5
+ export * from "./CreateRotationCommand";
6
+ export * from "./CreateRotationOverrideCommand";
5
7
  export * from "./DeactivateContactChannelCommand";
6
8
  export * from "./DeleteContactChannelCommand";
7
9
  export * from "./DeleteContactCommand";
10
+ export * from "./DeleteRotationCommand";
11
+ export * from "./DeleteRotationOverrideCommand";
8
12
  export * from "./DescribeEngagementCommand";
9
13
  export * from "./DescribePageCommand";
10
14
  export * from "./GetContactChannelCommand";
11
15
  export * from "./GetContactCommand";
12
16
  export * from "./GetContactPolicyCommand";
17
+ export * from "./GetRotationCommand";
18
+ export * from "./GetRotationOverrideCommand";
13
19
  export * from "./ListContactChannelsCommand";
14
20
  export * from "./ListContactsCommand";
15
21
  export * from "./ListEngagementsCommand";
16
22
  export * from "./ListPageReceiptsCommand";
23
+ export * from "./ListPageResolutionsCommand";
17
24
  export * from "./ListPagesByContactCommand";
18
25
  export * from "./ListPagesByEngagementCommand";
26
+ export * from "./ListPreviewRotationShiftsCommand";
27
+ export * from "./ListRotationOverridesCommand";
28
+ export * from "./ListRotationShiftsCommand";
29
+ export * from "./ListRotationsCommand";
19
30
  export * from "./ListTagsForResourceCommand";
20
31
  export * from "./PutContactPolicyCommand";
21
32
  export * from "./SendActivationCodeCommand";
@@ -25,3 +36,4 @@ export * from "./TagResourceCommand";
25
36
  export * from "./UntagResourceCommand";
26
37
  export * from "./UpdateContactChannelCommand";
27
38
  export * from "./UpdateContactCommand";
39
+ export * from "./UpdateRotationCommand";