@aws-sdk/client-ssm-contacts 3.301.0 → 3.303.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/models/models_0.js +48 -57
- package/dist-es/models/models_0.js +48 -57
- package/dist-types/commands/AcceptPageCommand.d.ts +0 -13
- package/dist-types/commands/ActivateContactChannelCommand.d.ts +0 -12
- package/dist-types/commands/CreateContactChannelCommand.d.ts +0 -21
- package/dist-types/commands/CreateContactCommand.d.ts +0 -21
- package/dist-types/commands/DeactivateContactChannelCommand.d.ts +0 -11
- package/dist-types/commands/DeleteContactChannelCommand.d.ts +0 -11
- package/dist-types/commands/DeleteContactCommand.d.ts +0 -11
- package/dist-types/commands/DescribeEngagementCommand.d.ts +0 -23
- package/dist-types/commands/DescribePageCommand.d.ts +0 -26
- package/dist-types/commands/GetContactChannelCommand.d.ts +0 -23
- package/dist-types/commands/GetContactCommand.d.ts +0 -112
- package/dist-types/commands/GetContactPolicyCommand.d.ts +0 -17
- package/dist-types/commands/ListContactChannelsCommand.d.ts +0 -27
- package/dist-types/commands/ListContactsCommand.d.ts +0 -39
- package/dist-types/commands/ListEngagementsCommand.d.ts +0 -39
- package/dist-types/commands/ListPageReceiptsCommand.d.ts +0 -35
- package/dist-types/commands/ListPagesByContactCommand.d.ts +0 -26
- package/dist-types/commands/ListPagesByEngagementCommand.d.ts +0 -24
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +0 -21
- package/dist-types/commands/PutContactPolicyCommand.d.ts +0 -12
- package/dist-types/commands/SendActivationCodeCommand.d.ts +0 -11
- package/dist-types/commands/StartEngagementCommand.d.ts +0 -42
- package/dist-types/commands/StopEngagementCommand.d.ts +0 -11
- package/dist-types/commands/TagResourceCommand.d.ts +0 -17
- package/dist-types/commands/UntagResourceCommand.d.ts +0 -14
- package/dist-types/commands/UpdateContactChannelCommand.d.ts +0 -15
- package/dist-types/commands/UpdateContactCommand.d.ts +0 -48
- package/dist-types/models/models_0.d.ts +93 -48
- package/dist-types/ts3.4/models/models_0.d.ts +60 -48
- package/package.json +34 -34
|
@@ -2,16 +2,14 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ShiftType = exports.ReceiptType = exports.DayOfWeek = exports.ServiceQuotaExceededException = exports.DataEncryptionException = exports.ContactType = exports.ConflictException = exports.ChannelType = exports.ActivationStatus = exports.ValidationException = exports.ValidationExceptionReason = exports.ThrottlingException = exports.ResourceNotFoundException = exports.InternalServerException = exports.AccessDeniedException = exports.AcceptType = exports.AcceptCodeValidation = void 0;
|
|
4
4
|
const SSMContactsServiceException_1 = require("./SSMContactsServiceException");
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
AcceptType["READ"] = "READ";
|
|
14
|
-
})(AcceptType = exports.AcceptType || (exports.AcceptType = {}));
|
|
5
|
+
exports.AcceptCodeValidation = {
|
|
6
|
+
ENFORCE: "ENFORCE",
|
|
7
|
+
IGNORE: "IGNORE",
|
|
8
|
+
};
|
|
9
|
+
exports.AcceptType = {
|
|
10
|
+
DELIVERED: "DELIVERED",
|
|
11
|
+
READ: "READ",
|
|
12
|
+
};
|
|
15
13
|
class AccessDeniedException extends SSMContactsServiceException_1.SSMContactsServiceException {
|
|
16
14
|
constructor(opts) {
|
|
17
15
|
super({
|
|
@@ -74,13 +72,12 @@ class ThrottlingException extends SSMContactsServiceException_1.SSMContactsServi
|
|
|
74
72
|
}
|
|
75
73
|
}
|
|
76
74
|
exports.ThrottlingException = ThrottlingException;
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
})(ValidationExceptionReason = exports.ValidationExceptionReason || (exports.ValidationExceptionReason = {}));
|
|
75
|
+
exports.ValidationExceptionReason = {
|
|
76
|
+
CANNOT_PARSE: "CANNOT_PARSE",
|
|
77
|
+
FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED",
|
|
78
|
+
OTHER: "OTHER",
|
|
79
|
+
UNKNOWN_OPERATION: "UNKNOWN_OPERATION",
|
|
80
|
+
};
|
|
84
81
|
class ValidationException extends SSMContactsServiceException_1.SSMContactsServiceException {
|
|
85
82
|
constructor(opts) {
|
|
86
83
|
super({
|
|
@@ -97,17 +94,15 @@ class ValidationException extends SSMContactsServiceException_1.SSMContactsServi
|
|
|
97
94
|
}
|
|
98
95
|
}
|
|
99
96
|
exports.ValidationException = ValidationException;
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
ChannelType["VOICE"] = "VOICE";
|
|
110
|
-
})(ChannelType = exports.ChannelType || (exports.ChannelType = {}));
|
|
97
|
+
exports.ActivationStatus = {
|
|
98
|
+
ACTIVATED: "ACTIVATED",
|
|
99
|
+
NOT_ACTIVATED: "NOT_ACTIVATED",
|
|
100
|
+
};
|
|
101
|
+
exports.ChannelType = {
|
|
102
|
+
EMAIL: "EMAIL",
|
|
103
|
+
SMS: "SMS",
|
|
104
|
+
VOICE: "VOICE",
|
|
105
|
+
};
|
|
111
106
|
class ConflictException extends SSMContactsServiceException_1.SSMContactsServiceException {
|
|
112
107
|
constructor(opts) {
|
|
113
108
|
super({
|
|
@@ -125,12 +120,11 @@ class ConflictException extends SSMContactsServiceException_1.SSMContactsService
|
|
|
125
120
|
}
|
|
126
121
|
}
|
|
127
122
|
exports.ConflictException = ConflictException;
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
})(ContactType = exports.ContactType || (exports.ContactType = {}));
|
|
123
|
+
exports.ContactType = {
|
|
124
|
+
ESCALATION: "ESCALATION",
|
|
125
|
+
ONCALL_SCHEDULE: "ONCALL_SCHEDULE",
|
|
126
|
+
PERSONAL: "PERSONAL",
|
|
127
|
+
};
|
|
134
128
|
class DataEncryptionException extends SSMContactsServiceException_1.SSMContactsServiceException {
|
|
135
129
|
constructor(opts) {
|
|
136
130
|
super({
|
|
@@ -163,26 +157,23 @@ class ServiceQuotaExceededException extends SSMContactsServiceException_1.SSMCon
|
|
|
163
157
|
}
|
|
164
158
|
}
|
|
165
159
|
exports.ServiceQuotaExceededException = ServiceQuotaExceededException;
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
ShiftType["OVERRIDDEN"] = "OVERRIDDEN";
|
|
187
|
-
ShiftType["REGULAR"] = "REGULAR";
|
|
188
|
-
})(ShiftType = exports.ShiftType || (exports.ShiftType = {}));
|
|
160
|
+
exports.DayOfWeek = {
|
|
161
|
+
FRI: "FRI",
|
|
162
|
+
MON: "MON",
|
|
163
|
+
SAT: "SAT",
|
|
164
|
+
SUN: "SUN",
|
|
165
|
+
THU: "THU",
|
|
166
|
+
TUE: "TUE",
|
|
167
|
+
WED: "WED",
|
|
168
|
+
};
|
|
169
|
+
exports.ReceiptType = {
|
|
170
|
+
DELIVERED: "DELIVERED",
|
|
171
|
+
ERROR: "ERROR",
|
|
172
|
+
READ: "READ",
|
|
173
|
+
SENT: "SENT",
|
|
174
|
+
STOP: "STOP",
|
|
175
|
+
};
|
|
176
|
+
exports.ShiftType = {
|
|
177
|
+
OVERRIDDEN: "OVERRIDDEN",
|
|
178
|
+
REGULAR: "REGULAR",
|
|
179
|
+
};
|
|
@@ -1,14 +1,12 @@
|
|
|
1
1
|
import { SSMContactsServiceException as __BaseException } from "./SSMContactsServiceException";
|
|
2
|
-
export
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
AcceptType["READ"] = "READ";
|
|
11
|
-
})(AcceptType || (AcceptType = {}));
|
|
2
|
+
export const AcceptCodeValidation = {
|
|
3
|
+
ENFORCE: "ENFORCE",
|
|
4
|
+
IGNORE: "IGNORE",
|
|
5
|
+
};
|
|
6
|
+
export const AcceptType = {
|
|
7
|
+
DELIVERED: "DELIVERED",
|
|
8
|
+
READ: "READ",
|
|
9
|
+
};
|
|
12
10
|
export class AccessDeniedException extends __BaseException {
|
|
13
11
|
constructor(opts) {
|
|
14
12
|
super({
|
|
@@ -67,13 +65,12 @@ export class ThrottlingException extends __BaseException {
|
|
|
67
65
|
this.RetryAfterSeconds = opts.RetryAfterSeconds;
|
|
68
66
|
}
|
|
69
67
|
}
|
|
70
|
-
export
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
})(ValidationExceptionReason || (ValidationExceptionReason = {}));
|
|
68
|
+
export const ValidationExceptionReason = {
|
|
69
|
+
CANNOT_PARSE: "CANNOT_PARSE",
|
|
70
|
+
FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED",
|
|
71
|
+
OTHER: "OTHER",
|
|
72
|
+
UNKNOWN_OPERATION: "UNKNOWN_OPERATION",
|
|
73
|
+
};
|
|
77
74
|
export class ValidationException extends __BaseException {
|
|
78
75
|
constructor(opts) {
|
|
79
76
|
super({
|
|
@@ -89,17 +86,15 @@ export class ValidationException extends __BaseException {
|
|
|
89
86
|
this.Fields = opts.Fields;
|
|
90
87
|
}
|
|
91
88
|
}
|
|
92
|
-
export
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
ChannelType["VOICE"] = "VOICE";
|
|
102
|
-
})(ChannelType || (ChannelType = {}));
|
|
89
|
+
export const ActivationStatus = {
|
|
90
|
+
ACTIVATED: "ACTIVATED",
|
|
91
|
+
NOT_ACTIVATED: "NOT_ACTIVATED",
|
|
92
|
+
};
|
|
93
|
+
export const ChannelType = {
|
|
94
|
+
EMAIL: "EMAIL",
|
|
95
|
+
SMS: "SMS",
|
|
96
|
+
VOICE: "VOICE",
|
|
97
|
+
};
|
|
103
98
|
export class ConflictException extends __BaseException {
|
|
104
99
|
constructor(opts) {
|
|
105
100
|
super({
|
|
@@ -116,12 +111,11 @@ export class ConflictException extends __BaseException {
|
|
|
116
111
|
this.DependentEntities = opts.DependentEntities;
|
|
117
112
|
}
|
|
118
113
|
}
|
|
119
|
-
export
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
})(ContactType || (ContactType = {}));
|
|
114
|
+
export const ContactType = {
|
|
115
|
+
ESCALATION: "ESCALATION",
|
|
116
|
+
ONCALL_SCHEDULE: "ONCALL_SCHEDULE",
|
|
117
|
+
PERSONAL: "PERSONAL",
|
|
118
|
+
};
|
|
125
119
|
export class DataEncryptionException extends __BaseException {
|
|
126
120
|
constructor(opts) {
|
|
127
121
|
super({
|
|
@@ -152,26 +146,23 @@ export class ServiceQuotaExceededException extends __BaseException {
|
|
|
152
146
|
this.ServiceCode = opts.ServiceCode;
|
|
153
147
|
}
|
|
154
148
|
}
|
|
155
|
-
export
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
ShiftType["OVERRIDDEN"] = "OVERRIDDEN";
|
|
176
|
-
ShiftType["REGULAR"] = "REGULAR";
|
|
177
|
-
})(ShiftType || (ShiftType = {}));
|
|
149
|
+
export const DayOfWeek = {
|
|
150
|
+
FRI: "FRI",
|
|
151
|
+
MON: "MON",
|
|
152
|
+
SAT: "SAT",
|
|
153
|
+
SUN: "SUN",
|
|
154
|
+
THU: "THU",
|
|
155
|
+
TUE: "TUE",
|
|
156
|
+
WED: "WED",
|
|
157
|
+
};
|
|
158
|
+
export const ReceiptType = {
|
|
159
|
+
DELIVERED: "DELIVERED",
|
|
160
|
+
ERROR: "ERROR",
|
|
161
|
+
READ: "READ",
|
|
162
|
+
SENT: "SENT",
|
|
163
|
+
STOP: "STOP",
|
|
164
|
+
};
|
|
165
|
+
export const ShiftType = {
|
|
166
|
+
OVERRIDDEN: "OVERRIDDEN",
|
|
167
|
+
REGULAR: "REGULAR",
|
|
168
|
+
};
|
|
@@ -61,19 +61,6 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
|
|
|
61
61
|
* service.</p>
|
|
62
62
|
*
|
|
63
63
|
*
|
|
64
|
-
* @example To accept a page during and engagement
|
|
65
|
-
* ```javascript
|
|
66
|
-
* // The following accept-page operation uses an accept code sent to the contact channel to accept a page.
|
|
67
|
-
* const input = {
|
|
68
|
-
* "AcceptCode": "425440",
|
|
69
|
-
* "AcceptType": "READ",
|
|
70
|
-
* "PageId": "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"
|
|
71
|
-
* };
|
|
72
|
-
* const command = new AcceptPageCommand(input);
|
|
73
|
-
* await client.send(command);
|
|
74
|
-
* // example id: to-accept-a-page-during-and-engagement-1630357840187
|
|
75
|
-
* ```
|
|
76
|
-
*
|
|
77
64
|
*/
|
|
78
65
|
export declare class AcceptPageCommand extends $Command<AcceptPageCommandInput, AcceptPageCommandOutput, SSMContactsClientResolvedConfig> {
|
|
79
66
|
readonly input: AcceptPageCommandInput;
|
|
@@ -58,18 +58,6 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
|
|
|
58
58
|
* service.</p>
|
|
59
59
|
*
|
|
60
60
|
*
|
|
61
|
-
* @example Activate a contact's contact channel
|
|
62
|
-
* ```javascript
|
|
63
|
-
* // The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.
|
|
64
|
-
* const input = {
|
|
65
|
-
* "ActivationCode": "466136",
|
|
66
|
-
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
|
|
67
|
-
* };
|
|
68
|
-
* const command = new ActivateContactChannelCommand(input);
|
|
69
|
-
* await client.send(command);
|
|
70
|
-
* // example id: activate-a-contacts-contact-channel-1630359780075
|
|
71
|
-
* ```
|
|
72
|
-
*
|
|
73
61
|
*/
|
|
74
62
|
export declare class ActivateContactChannelCommand extends $Command<ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
75
63
|
readonly input: ActivateContactChannelCommandInput;
|
|
@@ -66,27 +66,6 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
|
|
|
66
66
|
* service.</p>
|
|
67
67
|
*
|
|
68
68
|
*
|
|
69
|
-
* @example To create a contact channel
|
|
70
|
-
* ```javascript
|
|
71
|
-
* // Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.
|
|
72
|
-
* const input = {
|
|
73
|
-
* "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
|
74
|
-
* "DeliveryAddress": {
|
|
75
|
-
* "SimpleAddress": "+15005550199"
|
|
76
|
-
* },
|
|
77
|
-
* "Name": "akuas sms-test",
|
|
78
|
-
* "Type": "SMS"
|
|
79
|
-
* };
|
|
80
|
-
* const command = new CreateContactChannelCommand(input);
|
|
81
|
-
* const response = await client.send(command);
|
|
82
|
-
* /* response ==
|
|
83
|
-
* {
|
|
84
|
-
* "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024"
|
|
85
|
-
* }
|
|
86
|
-
* *\/
|
|
87
|
-
* // example id: to-create-a-contact-channel-1630360447010
|
|
88
|
-
* ```
|
|
89
|
-
*
|
|
90
69
|
*/
|
|
91
70
|
export declare class CreateContactChannelCommand extends $Command<CreateContactChannelCommandInput, CreateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
92
71
|
readonly input: CreateContactChannelCommandInput;
|
|
@@ -95,27 +95,6 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
|
|
|
95
95
|
* service.</p>
|
|
96
96
|
*
|
|
97
97
|
*
|
|
98
|
-
* @example To create a contact
|
|
99
|
-
* ```javascript
|
|
100
|
-
* // The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you have created contact channels for this contact use update-contact to update the plan.
|
|
101
|
-
* const input = {
|
|
102
|
-
* "Alias": "akuam",
|
|
103
|
-
* "DisplayName": "Akua Mansa",
|
|
104
|
-
* "Plan": {
|
|
105
|
-
* "Stages": []
|
|
106
|
-
* },
|
|
107
|
-
* "Type": "PERSONAL"
|
|
108
|
-
* };
|
|
109
|
-
* const command = new CreateContactCommand(input);
|
|
110
|
-
* const response = await client.send(command);
|
|
111
|
-
* /* response ==
|
|
112
|
-
* {
|
|
113
|
-
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
|
|
114
|
-
* }
|
|
115
|
-
* *\/
|
|
116
|
-
* // example id: to-create-a-contact-1630360152750
|
|
117
|
-
* ```
|
|
118
|
-
*
|
|
119
98
|
*/
|
|
120
99
|
export declare class CreateContactCommand extends $Command<CreateContactCommandInput, CreateContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
121
100
|
readonly input: CreateContactCommandInput;
|
|
@@ -57,17 +57,6 @@ export interface DeactivateContactChannelCommandOutput extends DeactivateContact
|
|
|
57
57
|
* service.</p>
|
|
58
58
|
*
|
|
59
59
|
*
|
|
60
|
-
* @example To deactivate a contact channel
|
|
61
|
-
* ```javascript
|
|
62
|
-
* // The following ``deactivate-contact-channel`` example deactivates a contact channel. Deactivating a contact channel means the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time using the activate-contact-channel operation.
|
|
63
|
-
* const input = {
|
|
64
|
-
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
|
|
65
|
-
* };
|
|
66
|
-
* const command = new DeactivateContactChannelCommand(input);
|
|
67
|
-
* await client.send(command);
|
|
68
|
-
* // example id: to-deactivate-a-contact-channel-1630360853894
|
|
69
|
-
* ```
|
|
70
|
-
*
|
|
71
60
|
*/
|
|
72
61
|
export declare class DeactivateContactChannelCommand extends $Command<DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
73
62
|
readonly input: DeactivateContactChannelCommandInput;
|
|
@@ -59,17 +59,6 @@ export interface DeleteContactChannelCommandOutput extends DeleteContactChannelR
|
|
|
59
59
|
* service.</p>
|
|
60
60
|
*
|
|
61
61
|
*
|
|
62
|
-
* @example To delete a contact channel
|
|
63
|
-
* ```javascript
|
|
64
|
-
* // The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact channel will not be paged during an incident.
|
|
65
|
-
* const input = {
|
|
66
|
-
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2"
|
|
67
|
-
* };
|
|
68
|
-
* const command = new DeleteContactChannelCommand(input);
|
|
69
|
-
* await client.send(command);
|
|
70
|
-
* // example id: to-delete-a-contact-channel-1630364616682
|
|
71
|
-
* ```
|
|
72
|
-
*
|
|
73
62
|
*/
|
|
74
63
|
export declare class DeleteContactChannelCommand extends $Command<DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
75
64
|
readonly input: DeleteContactChannelCommandInput;
|
|
@@ -62,17 +62,6 @@ export interface DeleteContactCommandOutput extends DeleteContactResult, __Metad
|
|
|
62
62
|
* service.</p>
|
|
63
63
|
*
|
|
64
64
|
*
|
|
65
|
-
* @example To delete a contact
|
|
66
|
-
* ```javascript
|
|
67
|
-
* // The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them.
|
|
68
|
-
* const input = {
|
|
69
|
-
* "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"
|
|
70
|
-
* };
|
|
71
|
-
* const command = new DeleteContactCommand(input);
|
|
72
|
-
* await client.send(command);
|
|
73
|
-
* // example id: to-delete-a-contact-1630361093863
|
|
74
|
-
* ```
|
|
75
|
-
*
|
|
76
65
|
*/
|
|
77
66
|
export declare class DeleteContactCommand extends $Command<DeleteContactCommandInput, DeleteContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
78
67
|
readonly input: DeleteContactCommandInput;
|
|
@@ -60,29 +60,6 @@ export interface DescribeEngagementCommandOutput extends DescribeEngagementResul
|
|
|
60
60
|
* service.</p>
|
|
61
61
|
*
|
|
62
62
|
*
|
|
63
|
-
* @example To describe the details of an engagement
|
|
64
|
-
* ```javascript
|
|
65
|
-
* // The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The subject and content are sent to the contact channels.
|
|
66
|
-
* const input = {
|
|
67
|
-
* "EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
|
|
68
|
-
* };
|
|
69
|
-
* const command = new DescribeEngagementCommand(input);
|
|
70
|
-
* const response = await client.send(command);
|
|
71
|
-
* /* response ==
|
|
72
|
-
* {
|
|
73
|
-
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
|
74
|
-
* "Content": "Testing engagements",
|
|
75
|
-
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
|
76
|
-
* "PublicContent": "Testing engagements",
|
|
77
|
-
* "PublicSubject": "test",
|
|
78
|
-
* "Sender": "tester",
|
|
79
|
-
* "StartTime": "2021-05-18T18:25:41.151000+00:00",
|
|
80
|
-
* "Subject": "test"
|
|
81
|
-
* }
|
|
82
|
-
* *\/
|
|
83
|
-
* // example id: to-describe-the-details-of-an-engagement-1630364719475
|
|
84
|
-
* ```
|
|
85
|
-
*
|
|
86
63
|
*/
|
|
87
64
|
export declare class DescribeEngagementCommand extends $Command<DescribeEngagementCommandInput, DescribeEngagementCommandOutput, SSMContactsClientResolvedConfig> {
|
|
88
65
|
readonly input: DescribeEngagementCommandInput;
|
|
@@ -59,32 +59,6 @@ export interface DescribePageCommandOutput extends DescribePageResult, __Metadat
|
|
|
59
59
|
* service.</p>
|
|
60
60
|
*
|
|
61
61
|
*
|
|
62
|
-
* @example To list the details of a page to a contact channel
|
|
63
|
-
* ```javascript
|
|
64
|
-
* // The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided.
|
|
65
|
-
* const input = {
|
|
66
|
-
* "PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"
|
|
67
|
-
* };
|
|
68
|
-
* const command = new DescribePageCommand(input);
|
|
69
|
-
* const response = await client.send(command);
|
|
70
|
-
* /* response ==
|
|
71
|
-
* {
|
|
72
|
-
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
73
|
-
* "Content": "Testing engagements",
|
|
74
|
-
* "DeliveryTime": "2021-05-18T18:43:55.265000+00:00",
|
|
75
|
-
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
|
76
|
-
* "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
|
77
|
-
* "PublicContent": "Testing engagements",
|
|
78
|
-
* "PublicSubject": "test",
|
|
79
|
-
* "ReadTime": "2021-05-18T18:43:55.708000+00:00",
|
|
80
|
-
* "Sender": "tester",
|
|
81
|
-
* "SentTime": "2021-05-18T18:43:29.301000+00:00",
|
|
82
|
-
* "Subject": "test"
|
|
83
|
-
* }
|
|
84
|
-
* *\/
|
|
85
|
-
* // example id: to-list-the-details-of-a-page-to-a-contact-channel-1630364907282
|
|
86
|
-
* ```
|
|
87
|
-
*
|
|
88
62
|
*/
|
|
89
63
|
export declare class DescribePageCommand extends $Command<DescribePageCommandInput, DescribePageCommandOutput, SSMContactsClientResolvedConfig> {
|
|
90
64
|
readonly input: DescribePageCommandInput;
|
|
@@ -59,29 +59,6 @@ export interface GetContactChannelCommandOutput extends GetContactChannelResult,
|
|
|
59
59
|
* service.</p>
|
|
60
60
|
*
|
|
61
61
|
*
|
|
62
|
-
* @example To list the details of a contact channel
|
|
63
|
-
* ```javascript
|
|
64
|
-
* // The following get-contact-channel example lists the details of a contact channel.
|
|
65
|
-
* const input = {
|
|
66
|
-
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
|
|
67
|
-
* };
|
|
68
|
-
* const command = new GetContactChannelCommand(input);
|
|
69
|
-
* const response = await client.send(command);
|
|
70
|
-
* /* response ==
|
|
71
|
-
* {
|
|
72
|
-
* "ActivationStatus": "ACTIVATED",
|
|
73
|
-
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
74
|
-
* "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
|
75
|
-
* "DeliveryAddress": {
|
|
76
|
-
* "SimpleAddress": "+15005550199"
|
|
77
|
-
* },
|
|
78
|
-
* "Name": "akuas sms",
|
|
79
|
-
* "Type": "SMS"
|
|
80
|
-
* }
|
|
81
|
-
* *\/
|
|
82
|
-
* // example id: to-list-the-details-of-a-contact-channel-1630365682730
|
|
83
|
-
* ```
|
|
84
|
-
*
|
|
85
62
|
*/
|
|
86
63
|
export declare class GetContactChannelCommand extends $Command<GetContactChannelCommandInput, GetContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
87
64
|
readonly input: GetContactChannelCommandInput;
|
|
@@ -59,118 +59,6 @@ export interface GetContactCommandOutput extends GetContactResult, __MetadataBea
|
|
|
59
59
|
* service.</p>
|
|
60
60
|
*
|
|
61
61
|
*
|
|
62
|
-
* @example Example 1: To describe a contact plan
|
|
63
|
-
* ```javascript
|
|
64
|
-
* // The following get-contact example describes a contact.
|
|
65
|
-
* const input = {
|
|
66
|
-
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
|
|
67
|
-
* };
|
|
68
|
-
* const command = new GetContactCommand(input);
|
|
69
|
-
* const response = await client.send(command);
|
|
70
|
-
* /* response ==
|
|
71
|
-
* {
|
|
72
|
-
* "Alias": "akuam",
|
|
73
|
-
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
74
|
-
* "DisplayName": "Akua Mansa",
|
|
75
|
-
* "Plan": {
|
|
76
|
-
* "Stages": [
|
|
77
|
-
* {
|
|
78
|
-
* "DurationInMinutes": 5,
|
|
79
|
-
* "Targets": [
|
|
80
|
-
* {
|
|
81
|
-
* "ChannelTargetInfo": {
|
|
82
|
-
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
|
|
83
|
-
* "RetryIntervalInMinutes": 1
|
|
84
|
-
* }
|
|
85
|
-
* }
|
|
86
|
-
* ]
|
|
87
|
-
* },
|
|
88
|
-
* {
|
|
89
|
-
* "DurationInMinutes": 5,
|
|
90
|
-
* "Targets": [
|
|
91
|
-
* {
|
|
92
|
-
* "ChannelTargetInfo": {
|
|
93
|
-
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
|
94
|
-
* "RetryIntervalInMinutes": 1
|
|
95
|
-
* }
|
|
96
|
-
* }
|
|
97
|
-
* ]
|
|
98
|
-
* },
|
|
99
|
-
* {
|
|
100
|
-
* "DurationInMinutes": 5,
|
|
101
|
-
* "Targets": [
|
|
102
|
-
* {
|
|
103
|
-
* "ChannelTargetInfo": {
|
|
104
|
-
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
|
|
105
|
-
* "RetryIntervalInMinutes": 1
|
|
106
|
-
* }
|
|
107
|
-
* }
|
|
108
|
-
* ]
|
|
109
|
-
* }
|
|
110
|
-
* ]
|
|
111
|
-
* },
|
|
112
|
-
* "Type": "PERSONAL"
|
|
113
|
-
* }
|
|
114
|
-
* *\/
|
|
115
|
-
* // example id: example-1-to-describe-a-contact-plan-1630365360005
|
|
116
|
-
* ```
|
|
117
|
-
*
|
|
118
|
-
* @example Example 2: To describe an escalation plan
|
|
119
|
-
* ```javascript
|
|
120
|
-
* // The following get-contact example describes an escalation plan.
|
|
121
|
-
* const input = {
|
|
122
|
-
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"
|
|
123
|
-
* };
|
|
124
|
-
* const command = new GetContactCommand(input);
|
|
125
|
-
* const response = await client.send(command);
|
|
126
|
-
* /* response ==
|
|
127
|
-
* {
|
|
128
|
-
* "Alias": "example_escalation",
|
|
129
|
-
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
|
130
|
-
* "DisplayName": "Example Escalation Plan",
|
|
131
|
-
* "Plan": {
|
|
132
|
-
* "Stages": [
|
|
133
|
-
* {
|
|
134
|
-
* "DurationInMinutes": 5,
|
|
135
|
-
* "Targets": [
|
|
136
|
-
* {
|
|
137
|
-
* "ContactTargetInfo": {
|
|
138
|
-
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
139
|
-
* "IsEssential": true
|
|
140
|
-
* }
|
|
141
|
-
* }
|
|
142
|
-
* ]
|
|
143
|
-
* },
|
|
144
|
-
* {
|
|
145
|
-
* "DurationInMinutes": 5,
|
|
146
|
-
* "Targets": [
|
|
147
|
-
* {
|
|
148
|
-
* "ContactTargetInfo": {
|
|
149
|
-
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
|
|
150
|
-
* "IsEssential": false
|
|
151
|
-
* }
|
|
152
|
-
* }
|
|
153
|
-
* ]
|
|
154
|
-
* },
|
|
155
|
-
* {
|
|
156
|
-
* "DurationInMinutes": 0,
|
|
157
|
-
* "Targets": [
|
|
158
|
-
* {
|
|
159
|
-
* "ContactTargetInfo": {
|
|
160
|
-
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
|
|
161
|
-
* "IsEssential": false
|
|
162
|
-
* }
|
|
163
|
-
* }
|
|
164
|
-
* ]
|
|
165
|
-
* }
|
|
166
|
-
* ]
|
|
167
|
-
* },
|
|
168
|
-
* "Type": "ESCALATION"
|
|
169
|
-
* }
|
|
170
|
-
* *\/
|
|
171
|
-
* // example id: example-2-to-describe-an-escalation-plan-1630365515731
|
|
172
|
-
* ```
|
|
173
|
-
*
|
|
174
62
|
*/
|
|
175
63
|
export declare class GetContactCommand extends $Command<GetContactCommandInput, GetContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
176
64
|
readonly input: GetContactCommandInput;
|