@aws-sdk/client-ssm-contacts 3.321.1 → 3.326.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 (40) hide show
  1. package/dist-types/commands/AcceptPageCommand.d.ts +4 -0
  2. package/dist-types/commands/ActivateContactChannelCommand.d.ts +4 -0
  3. package/dist-types/commands/CreateContactChannelCommand.d.ts +6 -0
  4. package/dist-types/commands/CreateContactCommand.d.ts +6 -0
  5. package/dist-types/commands/CreateRotationCommand.d.ts +6 -0
  6. package/dist-types/commands/CreateRotationOverrideCommand.d.ts +6 -0
  7. package/dist-types/commands/DeactivateContactChannelCommand.d.ts +4 -0
  8. package/dist-types/commands/DeleteContactChannelCommand.d.ts +4 -0
  9. package/dist-types/commands/DeleteContactCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteRotationCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteRotationOverrideCommand.d.ts +4 -0
  12. package/dist-types/commands/DescribeEngagementCommand.d.ts +15 -0
  13. package/dist-types/commands/DescribePageCommand.d.ts +17 -0
  14. package/dist-types/commands/GetContactChannelCommand.d.ts +13 -0
  15. package/dist-types/commands/GetContactCommand.d.ts +31 -0
  16. package/dist-types/commands/GetContactPolicyCommand.d.ts +7 -0
  17. package/dist-types/commands/GetRotationCommand.d.ts +48 -0
  18. package/dist-types/commands/GetRotationOverrideCommand.d.ts +13 -0
  19. package/dist-types/commands/ListContactChannelsCommand.d.ts +18 -0
  20. package/dist-types/commands/ListContactsCommand.d.ts +14 -0
  21. package/dist-types/commands/ListEngagementsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListPageReceiptsCommand.d.ts +14 -0
  23. package/dist-types/commands/ListPageResolutionsCommand.d.ts +13 -0
  24. package/dist-types/commands/ListPagesByContactCommand.d.ts +18 -0
  25. package/dist-types/commands/ListPagesByEngagementCommand.d.ts +18 -0
  26. package/dist-types/commands/ListPreviewRotationShiftsCommand.d.ts +21 -0
  27. package/dist-types/commands/ListRotationOverridesCommand.d.ts +17 -0
  28. package/dist-types/commands/ListRotationShiftsCommand.d.ts +21 -0
  29. package/dist-types/commands/ListRotationsCommand.d.ts +53 -0
  30. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  31. package/dist-types/commands/PutContactPolicyCommand.d.ts +4 -0
  32. package/dist-types/commands/SendActivationCodeCommand.d.ts +4 -0
  33. package/dist-types/commands/StartEngagementCommand.d.ts +6 -0
  34. package/dist-types/commands/StopEngagementCommand.d.ts +4 -0
  35. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  36. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  37. package/dist-types/commands/UpdateContactChannelCommand.d.ts +4 -0
  38. package/dist-types/commands/UpdateContactCommand.d.ts +4 -0
  39. package/dist-types/commands/UpdateRotationCommand.d.ts +4 -0
  40. package/package.json +16 -16
@@ -36,6 +36,8 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
36
36
  * };
37
37
  * const command = new AcceptPageCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param AcceptPageCommandInput - {@link AcceptPageCommandInput}
@@ -60,6 +62,8 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
60
62
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
61
63
  * service.</p>
62
64
  *
65
+ * @throws {@link SSMContactsServiceException}
66
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
63
67
  *
64
68
  */
65
69
  export declare class AcceptPageCommand extends $Command<AcceptPageCommandInput, AcceptPageCommandOutput, SSMContactsClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
33
33
  * };
34
34
  * const command = new ActivateContactChannelCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param ActivateContactChannelCommandInput - {@link ActivateContactChannelCommandInput}
@@ -57,6 +59,8 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
57
59
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
58
60
  * service.</p>
59
61
  *
62
+ * @throws {@link SSMContactsServiceException}
63
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
60
64
  *
61
65
  */
62
66
  export declare class ActivateContactChannelCommand extends $Command<ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
@@ -38,6 +38,10 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
38
38
  * };
39
39
  * const command = new CreateContactChannelCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // CreateContactChannelResult
42
+ * // ContactChannelArn: "STRING_VALUE", // required
43
+ * // };
44
+ *
41
45
  * ```
42
46
  *
43
47
  * @param CreateContactChannelCommandInput - {@link CreateContactChannelCommandInput}
@@ -65,6 +69,8 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
65
69
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
66
70
  * service.</p>
67
71
  *
72
+ * @throws {@link SSMContactsServiceException}
73
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
68
74
  *
69
75
  */
70
76
  export declare class CreateContactChannelCommand extends $Command<CreateContactChannelCommandInput, CreateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
@@ -64,6 +64,10 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
64
64
  * };
65
65
  * const command = new CreateContactCommand(input);
66
66
  * const response = await client.send(command);
67
+ * // { // CreateContactResult
68
+ * // ContactArn: "STRING_VALUE", // required
69
+ * // };
70
+ *
67
71
  * ```
68
72
  *
69
73
  * @param CreateContactCommandInput - {@link CreateContactCommandInput}
@@ -94,6 +98,8 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
94
98
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
95
99
  * service.</p>
96
100
  *
101
+ * @throws {@link SSMContactsServiceException}
102
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
97
103
  *
98
104
  */
99
105
  export declare class CreateContactCommand extends $Command<CreateContactCommandInput, CreateContactCommandOutput, SSMContactsClientResolvedConfig> {
@@ -79,6 +79,10 @@ export interface CreateRotationCommandOutput extends CreateRotationResult, __Met
79
79
  * };
80
80
  * const command = new CreateRotationCommand(input);
81
81
  * const response = await client.send(command);
82
+ * // { // CreateRotationResult
83
+ * // RotationArn: "STRING_VALUE", // required
84
+ * // };
85
+ *
82
86
  * ```
83
87
  *
84
88
  * @param CreateRotationCommandInput - {@link CreateRotationCommandInput}
@@ -106,6 +110,8 @@ export interface CreateRotationCommandOutput extends CreateRotationResult, __Met
106
110
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
107
111
  * service.</p>
108
112
  *
113
+ * @throws {@link SSMContactsServiceException}
114
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
109
115
  *
110
116
  */
111
117
  export declare class CreateRotationCommand extends $Command<CreateRotationCommandInput, CreateRotationCommandOutput, SSMContactsClientResolvedConfig> {
@@ -37,6 +37,10 @@ export interface CreateRotationOverrideCommandOutput extends CreateRotationOverr
37
37
  * };
38
38
  * const command = new CreateRotationOverrideCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // CreateRotationOverrideResult
41
+ * // RotationOverrideId: "STRING_VALUE", // required
42
+ * // };
43
+ *
40
44
  * ```
41
45
  *
42
46
  * @param CreateRotationOverrideCommandInput - {@link CreateRotationOverrideCommandInput}
@@ -64,6 +68,8 @@ export interface CreateRotationOverrideCommandOutput extends CreateRotationOverr
64
68
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
65
69
  * service.</p>
66
70
  *
71
+ * @throws {@link SSMContactsServiceException}
72
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
67
73
  *
68
74
  */
69
75
  export declare class CreateRotationOverrideCommand extends $Command<CreateRotationOverrideCommandInput, CreateRotationOverrideCommandOutput, SSMContactsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeactivateContactChannelCommandOutput extends DeactivateContact
32
32
  * };
33
33
  * const command = new DeactivateContactChannelCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeactivateContactChannelCommandInput - {@link DeactivateContactChannelCommandInput}
@@ -56,6 +58,8 @@ export interface DeactivateContactChannelCommandOutput extends DeactivateContact
56
58
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
57
59
  * service.</p>
58
60
  *
61
+ * @throws {@link SSMContactsServiceException}
62
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
59
63
  *
60
64
  */
61
65
  export declare class DeactivateContactChannelCommand extends $Command<DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteContactChannelCommandOutput extends DeleteContactChannelR
34
34
  * };
35
35
  * const command = new DeleteContactChannelCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteContactChannelCommandInput - {@link DeleteContactChannelCommandInput}
@@ -58,6 +60,8 @@ export interface DeleteContactChannelCommandOutput extends DeleteContactChannelR
58
60
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
59
61
  * service.</p>
60
62
  *
63
+ * @throws {@link SSMContactsServiceException}
64
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
61
65
  *
62
66
  */
63
67
  export declare class DeleteContactChannelCommand extends $Command<DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteContactCommandOutput extends DeleteContactResult, __Metad
34
34
  * };
35
35
  * const command = new DeleteContactCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteContactCommandInput - {@link DeleteContactCommandInput}
@@ -61,6 +63,8 @@ export interface DeleteContactCommandOutput extends DeleteContactResult, __Metad
61
63
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
62
64
  * service.</p>
63
65
  *
66
+ * @throws {@link SSMContactsServiceException}
67
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
64
68
  *
65
69
  */
66
70
  export declare class DeleteContactCommand extends $Command<DeleteContactCommandInput, DeleteContactCommandOutput, SSMContactsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteRotationCommandOutput extends DeleteRotationResult, __Met
32
32
  * };
33
33
  * const command = new DeleteRotationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteRotationCommandInput - {@link DeleteRotationCommandInput}
@@ -59,6 +61,8 @@ export interface DeleteRotationCommandOutput extends DeleteRotationResult, __Met
59
61
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
60
62
  * service.</p>
61
63
  *
64
+ * @throws {@link SSMContactsServiceException}
65
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
62
66
  *
63
67
  */
64
68
  export declare class DeleteRotationCommand extends $Command<DeleteRotationCommandInput, DeleteRotationCommandOutput, SSMContactsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteRotationOverrideCommandOutput extends DeleteRotationOverr
32
32
  * };
33
33
  * const command = new DeleteRotationOverrideCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteRotationOverrideCommandInput - {@link DeleteRotationOverrideCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteRotationOverrideCommandOutput extends DeleteRotationOverr
56
58
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
57
59
  * service.</p>
58
60
  *
61
+ * @throws {@link SSMContactsServiceException}
62
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
59
63
  *
60
64
  */
61
65
  export declare class DeleteRotationOverrideCommand extends $Command<DeleteRotationOverrideCommandInput, DeleteRotationOverrideCommandOutput, SSMContactsClientResolvedConfig> {
@@ -32,6 +32,19 @@ export interface DescribeEngagementCommandOutput extends DescribeEngagementResul
32
32
  * };
33
33
  * const command = new DescribeEngagementCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeEngagementResult
36
+ * // ContactArn: "STRING_VALUE", // required
37
+ * // EngagementArn: "STRING_VALUE", // required
38
+ * // Sender: "STRING_VALUE", // required
39
+ * // Subject: "STRING_VALUE", // required
40
+ * // Content: "STRING_VALUE", // required
41
+ * // PublicSubject: "STRING_VALUE",
42
+ * // PublicContent: "STRING_VALUE",
43
+ * // IncidentId: "STRING_VALUE",
44
+ * // StartTime: new Date("TIMESTAMP"),
45
+ * // StopTime: new Date("TIMESTAMP"),
46
+ * // };
47
+ *
35
48
  * ```
36
49
  *
37
50
  * @param DescribeEngagementCommandInput - {@link DescribeEngagementCommandInput}
@@ -59,6 +72,8 @@ export interface DescribeEngagementCommandOutput extends DescribeEngagementResul
59
72
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
60
73
  * service.</p>
61
74
  *
75
+ * @throws {@link SSMContactsServiceException}
76
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
62
77
  *
63
78
  */
64
79
  export declare class DescribeEngagementCommand extends $Command<DescribeEngagementCommandInput, DescribeEngagementCommandOutput, SSMContactsClientResolvedConfig> {
@@ -31,6 +31,21 @@ export interface DescribePageCommandOutput extends DescribePageResult, __Metadat
31
31
  * };
32
32
  * const command = new DescribePageCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribePageResult
35
+ * // PageArn: "STRING_VALUE", // required
36
+ * // EngagementArn: "STRING_VALUE", // required
37
+ * // ContactArn: "STRING_VALUE", // required
38
+ * // Sender: "STRING_VALUE", // required
39
+ * // Subject: "STRING_VALUE", // required
40
+ * // Content: "STRING_VALUE", // required
41
+ * // PublicSubject: "STRING_VALUE",
42
+ * // PublicContent: "STRING_VALUE",
43
+ * // IncidentId: "STRING_VALUE",
44
+ * // SentTime: new Date("TIMESTAMP"),
45
+ * // ReadTime: new Date("TIMESTAMP"),
46
+ * // DeliveryTime: new Date("TIMESTAMP"),
47
+ * // };
48
+ *
34
49
  * ```
35
50
  *
36
51
  * @param DescribePageCommandInput - {@link DescribePageCommandInput}
@@ -58,6 +73,8 @@ export interface DescribePageCommandOutput extends DescribePageResult, __Metadat
58
73
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
59
74
  * service.</p>
60
75
  *
76
+ * @throws {@link SSMContactsServiceException}
77
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
61
78
  *
62
79
  */
63
80
  export declare class DescribePageCommand extends $Command<DescribePageCommandInput, DescribePageCommandOutput, SSMContactsClientResolvedConfig> {
@@ -31,6 +31,17 @@ export interface GetContactChannelCommandOutput extends GetContactChannelResult,
31
31
  * };
32
32
  * const command = new GetContactChannelCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetContactChannelResult
35
+ * // ContactArn: "STRING_VALUE", // required
36
+ * // ContactChannelArn: "STRING_VALUE", // required
37
+ * // Name: "STRING_VALUE", // required
38
+ * // Type: "SMS" || "VOICE" || "EMAIL", // required
39
+ * // DeliveryAddress: { // ContactChannelAddress
40
+ * // SimpleAddress: "STRING_VALUE",
41
+ * // },
42
+ * // ActivationStatus: "ACTIVATED" || "NOT_ACTIVATED",
43
+ * // };
44
+ *
34
45
  * ```
35
46
  *
36
47
  * @param GetContactChannelCommandInput - {@link GetContactChannelCommandInput}
@@ -58,6 +69,8 @@ export interface GetContactChannelCommandOutput extends GetContactChannelResult,
58
69
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
59
70
  * service.</p>
60
71
  *
72
+ * @throws {@link SSMContactsServiceException}
73
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
61
74
  *
62
75
  */
63
76
  export declare class GetContactChannelCommand extends $Command<GetContactChannelCommandInput, GetContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
@@ -31,6 +31,35 @@ export interface GetContactCommandOutput extends GetContactResult, __MetadataBea
31
31
  * };
32
32
  * const command = new GetContactCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetContactResult
35
+ * // ContactArn: "STRING_VALUE", // required
36
+ * // Alias: "STRING_VALUE", // required
37
+ * // DisplayName: "STRING_VALUE",
38
+ * // Type: "PERSONAL" || "ESCALATION" || "ONCALL_SCHEDULE", // required
39
+ * // Plan: { // Plan
40
+ * // Stages: [ // StagesList
41
+ * // { // Stage
42
+ * // DurationInMinutes: Number("int"), // required
43
+ * // Targets: [ // TargetsList // required
44
+ * // { // Target
45
+ * // ChannelTargetInfo: { // ChannelTargetInfo
46
+ * // ContactChannelId: "STRING_VALUE", // required
47
+ * // RetryIntervalInMinutes: Number("int"),
48
+ * // },
49
+ * // ContactTargetInfo: { // ContactTargetInfo
50
+ * // ContactId: "STRING_VALUE",
51
+ * // IsEssential: true || false, // required
52
+ * // },
53
+ * // },
54
+ * // ],
55
+ * // },
56
+ * // ],
57
+ * // RotationIds: [ // SsmContactsArnList
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // },
61
+ * // };
62
+ *
34
63
  * ```
35
64
  *
36
65
  * @param GetContactCommandInput - {@link GetContactCommandInput}
@@ -58,6 +87,8 @@ export interface GetContactCommandOutput extends GetContactResult, __MetadataBea
58
87
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
59
88
  * service.</p>
60
89
  *
90
+ * @throws {@link SSMContactsServiceException}
91
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
61
92
  *
62
93
  */
63
94
  export declare class GetContactCommand extends $Command<GetContactCommandInput, GetContactCommandOutput, SSMContactsClientResolvedConfig> {
@@ -32,6 +32,11 @@ export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, _
32
32
  * };
33
33
  * const command = new GetContactPolicyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetContactPolicyResult
36
+ * // ContactArn: "STRING_VALUE",
37
+ * // Policy: "STRING_VALUE",
38
+ * // };
39
+ *
35
40
  * ```
36
41
  *
37
42
  * @param GetContactPolicyCommandInput - {@link GetContactPolicyCommandInput}
@@ -56,6 +61,8 @@ export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, _
56
61
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
57
62
  * service.</p>
58
63
  *
64
+ * @throws {@link SSMContactsServiceException}
65
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
59
66
  *
60
67
  */
61
68
  export declare class GetContactPolicyCommand extends $Command<GetContactPolicyCommandInput, GetContactPolicyCommandOutput, SSMContactsClientResolvedConfig> {
@@ -31,6 +31,52 @@ export interface GetRotationCommandOutput extends GetRotationResult, __MetadataB
31
31
  * };
32
32
  * const command = new GetRotationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetRotationResult
35
+ * // RotationArn: "STRING_VALUE", // required
36
+ * // Name: "STRING_VALUE", // required
37
+ * // ContactIds: [ // RotationContactsArnList // required
38
+ * // "STRING_VALUE",
39
+ * // ],
40
+ * // StartTime: new Date("TIMESTAMP"), // required
41
+ * // TimeZoneId: "STRING_VALUE", // required
42
+ * // Recurrence: { // RecurrenceSettings
43
+ * // MonthlySettings: [ // MonthlySettings
44
+ * // { // MonthlySetting
45
+ * // DayOfMonth: Number("int"), // required
46
+ * // HandOffTime: { // HandOffTime
47
+ * // HourOfDay: Number("int"), // required
48
+ * // MinuteOfHour: Number("int"), // required
49
+ * // },
50
+ * // },
51
+ * // ],
52
+ * // WeeklySettings: [ // WeeklySettings
53
+ * // { // WeeklySetting
54
+ * // DayOfWeek: "MON" || "TUE" || "WED" || "THU" || "FRI" || "SAT" || "SUN", // required
55
+ * // HandOffTime: {
56
+ * // HourOfDay: Number("int"), // required
57
+ * // MinuteOfHour: Number("int"), // required
58
+ * // },
59
+ * // },
60
+ * // ],
61
+ * // DailySettings: [ // DailySettings
62
+ * // {
63
+ * // HourOfDay: Number("int"), // required
64
+ * // MinuteOfHour: Number("int"), // required
65
+ * // },
66
+ * // ],
67
+ * // NumberOfOnCalls: Number("int"), // required
68
+ * // ShiftCoverages: { // ShiftCoveragesMap
69
+ * // "<keys>": [ // CoverageTimes
70
+ * // { // CoverageTime
71
+ * // Start: "<HandOffTime>",
72
+ * // End: "<HandOffTime>",
73
+ * // },
74
+ * // ],
75
+ * // },
76
+ * // RecurrenceMultiplier: Number("int"), // required
77
+ * // },
78
+ * // };
79
+ *
34
80
  * ```
35
81
  *
36
82
  * @param GetRotationCommandInput - {@link GetRotationCommandInput}
@@ -55,6 +101,8 @@ export interface GetRotationCommandOutput extends GetRotationResult, __MetadataB
55
101
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
56
102
  * service.</p>
57
103
  *
104
+ * @throws {@link SSMContactsServiceException}
105
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
58
106
  *
59
107
  */
60
108
  export declare class GetRotationCommand extends $Command<GetRotationCommandInput, GetRotationCommandOutput, SSMContactsClientResolvedConfig> {
@@ -32,6 +32,17 @@ export interface GetRotationOverrideCommandOutput extends GetRotationOverrideRes
32
32
  * };
33
33
  * const command = new GetRotationOverrideCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetRotationOverrideResult
36
+ * // RotationOverrideId: "STRING_VALUE",
37
+ * // RotationArn: "STRING_VALUE",
38
+ * // NewContactIds: [ // SsmContactsArnList
39
+ * // "STRING_VALUE",
40
+ * // ],
41
+ * // StartTime: new Date("TIMESTAMP"),
42
+ * // EndTime: new Date("TIMESTAMP"),
43
+ * // CreateTime: new Date("TIMESTAMP"),
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param GetRotationOverrideCommandInput - {@link GetRotationOverrideCommandInput}
@@ -56,6 +67,8 @@ export interface GetRotationOverrideCommandOutput extends GetRotationOverrideRes
56
67
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
57
68
  * service.</p>
58
69
  *
70
+ * @throws {@link SSMContactsServiceException}
71
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
59
72
  *
60
73
  */
61
74
  export declare class GetRotationOverrideCommand extends $Command<GetRotationOverrideCommandInput, GetRotationOverrideCommandOutput, SSMContactsClientResolvedConfig> {
@@ -33,6 +33,22 @@ export interface ListContactChannelsCommandOutput extends ListContactChannelsRes
33
33
  * };
34
34
  * const command = new ListContactChannelsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListContactChannelsResult
37
+ * // NextToken: "STRING_VALUE",
38
+ * // ContactChannels: [ // ContactChannelList // required
39
+ * // { // ContactChannel
40
+ * // ContactChannelArn: "STRING_VALUE", // required
41
+ * // ContactArn: "STRING_VALUE", // required
42
+ * // Name: "STRING_VALUE", // required
43
+ * // Type: "SMS" || "VOICE" || "EMAIL",
44
+ * // DeliveryAddress: { // ContactChannelAddress
45
+ * // SimpleAddress: "STRING_VALUE",
46
+ * // },
47
+ * // ActivationStatus: "ACTIVATED" || "NOT_ACTIVATED", // required
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
36
52
  * ```
37
53
  *
38
54
  * @param ListContactChannelsCommandInput - {@link ListContactChannelsCommandInput}
@@ -60,6 +76,8 @@ export interface ListContactChannelsCommandOutput extends ListContactChannelsRes
60
76
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
61
77
  * service.</p>
62
78
  *
79
+ * @throws {@link SSMContactsServiceException}
80
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
63
81
  *
64
82
  */
65
83
  export declare class ListContactChannelsCommand extends $Command<ListContactChannelsCommandInput, ListContactChannelsCommandOutput, SSMContactsClientResolvedConfig> {
@@ -34,6 +34,18 @@ export interface ListContactsCommandOutput extends ListContactsResult, __Metadat
34
34
  * };
35
35
  * const command = new ListContactsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListContactsResult
38
+ * // NextToken: "STRING_VALUE",
39
+ * // Contacts: [ // ContactsList
40
+ * // { // Contact
41
+ * // ContactArn: "STRING_VALUE", // required
42
+ * // Alias: "STRING_VALUE", // required
43
+ * // DisplayName: "STRING_VALUE",
44
+ * // Type: "PERSONAL" || "ESCALATION" || "ONCALL_SCHEDULE", // required
45
+ * // },
46
+ * // ],
47
+ * // };
48
+ *
37
49
  * ```
38
50
  *
39
51
  * @param ListContactsCommandInput - {@link ListContactsCommandInput}
@@ -55,6 +67,8 @@ export interface ListContactsCommandOutput extends ListContactsResult, __Metadat
55
67
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
56
68
  * service.</p>
57
69
  *
70
+ * @throws {@link SSMContactsServiceException}
71
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
58
72
  *
59
73
  */
60
74
  export declare class ListContactsCommand extends $Command<ListContactsCommandInput, ListContactsCommandOutput, SSMContactsClientResolvedConfig> {
@@ -37,6 +37,20 @@ export interface ListEngagementsCommandOutput extends ListEngagementsResult, __M
37
37
  * };
38
38
  * const command = new ListEngagementsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListEngagementsResult
41
+ * // NextToken: "STRING_VALUE",
42
+ * // Engagements: [ // EngagementsList // required
43
+ * // { // Engagement
44
+ * // EngagementArn: "STRING_VALUE", // required
45
+ * // ContactArn: "STRING_VALUE", // required
46
+ * // Sender: "STRING_VALUE", // required
47
+ * // IncidentId: "STRING_VALUE",
48
+ * // StartTime: new Date("TIMESTAMP"),
49
+ * // StopTime: new Date("TIMESTAMP"),
50
+ * // },
51
+ * // ],
52
+ * // };
53
+ *
40
54
  * ```
41
55
  *
42
56
  * @param ListEngagementsCommandInput - {@link ListEngagementsCommandInput}
@@ -58,6 +72,8 @@ export interface ListEngagementsCommandOutput extends ListEngagementsResult, __M
58
72
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
59
73
  * service.</p>
60
74
  *
75
+ * @throws {@link SSMContactsServiceException}
76
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
61
77
  *
62
78
  */
63
79
  export declare class ListEngagementsCommand extends $Command<ListEngagementsCommandInput, ListEngagementsCommandOutput, SSMContactsClientResolvedConfig> {
@@ -33,6 +33,18 @@ export interface ListPageReceiptsCommandOutput extends ListPageReceiptsResult, _
33
33
  * };
34
34
  * const command = new ListPageReceiptsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListPageReceiptsResult
37
+ * // NextToken: "STRING_VALUE",
38
+ * // Receipts: [ // ReceiptsList
39
+ * // { // Receipt
40
+ * // ContactChannelArn: "STRING_VALUE",
41
+ * // ReceiptType: "DELIVERED" || "ERROR" || "READ" || "SENT" || "STOP", // required
42
+ * // ReceiptInfo: "STRING_VALUE",
43
+ * // ReceiptTime: new Date("TIMESTAMP"), // required
44
+ * // },
45
+ * // ],
46
+ * // };
47
+ *
36
48
  * ```
37
49
  *
38
50
  * @param ListPageReceiptsCommandInput - {@link ListPageReceiptsCommandInput}
@@ -57,6 +69,8 @@ export interface ListPageReceiptsCommandOutput extends ListPageReceiptsResult, _
57
69
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
58
70
  * service.</p>
59
71
  *
72
+ * @throws {@link SSMContactsServiceException}
73
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
60
74
  *
61
75
  */
62
76
  export declare class ListPageReceiptsCommand extends $Command<ListPageReceiptsCommandInput, ListPageReceiptsCommandOutput, SSMContactsClientResolvedConfig> {
@@ -36,6 +36,17 @@ export interface ListPageResolutionsCommandOutput extends ListPageResolutionsRes
36
36
  * };
37
37
  * const command = new ListPageResolutionsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListPageResolutionsResult
40
+ * // NextToken: "STRING_VALUE",
41
+ * // PageResolutions: [ // ResolutionList // required
42
+ * // { // ResolutionContact
43
+ * // ContactArn: "STRING_VALUE", // required
44
+ * // Type: "PERSONAL" || "ESCALATION" || "ONCALL_SCHEDULE", // required
45
+ * // StageIndex: Number("int"),
46
+ * // },
47
+ * // ],
48
+ * // };
49
+ *
39
50
  * ```
40
51
  *
41
52
  * @param ListPageResolutionsCommandInput - {@link ListPageResolutionsCommandInput}
@@ -60,6 +71,8 @@ export interface ListPageResolutionsCommandOutput extends ListPageResolutionsRes
60
71
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
61
72
  * service.</p>
62
73
  *
74
+ * @throws {@link SSMContactsServiceException}
75
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
63
76
  *
64
77
  */
65
78
  export declare class ListPageResolutionsCommand extends $Command<ListPageResolutionsCommandInput, ListPageResolutionsCommandOutput, SSMContactsClientResolvedConfig> {
@@ -33,6 +33,22 @@ export interface ListPagesByContactCommandOutput extends ListPagesByContactResul
33
33
  * };
34
34
  * const command = new ListPagesByContactCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListPagesByContactResult
37
+ * // NextToken: "STRING_VALUE",
38
+ * // Pages: [ // PagesList // required
39
+ * // { // Page
40
+ * // PageArn: "STRING_VALUE", // required
41
+ * // EngagementArn: "STRING_VALUE", // required
42
+ * // ContactArn: "STRING_VALUE", // required
43
+ * // Sender: "STRING_VALUE", // required
44
+ * // IncidentId: "STRING_VALUE",
45
+ * // SentTime: new Date("TIMESTAMP"),
46
+ * // DeliveryTime: new Date("TIMESTAMP"),
47
+ * // ReadTime: new Date("TIMESTAMP"),
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
36
52
  * ```
37
53
  *
38
54
  * @param ListPagesByContactCommandInput - {@link ListPagesByContactCommandInput}
@@ -57,6 +73,8 @@ export interface ListPagesByContactCommandOutput extends ListPagesByContactResul
57
73
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
58
74
  * service.</p>
59
75
  *
76
+ * @throws {@link SSMContactsServiceException}
77
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
60
78
  *
61
79
  */
62
80
  export declare class ListPagesByContactCommand extends $Command<ListPagesByContactCommandInput, ListPagesByContactCommandOutput, SSMContactsClientResolvedConfig> {
@@ -33,6 +33,22 @@ export interface ListPagesByEngagementCommandOutput extends ListPagesByEngagemen
33
33
  * };
34
34
  * const command = new ListPagesByEngagementCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListPagesByEngagementResult
37
+ * // NextToken: "STRING_VALUE",
38
+ * // Pages: [ // PagesList // required
39
+ * // { // Page
40
+ * // PageArn: "STRING_VALUE", // required
41
+ * // EngagementArn: "STRING_VALUE", // required
42
+ * // ContactArn: "STRING_VALUE", // required
43
+ * // Sender: "STRING_VALUE", // required
44
+ * // IncidentId: "STRING_VALUE",
45
+ * // SentTime: new Date("TIMESTAMP"),
46
+ * // DeliveryTime: new Date("TIMESTAMP"),
47
+ * // ReadTime: new Date("TIMESTAMP"),
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
36
52
  * ```
37
53
  *
38
54
  * @param ListPagesByEngagementCommandInput - {@link ListPagesByEngagementCommandInput}
@@ -57,6 +73,8 @@ export interface ListPagesByEngagementCommandOutput extends ListPagesByEngagemen
57
73
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
58
74
  * service.</p>
59
75
  *
76
+ * @throws {@link SSMContactsServiceException}
77
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
60
78
  *
61
79
  */
62
80
  export declare class ListPagesByEngagementCommand extends $Command<ListPagesByEngagementCommandInput, ListPagesByEngagementCommandOutput, SSMContactsClientResolvedConfig> {
@@ -87,6 +87,25 @@ export interface ListPreviewRotationShiftsCommandOutput extends ListPreviewRotat
87
87
  * };
88
88
  * const command = new ListPreviewRotationShiftsCommand(input);
89
89
  * const response = await client.send(command);
90
+ * // { // ListPreviewRotationShiftsResult
91
+ * // RotationShifts: [ // RotationShifts
92
+ * // { // RotationShift
93
+ * // ContactIds: [ // SsmContactsArnList
94
+ * // "STRING_VALUE",
95
+ * // ],
96
+ * // StartTime: new Date("TIMESTAMP"), // required
97
+ * // EndTime: new Date("TIMESTAMP"), // required
98
+ * // Type: "REGULAR" || "OVERRIDDEN",
99
+ * // ShiftDetails: { // ShiftDetails
100
+ * // OverriddenContactIds: [ // required
101
+ * // "STRING_VALUE",
102
+ * // ],
103
+ * // },
104
+ * // },
105
+ * // ],
106
+ * // NextToken: "STRING_VALUE",
107
+ * // };
108
+ *
90
109
  * ```
91
110
  *
92
111
  * @param ListPreviewRotationShiftsCommandInput - {@link ListPreviewRotationShiftsCommandInput}
@@ -108,6 +127,8 @@ export interface ListPreviewRotationShiftsCommandOutput extends ListPreviewRotat
108
127
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
109
128
  * service.</p>
110
129
  *
130
+ * @throws {@link SSMContactsServiceException}
131
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
111
132
  *
112
133
  */
113
134
  export declare class ListPreviewRotationShiftsCommand extends $Command<ListPreviewRotationShiftsCommandInput, ListPreviewRotationShiftsCommandOutput, SSMContactsClientResolvedConfig> {
@@ -35,6 +35,21 @@ export interface ListRotationOverridesCommandOutput extends ListRotationOverride
35
35
  * };
36
36
  * const command = new ListRotationOverridesCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListRotationOverridesResult
39
+ * // RotationOverrides: [ // RotationOverrides
40
+ * // { // RotationOverride
41
+ * // RotationOverrideId: "STRING_VALUE", // required
42
+ * // NewContactIds: [ // SsmContactsArnList // required
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // StartTime: new Date("TIMESTAMP"), // required
46
+ * // EndTime: new Date("TIMESTAMP"), // required
47
+ * // CreateTime: new Date("TIMESTAMP"), // required
48
+ * // },
49
+ * // ],
50
+ * // NextToken: "STRING_VALUE",
51
+ * // };
52
+ *
38
53
  * ```
39
54
  *
40
55
  * @param ListRotationOverridesCommandInput - {@link ListRotationOverridesCommandInput}
@@ -59,6 +74,8 @@ export interface ListRotationOverridesCommandOutput extends ListRotationOverride
59
74
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
60
75
  * service.</p>
61
76
  *
77
+ * @throws {@link SSMContactsServiceException}
78
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
62
79
  *
63
80
  */
64
81
  export declare class ListRotationOverridesCommand extends $Command<ListRotationOverridesCommandInput, ListRotationOverridesCommandOutput, SSMContactsClientResolvedConfig> {
@@ -35,6 +35,25 @@ export interface ListRotationShiftsCommandOutput extends ListRotationShiftsResul
35
35
  * };
36
36
  * const command = new ListRotationShiftsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListRotationShiftsResult
39
+ * // RotationShifts: [ // RotationShifts
40
+ * // { // RotationShift
41
+ * // ContactIds: [ // SsmContactsArnList
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // StartTime: new Date("TIMESTAMP"), // required
45
+ * // EndTime: new Date("TIMESTAMP"), // required
46
+ * // Type: "REGULAR" || "OVERRIDDEN",
47
+ * // ShiftDetails: { // ShiftDetails
48
+ * // OverriddenContactIds: [ // required
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // },
52
+ * // },
53
+ * // ],
54
+ * // NextToken: "STRING_VALUE",
55
+ * // };
56
+ *
38
57
  * ```
39
58
  *
40
59
  * @param ListRotationShiftsCommandInput - {@link ListRotationShiftsCommandInput}
@@ -62,6 +81,8 @@ export interface ListRotationShiftsCommandOutput extends ListRotationShiftsResul
62
81
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
63
82
  * service.</p>
64
83
  *
84
+ * @throws {@link SSMContactsServiceException}
85
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
65
86
  *
66
87
  */
67
88
  export declare class ListRotationShiftsCommand extends $Command<ListRotationShiftsCommandInput, ListRotationShiftsCommandOutput, SSMContactsClientResolvedConfig> {
@@ -33,6 +33,57 @@ export interface ListRotationsCommandOutput extends ListRotationsResult, __Metad
33
33
  * };
34
34
  * const command = new ListRotationsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListRotationsResult
37
+ * // NextToken: "STRING_VALUE",
38
+ * // Rotations: [ // Rotations // required
39
+ * // { // Rotation
40
+ * // RotationArn: "STRING_VALUE", // required
41
+ * // Name: "STRING_VALUE", // required
42
+ * // ContactIds: [ // SsmContactsArnList
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // StartTime: new Date("TIMESTAMP"),
46
+ * // TimeZoneId: "STRING_VALUE",
47
+ * // Recurrence: { // RecurrenceSettings
48
+ * // MonthlySettings: [ // MonthlySettings
49
+ * // { // MonthlySetting
50
+ * // DayOfMonth: Number("int"), // required
51
+ * // HandOffTime: { // HandOffTime
52
+ * // HourOfDay: Number("int"), // required
53
+ * // MinuteOfHour: Number("int"), // required
54
+ * // },
55
+ * // },
56
+ * // ],
57
+ * // WeeklySettings: [ // WeeklySettings
58
+ * // { // WeeklySetting
59
+ * // DayOfWeek: "MON" || "TUE" || "WED" || "THU" || "FRI" || "SAT" || "SUN", // required
60
+ * // HandOffTime: {
61
+ * // HourOfDay: Number("int"), // required
62
+ * // MinuteOfHour: Number("int"), // required
63
+ * // },
64
+ * // },
65
+ * // ],
66
+ * // DailySettings: [ // DailySettings
67
+ * // {
68
+ * // HourOfDay: Number("int"), // required
69
+ * // MinuteOfHour: Number("int"), // required
70
+ * // },
71
+ * // ],
72
+ * // NumberOfOnCalls: Number("int"), // required
73
+ * // ShiftCoverages: { // ShiftCoveragesMap
74
+ * // "<keys>": [ // CoverageTimes
75
+ * // { // CoverageTime
76
+ * // Start: "<HandOffTime>",
77
+ * // End: "<HandOffTime>",
78
+ * // },
79
+ * // ],
80
+ * // },
81
+ * // RecurrenceMultiplier: Number("int"), // required
82
+ * // },
83
+ * // },
84
+ * // ],
85
+ * // };
86
+ *
36
87
  * ```
37
88
  *
38
89
  * @param ListRotationsCommandInput - {@link ListRotationsCommandInput}
@@ -57,6 +108,8 @@ export interface ListRotationsCommandOutput extends ListRotationsResult, __Metad
57
108
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
58
109
  * service.</p>
59
110
  *
111
+ * @throws {@link SSMContactsServiceException}
112
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
60
113
  *
61
114
  */
62
115
  export declare class ListRotationsCommand extends $Command<ListRotationsCommandInput, ListRotationsCommandOutput, SSMContactsClientResolvedConfig> {
@@ -31,6 +31,15 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResult
35
+ * // Tags: [ // TagsList
36
+ * // { // Tag
37
+ * // Key: "STRING_VALUE",
38
+ * // Value: "STRING_VALUE",
39
+ * // },
40
+ * // ],
41
+ * // };
42
+ *
34
43
  * ```
35
44
  *
36
45
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -55,6 +64,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
55
64
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
56
65
  * service.</p>
57
66
  *
67
+ * @throws {@link SSMContactsServiceException}
68
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
58
69
  *
59
70
  */
60
71
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SSMContactsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, _
34
34
  * };
35
35
  * const command = new PutContactPolicyCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param PutContactPolicyCommandInput - {@link PutContactPolicyCommandInput}
@@ -61,6 +63,8 @@ export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, _
61
63
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
62
64
  * service.</p>
63
65
  *
66
+ * @throws {@link SSMContactsServiceException}
67
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
64
68
  *
65
69
  */
66
70
  export declare class PutContactPolicyCommand extends $Command<PutContactPolicyCommandInput, PutContactPolicyCommandOutput, SSMContactsClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface SendActivationCodeCommandOutput extends SendActivationCodeResul
33
33
  * };
34
34
  * const command = new SendActivationCodeCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param SendActivationCodeCommandInput - {@link SendActivationCodeCommandInput}
@@ -63,6 +65,8 @@ export interface SendActivationCodeCommandOutput extends SendActivationCodeResul
63
65
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
64
66
  * service.</p>
65
67
  *
68
+ * @throws {@link SSMContactsServiceException}
69
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
66
70
  *
67
71
  */
68
72
  export declare class SendActivationCodeCommand extends $Command<SendActivationCodeCommandInput, SendActivationCodeCommandOutput, SSMContactsClientResolvedConfig> {
@@ -39,6 +39,10 @@ export interface StartEngagementCommandOutput extends StartEngagementResult, __M
39
39
  * };
40
40
  * const command = new StartEngagementCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // StartEngagementResult
43
+ * // EngagementArn: "STRING_VALUE", // required
44
+ * // };
45
+ *
42
46
  * ```
43
47
  *
44
48
  * @param StartEngagementCommandInput - {@link StartEngagementCommandInput}
@@ -66,6 +70,8 @@ export interface StartEngagementCommandOutput extends StartEngagementResult, __M
66
70
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
67
71
  * service.</p>
68
72
  *
73
+ * @throws {@link SSMContactsServiceException}
74
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
69
75
  *
70
76
  */
71
77
  export declare class StartEngagementCommand extends $Command<StartEngagementCommandInput, StartEngagementCommandOutput, SSMContactsClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface StopEngagementCommandOutput extends StopEngagementResult, __Met
33
33
  * };
34
34
  * const command = new StopEngagementCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param StopEngagementCommandInput - {@link StopEngagementCommandInput}
@@ -57,6 +59,8 @@ export interface StopEngagementCommandOutput extends StopEngagementResult, __Met
57
59
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
58
60
  * service.</p>
59
61
  *
62
+ * @throws {@link SSMContactsServiceException}
63
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
60
64
  *
61
65
  */
62
66
  export declare class StopEngagementCommand extends $Command<StopEngagementCommandInput, StopEngagementCommandOutput, SSMContactsClientResolvedConfig> {
@@ -38,6 +38,8 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
38
38
  * };
39
39
  * const command = new TagResourceCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -65,6 +67,8 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
65
67
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
66
68
  * service.</p>
67
69
  *
70
+ * @throws {@link SSMContactsServiceException}
71
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
68
72
  *
69
73
  */
70
74
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SSMContactsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -58,6 +60,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
58
60
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
59
61
  * service.</p>
60
62
  *
63
+ * @throws {@link SSMContactsServiceException}
64
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
61
65
  *
62
66
  */
63
67
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SSMContactsClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface UpdateContactChannelCommandOutput extends UpdateContactChannelR
35
35
  * };
36
36
  * const command = new UpdateContactChannelCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UpdateContactChannelCommandInput - {@link UpdateContactChannelCommandInput}
@@ -65,6 +67,8 @@ export interface UpdateContactChannelCommandOutput extends UpdateContactChannelR
65
67
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
66
68
  * service.</p>
67
69
  *
70
+ * @throws {@link SSMContactsServiceException}
71
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
68
72
  *
69
73
  */
70
74
  export declare class UpdateContactChannelCommand extends $Command<UpdateContactChannelCommandInput, UpdateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
@@ -54,6 +54,8 @@ export interface UpdateContactCommandOutput extends UpdateContactResult, __Metad
54
54
  * };
55
55
  * const command = new UpdateContactCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // {};
58
+ *
57
59
  * ```
58
60
  *
59
61
  * @param UpdateContactCommandInput - {@link UpdateContactCommandInput}
@@ -84,6 +86,8 @@ export interface UpdateContactCommandOutput extends UpdateContactResult, __Metad
84
86
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
85
87
  * service.</p>
86
88
  *
89
+ * @throws {@link SSMContactsServiceException}
90
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
87
91
  *
88
92
  */
89
93
  export declare class UpdateContactCommand extends $Command<UpdateContactCommandInput, UpdateContactCommandOutput, SSMContactsClientResolvedConfig> {
@@ -72,6 +72,8 @@ export interface UpdateRotationCommandOutput extends UpdateRotationResult, __Met
72
72
  * };
73
73
  * const command = new UpdateRotationCommand(input);
74
74
  * const response = await client.send(command);
75
+ * // {};
76
+ *
75
77
  * ```
76
78
  *
77
79
  * @param UpdateRotationCommandInput - {@link UpdateRotationCommandInput}
@@ -99,6 +101,8 @@ export interface UpdateRotationCommandOutput extends UpdateRotationResult, __Met
99
101
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
100
102
  * service.</p>
101
103
  *
104
+ * @throws {@link SSMContactsServiceException}
105
+ * <p>Base exception class for all service exceptions from SSMContacts service.</p>
102
106
  *
103
107
  */
104
108
  export declare class UpdateRotationCommand extends $Command<UpdateRotationCommandInput, UpdateRotationCommandOutput, SSMContactsClientResolvedConfig> {
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.321.1",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.321.1",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.321.1",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
30
- "@aws-sdk/middleware-content-length": "3.310.0",
31
- "@aws-sdk/middleware-endpoint": "3.310.0",
32
- "@aws-sdk/middleware-host-header": "3.310.0",
33
- "@aws-sdk/middleware-logger": "3.310.0",
34
- "@aws-sdk/middleware-recursion-detection": "3.310.0",
35
- "@aws-sdk/middleware-retry": "3.310.0",
36
- "@aws-sdk/middleware-serde": "3.310.0",
37
- "@aws-sdk/middleware-signing": "3.310.0",
38
- "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.319.0",
30
+ "@aws-sdk/middleware-content-length": "3.325.0",
31
+ "@aws-sdk/middleware-endpoint": "3.325.0",
32
+ "@aws-sdk/middleware-host-header": "3.325.0",
33
+ "@aws-sdk/middleware-logger": "3.325.0",
34
+ "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.325.0",
36
+ "@aws-sdk/middleware-serde": "3.325.0",
37
+ "@aws-sdk/middleware-signing": "3.325.0",
38
+ "@aws-sdk/middleware-stack": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.325.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.316.0",
43
+ "@aws-sdk/smithy-client": "3.325.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.316.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
51
  "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",