@aws-sdk/client-ssm-contacts 3.287.0 → 3.289.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-types/commands/AcceptPageCommand.d.ts +13 -0
- package/dist-types/commands/ActivateContactChannelCommand.d.ts +12 -0
- package/dist-types/commands/CreateContactChannelCommand.d.ts +21 -0
- package/dist-types/commands/CreateContactCommand.d.ts +21 -0
- package/dist-types/commands/DeactivateContactChannelCommand.d.ts +11 -0
- package/dist-types/commands/DeleteContactChannelCommand.d.ts +11 -0
- package/dist-types/commands/DeleteContactCommand.d.ts +11 -0
- package/dist-types/commands/DescribeEngagementCommand.d.ts +23 -0
- package/dist-types/commands/DescribePageCommand.d.ts +26 -0
- package/dist-types/commands/GetContactChannelCommand.d.ts +23 -0
- package/dist-types/commands/GetContactCommand.d.ts +112 -0
- package/dist-types/commands/GetContactPolicyCommand.d.ts +17 -0
- package/dist-types/commands/ListContactChannelsCommand.d.ts +27 -0
- package/dist-types/commands/ListContactsCommand.d.ts +39 -0
- package/dist-types/commands/ListEngagementsCommand.d.ts +39 -0
- package/dist-types/commands/ListPageReceiptsCommand.d.ts +35 -0
- package/dist-types/commands/ListPagesByContactCommand.d.ts +26 -0
- package/dist-types/commands/ListPagesByEngagementCommand.d.ts +24 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +21 -0
- package/dist-types/commands/PutContactPolicyCommand.d.ts +12 -0
- package/dist-types/commands/SendActivationCodeCommand.d.ts +11 -0
- package/dist-types/commands/StartEngagementCommand.d.ts +42 -0
- package/dist-types/commands/StopEngagementCommand.d.ts +11 -0
- package/dist-types/commands/TagResourceCommand.d.ts +17 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +14 -0
- package/dist-types/commands/UpdateContactChannelCommand.d.ts +15 -0
- package/dist-types/commands/UpdateContactCommand.d.ts +48 -0
- package/package.json +29 -29
|
@@ -29,6 +29,19 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
|
|
|
29
29
|
* @see {@link AcceptPageCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To accept a page during and engagement
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following accept-page operation uses an accept code sent to the contact channel to accept a page.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "AcceptCode": "425440",
|
|
37
|
+
* "AcceptType": "READ",
|
|
38
|
+
* "PageId": "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new AcceptPageCommand(input);
|
|
41
|
+
* await client.send(command);
|
|
42
|
+
* // example id: to-accept-a-page-during-and-engagement-1630357840187
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
32
45
|
*/
|
|
33
46
|
export declare class AcceptPageCommand extends $Command<AcceptPageCommandInput, AcceptPageCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
47
|
readonly input: AcceptPageCommandInput;
|
|
@@ -30,6 +30,18 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
|
|
|
30
30
|
* @see {@link ActivateContactChannelCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example Activate a contact's contact channel
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "ActivationCode": "466136",
|
|
38
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ActivateContactChannelCommand(input);
|
|
41
|
+
* await client.send(command);
|
|
42
|
+
* // example id: activate-a-contacts-contact-channel-1630359780075
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
33
45
|
*/
|
|
34
46
|
export declare class ActivateContactChannelCommand extends $Command<ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
35
47
|
readonly input: ActivateContactChannelCommandInput;
|
|
@@ -29,6 +29,27 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
|
|
|
29
29
|
* @see {@link CreateContactChannelCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To create a contact channel
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
|
37
|
+
* "DeliveryAddress": {
|
|
38
|
+
* "SimpleAddress": "+15005550199"
|
|
39
|
+
* },
|
|
40
|
+
* "Name": "akuas sms-test",
|
|
41
|
+
* "Type": "SMS"
|
|
42
|
+
* };
|
|
43
|
+
* const command = new CreateContactChannelCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* /* response ==
|
|
46
|
+
* {
|
|
47
|
+
* "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024"
|
|
48
|
+
* }
|
|
49
|
+
* *\/
|
|
50
|
+
* // example id: to-create-a-contact-channel-1630360447010
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
32
53
|
*/
|
|
33
54
|
export declare class CreateContactChannelCommand extends $Command<CreateContactChannelCommandInput, CreateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
55
|
readonly input: CreateContactChannelCommandInput;
|
|
@@ -31,6 +31,27 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
|
|
|
31
31
|
* @see {@link CreateContactCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To create a contact
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // 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.
|
|
37
|
+
* const input = {
|
|
38
|
+
* "Alias": "akuam",
|
|
39
|
+
* "DisplayName": "Akua Mansa",
|
|
40
|
+
* "Plan": {
|
|
41
|
+
* "Stages": []
|
|
42
|
+
* },
|
|
43
|
+
* "Type": "PERSONAL"
|
|
44
|
+
* };
|
|
45
|
+
* const command = new CreateContactCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* /* response ==
|
|
48
|
+
* {
|
|
49
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
|
|
50
|
+
* }
|
|
51
|
+
* *\/
|
|
52
|
+
* // example id: to-create-a-contact-1630360152750
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
34
55
|
*/
|
|
35
56
|
export declare class CreateContactCommand extends $Command<CreateContactCommandInput, CreateContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
36
57
|
readonly input: CreateContactCommandInput;
|
|
@@ -30,6 +30,17 @@ export interface DeactivateContactChannelCommandOutput extends DeactivateContact
|
|
|
30
30
|
* @see {@link DeactivateContactChannelCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example To deactivate a contact channel
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // 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.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
|
|
38
|
+
* };
|
|
39
|
+
* const command = new DeactivateContactChannelCommand(input);
|
|
40
|
+
* await client.send(command);
|
|
41
|
+
* // example id: to-deactivate-a-contact-channel-1630360853894
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
33
44
|
*/
|
|
34
45
|
export declare class DeactivateContactChannelCommand extends $Command<DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
35
46
|
readonly input: DeactivateContactChannelCommandInput;
|
|
@@ -32,6 +32,17 @@ export interface DeleteContactChannelCommandOutput extends DeleteContactChannelR
|
|
|
32
32
|
* @see {@link DeleteContactChannelCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example To delete a contact channel
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // 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.
|
|
38
|
+
* const input = {
|
|
39
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2"
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteContactChannelCommand(input);
|
|
42
|
+
* await client.send(command);
|
|
43
|
+
* // example id: to-delete-a-contact-channel-1630364616682
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
35
46
|
*/
|
|
36
47
|
export declare class DeleteContactChannelCommand extends $Command<DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
37
48
|
readonly input: DeleteContactChannelCommandInput;
|
|
@@ -32,6 +32,17 @@ export interface DeleteContactCommandOutput extends DeleteContactResult, __Metad
|
|
|
32
32
|
* @see {@link DeleteContactCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example To delete a contact
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them.
|
|
38
|
+
* const input = {
|
|
39
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteContactCommand(input);
|
|
42
|
+
* await client.send(command);
|
|
43
|
+
* // example id: to-delete-a-contact-1630361093863
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
35
46
|
*/
|
|
36
47
|
export declare class DeleteContactCommand extends $Command<DeleteContactCommandInput, DeleteContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
37
48
|
readonly input: DeleteContactCommandInput;
|
|
@@ -30,6 +30,29 @@ export interface DescribeEngagementCommandOutput extends DescribeEngagementResul
|
|
|
30
30
|
* @see {@link DescribeEngagementCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example To describe the details of an engagement
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // 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.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
|
|
38
|
+
* };
|
|
39
|
+
* const command = new DescribeEngagementCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* /* response ==
|
|
42
|
+
* {
|
|
43
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
|
44
|
+
* "Content": "Testing engagements",
|
|
45
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
|
46
|
+
* "PublicContent": "Testing engagements",
|
|
47
|
+
* "PublicSubject": "test",
|
|
48
|
+
* "Sender": "tester",
|
|
49
|
+
* "StartTime": "2021-05-18T18:25:41.151000+00:00",
|
|
50
|
+
* "Subject": "test"
|
|
51
|
+
* }
|
|
52
|
+
* *\/
|
|
53
|
+
* // example id: to-describe-the-details-of-an-engagement-1630364719475
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
33
56
|
*/
|
|
34
57
|
export declare class DescribeEngagementCommand extends $Command<DescribeEngagementCommandInput, DescribeEngagementCommandOutput, SSMContactsClientResolvedConfig> {
|
|
35
58
|
readonly input: DescribeEngagementCommandInput;
|
|
@@ -29,6 +29,32 @@ export interface DescribePageCommandOutput extends DescribePageResult, __Metadat
|
|
|
29
29
|
* @see {@link DescribePageCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To list the details of a page to a contact channel
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"
|
|
37
|
+
* };
|
|
38
|
+
* const command = new DescribePageCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
43
|
+
* "Content": "Testing engagements",
|
|
44
|
+
* "DeliveryTime": "2021-05-18T18:43:55.265000+00:00",
|
|
45
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
|
46
|
+
* "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
|
47
|
+
* "PublicContent": "Testing engagements",
|
|
48
|
+
* "PublicSubject": "test",
|
|
49
|
+
* "ReadTime": "2021-05-18T18:43:55.708000+00:00",
|
|
50
|
+
* "Sender": "tester",
|
|
51
|
+
* "SentTime": "2021-05-18T18:43:29.301000+00:00",
|
|
52
|
+
* "Subject": "test"
|
|
53
|
+
* }
|
|
54
|
+
* *\/
|
|
55
|
+
* // example id: to-list-the-details-of-a-page-to-a-contact-channel-1630364907282
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
32
58
|
*/
|
|
33
59
|
export declare class DescribePageCommand extends $Command<DescribePageCommandInput, DescribePageCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
60
|
readonly input: DescribePageCommandInput;
|
|
@@ -29,6 +29,29 @@ export interface GetContactChannelCommandOutput extends GetContactChannelResult,
|
|
|
29
29
|
* @see {@link GetContactChannelCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To list the details of a contact channel
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following get-contact-channel example lists the details of a contact channel.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
|
|
37
|
+
* };
|
|
38
|
+
* const command = new GetContactChannelCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "ActivationStatus": "ACTIVATED",
|
|
43
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
44
|
+
* "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
|
45
|
+
* "DeliveryAddress": {
|
|
46
|
+
* "SimpleAddress": "+15005550199"
|
|
47
|
+
* },
|
|
48
|
+
* "Name": "akuas sms",
|
|
49
|
+
* "Type": "SMS"
|
|
50
|
+
* }
|
|
51
|
+
* *\/
|
|
52
|
+
* // example id: to-list-the-details-of-a-contact-channel-1630365682730
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
32
55
|
*/
|
|
33
56
|
export declare class GetContactChannelCommand extends $Command<GetContactChannelCommandInput, GetContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
57
|
readonly input: GetContactChannelCommandInput;
|
|
@@ -29,6 +29,118 @@ export interface GetContactCommandOutput extends GetContactResult, __MetadataBea
|
|
|
29
29
|
* @see {@link GetContactCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example Example 1: To describe a contact plan
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following get-contact example describes a contact.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
|
|
37
|
+
* };
|
|
38
|
+
* const command = new GetContactCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "Alias": "akuam",
|
|
43
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
44
|
+
* "DisplayName": "Akua Mansa",
|
|
45
|
+
* "Plan": {
|
|
46
|
+
* "Stages": [
|
|
47
|
+
* {
|
|
48
|
+
* "DurationInMinutes": 5,
|
|
49
|
+
* "Targets": [
|
|
50
|
+
* {
|
|
51
|
+
* "ChannelTargetInfo": {
|
|
52
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
|
|
53
|
+
* "RetryIntervalInMinutes": 1
|
|
54
|
+
* }
|
|
55
|
+
* }
|
|
56
|
+
* ]
|
|
57
|
+
* },
|
|
58
|
+
* {
|
|
59
|
+
* "DurationInMinutes": 5,
|
|
60
|
+
* "Targets": [
|
|
61
|
+
* {
|
|
62
|
+
* "ChannelTargetInfo": {
|
|
63
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
|
64
|
+
* "RetryIntervalInMinutes": 1
|
|
65
|
+
* }
|
|
66
|
+
* }
|
|
67
|
+
* ]
|
|
68
|
+
* },
|
|
69
|
+
* {
|
|
70
|
+
* "DurationInMinutes": 5,
|
|
71
|
+
* "Targets": [
|
|
72
|
+
* {
|
|
73
|
+
* "ChannelTargetInfo": {
|
|
74
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
|
|
75
|
+
* "RetryIntervalInMinutes": 1
|
|
76
|
+
* }
|
|
77
|
+
* }
|
|
78
|
+
* ]
|
|
79
|
+
* }
|
|
80
|
+
* ]
|
|
81
|
+
* },
|
|
82
|
+
* "Type": "PERSONAL"
|
|
83
|
+
* }
|
|
84
|
+
* *\/
|
|
85
|
+
* // example id: example-1-to-describe-a-contact-plan-1630365360005
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @example Example 2: To describe an escalation plan
|
|
89
|
+
* ```javascript
|
|
90
|
+
* // The following get-contact example describes an escalation plan.
|
|
91
|
+
* const input = {
|
|
92
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"
|
|
93
|
+
* };
|
|
94
|
+
* const command = new GetContactCommand(input);
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* /* response ==
|
|
97
|
+
* {
|
|
98
|
+
* "Alias": "example_escalation",
|
|
99
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
|
100
|
+
* "DisplayName": "Example Escalation Plan",
|
|
101
|
+
* "Plan": {
|
|
102
|
+
* "Stages": [
|
|
103
|
+
* {
|
|
104
|
+
* "DurationInMinutes": 5,
|
|
105
|
+
* "Targets": [
|
|
106
|
+
* {
|
|
107
|
+
* "ContactTargetInfo": {
|
|
108
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
109
|
+
* "IsEssential": true
|
|
110
|
+
* }
|
|
111
|
+
* }
|
|
112
|
+
* ]
|
|
113
|
+
* },
|
|
114
|
+
* {
|
|
115
|
+
* "DurationInMinutes": 5,
|
|
116
|
+
* "Targets": [
|
|
117
|
+
* {
|
|
118
|
+
* "ContactTargetInfo": {
|
|
119
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
|
|
120
|
+
* "IsEssential": false
|
|
121
|
+
* }
|
|
122
|
+
* }
|
|
123
|
+
* ]
|
|
124
|
+
* },
|
|
125
|
+
* {
|
|
126
|
+
* "DurationInMinutes": 0,
|
|
127
|
+
* "Targets": [
|
|
128
|
+
* {
|
|
129
|
+
* "ContactTargetInfo": {
|
|
130
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
|
|
131
|
+
* "IsEssential": false
|
|
132
|
+
* }
|
|
133
|
+
* }
|
|
134
|
+
* ]
|
|
135
|
+
* }
|
|
136
|
+
* ]
|
|
137
|
+
* },
|
|
138
|
+
* "Type": "ESCALATION"
|
|
139
|
+
* }
|
|
140
|
+
* *\/
|
|
141
|
+
* // example id: example-2-to-describe-an-escalation-plan-1630365515731
|
|
142
|
+
* ```
|
|
143
|
+
*
|
|
32
144
|
*/
|
|
33
145
|
export declare class GetContactCommand extends $Command<GetContactCommandInput, GetContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
146
|
readonly input: GetContactCommandInput;
|
|
@@ -30,6 +30,23 @@ export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, _
|
|
|
30
30
|
* @see {@link GetContactPolicyCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example To list the resource policies of a contact
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following get-contact-policy example lists the resource policies associated with the specified contact.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
|
|
38
|
+
* };
|
|
39
|
+
* const command = new GetContactPolicyCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* /* response ==
|
|
42
|
+
* {
|
|
43
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
|
44
|
+
* "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"SharePolicyForDocumentationDralia\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"222233334444\"},\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}"
|
|
45
|
+
* }
|
|
46
|
+
* *\/
|
|
47
|
+
* // example id: to-list-the-details-of-a-contact-channel-1630365682730
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
33
50
|
*/
|
|
34
51
|
export declare class GetContactPolicyCommand extends $Command<GetContactPolicyCommandInput, GetContactPolicyCommandOutput, SSMContactsClientResolvedConfig> {
|
|
35
52
|
readonly input: GetContactPolicyCommandInput;
|
|
@@ -29,6 +29,33 @@ export interface ListContactChannelsCommandOutput extends ListContactChannelsRes
|
|
|
29
29
|
* @see {@link ListContactChannelsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To list the contact channels of a contact
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following list-contact-channels example lists the available contact channels of the specified contact.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListContactChannelsCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "ContactChannels": [
|
|
43
|
+
* {
|
|
44
|
+
* "ActivationStatus": "ACTIVATED",
|
|
45
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
46
|
+
* "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
|
47
|
+
* "DeliveryAddress": {
|
|
48
|
+
* "SimpleAddress": "+15005550100"
|
|
49
|
+
* },
|
|
50
|
+
* "Name": "akuas sms",
|
|
51
|
+
* "Type": "SMS"
|
|
52
|
+
* }
|
|
53
|
+
* ]
|
|
54
|
+
* }
|
|
55
|
+
* *\/
|
|
56
|
+
* // example id: to-list-the-contact-channels-of-a-contact-1630366544252
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
32
59
|
*/
|
|
33
60
|
export declare class ListContactChannelsCommand extends $Command<ListContactChannelsCommandInput, ListContactChannelsCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
61
|
readonly input: ListContactChannelsCommandInput;
|
|
@@ -29,6 +29,45 @@ export interface ListContactsCommandOutput extends ListContactsResult, __Metadat
|
|
|
29
29
|
* @see {@link ListContactsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To list all escalation plans and contacts
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following list-contacts example lists the contacts and escalation plans in your account.
|
|
35
|
+
* const input = {};
|
|
36
|
+
* const command = new ListContactsCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* /* response ==
|
|
39
|
+
* {
|
|
40
|
+
* "Contacts": [
|
|
41
|
+
* {
|
|
42
|
+
* "Alias": "akuam",
|
|
43
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
44
|
+
* "DisplayName": "Akua Mansa",
|
|
45
|
+
* "Type": "PERSONAL"
|
|
46
|
+
* },
|
|
47
|
+
* {
|
|
48
|
+
* "Alias": "alejr",
|
|
49
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
|
|
50
|
+
* "DisplayName": "Alejandro Rosalez",
|
|
51
|
+
* "Type": "PERSONAL"
|
|
52
|
+
* },
|
|
53
|
+
* {
|
|
54
|
+
* "Alias": "anasi",
|
|
55
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
|
|
56
|
+
* "DisplayName": "Ana Carolina Silva",
|
|
57
|
+
* "Type": "PERSONAL"
|
|
58
|
+
* },
|
|
59
|
+
* {
|
|
60
|
+
* "Alias": "example_escalation",
|
|
61
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
|
62
|
+
* "DisplayName": "Example Escalation",
|
|
63
|
+
* "Type": "ESCALATION"
|
|
64
|
+
* }
|
|
65
|
+
* ]
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: to-list-all-escalation-plans-and-contacts-1630367103082
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
32
71
|
*/
|
|
33
72
|
export declare class ListContactsCommand extends $Command<ListContactsCommandInput, ListContactsCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
73
|
readonly input: ListContactsCommandInput;
|
|
@@ -29,6 +29,45 @@ export interface ListEngagementsCommandOutput extends ListEngagementsResult, __M
|
|
|
29
29
|
* @see {@link ListEngagementsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To list all engagements
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements for a single incident.
|
|
35
|
+
* const input = {};
|
|
36
|
+
* const command = new ListEngagementsCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* /* response ==
|
|
39
|
+
* {
|
|
40
|
+
* "Engagements": [
|
|
41
|
+
* {
|
|
42
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
43
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529",
|
|
44
|
+
* "Sender": "cli",
|
|
45
|
+
* "StartTime": "2021-05-18T20:37:50.300000+00:00"
|
|
46
|
+
* },
|
|
47
|
+
* {
|
|
48
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
49
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
|
50
|
+
* "Sender": "cli",
|
|
51
|
+
* "StartTime": "2021-05-18T18:40:26.666000+00:00"
|
|
52
|
+
* },
|
|
53
|
+
* {
|
|
54
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
|
55
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
|
|
56
|
+
* "Sender": "cli",
|
|
57
|
+
* "StartTime": "2021-05-18T18:25:41.151000+00:00"
|
|
58
|
+
* },
|
|
59
|
+
* {
|
|
60
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
61
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f",
|
|
62
|
+
* "Sender": "cli",
|
|
63
|
+
* "StartTime": "2021-05-18T18:20:58.093000+00:00"
|
|
64
|
+
* }
|
|
65
|
+
* ]
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: to-list-all-engagements-1630367432635
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
32
71
|
*/
|
|
33
72
|
export declare class ListEngagementsCommand extends $Command<ListEngagementsCommandInput, ListEngagementsCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
73
|
readonly input: ListEngagementsCommandInput;
|
|
@@ -29,6 +29,41 @@ export interface ListPageReceiptsCommandOutput extends ListPageReceiptsResult, _
|
|
|
29
29
|
* @see {@link ListPageReceiptsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To list page receipts
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following command-name example lists whether a page was received or not by a contact.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListPageReceiptsCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "Receipts": [
|
|
43
|
+
* {
|
|
44
|
+
* "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
|
45
|
+
* "ReceiptInfo": "425440",
|
|
46
|
+
* "ReceiptTime": "2021-05-18T20:42:57.485000+00:00",
|
|
47
|
+
* "ReceiptType": "DELIVERED"
|
|
48
|
+
* },
|
|
49
|
+
* {
|
|
50
|
+
* "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
|
51
|
+
* "ReceiptInfo": "425440",
|
|
52
|
+
* "ReceiptTime": "2021-05-18T20:42:57.907000+00:00",
|
|
53
|
+
* "ReceiptType": "READ"
|
|
54
|
+
* },
|
|
55
|
+
* {
|
|
56
|
+
* "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
|
|
57
|
+
* "ReceiptInfo": "SM6656c19132f1465f9c9c1123a5dde7c9",
|
|
58
|
+
* "ReceiptTime": "2021-05-18T20:40:52.962000+00:00",
|
|
59
|
+
* "ReceiptType": "SENT"
|
|
60
|
+
* }
|
|
61
|
+
* ]
|
|
62
|
+
* }
|
|
63
|
+
* *\/
|
|
64
|
+
* // example id: to-list-page-receipts-1630367706869
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
32
67
|
*/
|
|
33
68
|
export declare class ListPageReceiptsCommand extends $Command<ListPageReceiptsCommandInput, ListPageReceiptsCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
69
|
readonly input: ListPageReceiptsCommandInput;
|
|
@@ -29,6 +29,32 @@ export interface ListPagesByContactCommandOutput extends ListPagesByContactResul
|
|
|
29
29
|
* @see {@link ListPagesByContactCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To list pages by contact
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following list-pages-by-contact example lists all pages to the specified contact.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListPagesByContactCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "Pages": [
|
|
43
|
+
* {
|
|
44
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
45
|
+
* "DeliveryTime": "2021-05-18T18:43:55.265000+00:00",
|
|
46
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
|
47
|
+
* "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
|
48
|
+
* "ReadTime": "2021-05-18T18:43:55.708000+00:00",
|
|
49
|
+
* "Sender": "cli",
|
|
50
|
+
* "SentTime": "2021-05-18T18:43:29.301000+00:00"
|
|
51
|
+
* }
|
|
52
|
+
* ]
|
|
53
|
+
* }
|
|
54
|
+
* *\/
|
|
55
|
+
* // example id: to-list-pages-by-contact-1630435789132
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
32
58
|
*/
|
|
33
59
|
export declare class ListPagesByContactCommand extends $Command<ListPagesByContactCommandInput, ListPagesByContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
60
|
readonly input: ListPagesByContactCommandInput;
|
|
@@ -29,6 +29,30 @@ export interface ListPagesByEngagementCommandOutput extends ListPagesByEngagemen
|
|
|
29
29
|
* @see {@link ListPagesByEngagementCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To list pages to contact channels started from an engagement.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0"
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListPagesByEngagementCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "Pages": [
|
|
43
|
+
* {
|
|
44
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
45
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
|
|
46
|
+
* "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
|
|
47
|
+
* "Sender": "cli",
|
|
48
|
+
* "SentTime": "2021-05-18T18:40:27.245000+00:00"
|
|
49
|
+
* }
|
|
50
|
+
* ]
|
|
51
|
+
* }
|
|
52
|
+
* *\/
|
|
53
|
+
* // example id: to-list-pages-to-contact-channels-started-from-an-engagement-1630435864674
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
32
56
|
*/
|
|
33
57
|
export declare class ListPagesByEngagementCommand extends $Command<ListPagesByEngagementCommandInput, ListPagesByEngagementCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
58
|
readonly input: ListPagesByEngagementCommandInput;
|
|
@@ -29,6 +29,27 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
29
29
|
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To list tags for a contact
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following list-tags-for-resource example lists the tags of the specified contact.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ResourceARN": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "Tags": [
|
|
43
|
+
* {
|
|
44
|
+
* "Key": "group1",
|
|
45
|
+
* "Value": "1"
|
|
46
|
+
* }
|
|
47
|
+
* ]
|
|
48
|
+
* }
|
|
49
|
+
* *\/
|
|
50
|
+
* // example id: to-list-tags-for-a-contact-1630436051681
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
32
53
|
*/
|
|
33
54
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
55
|
readonly input: ListTagsForResourceCommandInput;
|
|
@@ -31,6 +31,18 @@ export interface PutContactPolicyCommandOutput extends PutContactPolicyResult, _
|
|
|
31
31
|
* @see {@link PutContactPolicyCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To share a contact and engagements
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related engagements with the principal.
|
|
37
|
+
* const input = {
|
|
38
|
+
* "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
|
39
|
+
* "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"222233334444\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}"
|
|
40
|
+
* };
|
|
41
|
+
* const command = new PutContactPolicyCommand(input);
|
|
42
|
+
* await client.send(command);
|
|
43
|
+
* // example id: to-share-a-contact-and-engagements-1630436278898
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
34
46
|
*/
|
|
35
47
|
export declare class PutContactPolicyCommand extends $Command<PutContactPolicyCommandInput, PutContactPolicyCommandOutput, SSMContactsClientResolvedConfig> {
|
|
36
48
|
readonly input: PutContactPolicyCommandInput;
|
|
@@ -31,6 +31,17 @@ export interface SendActivationCodeCommandOutput extends SendActivationCodeResul
|
|
|
31
31
|
* @see {@link SendActivationCodeCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To send an activation code
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following send-activation-code example sends an activation code and message to the specified contact channel.
|
|
37
|
+
* const input = {
|
|
38
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new SendActivationCodeCommand(input);
|
|
41
|
+
* await client.send(command);
|
|
42
|
+
* // example id: to-send-an-activation-code-1630436453574
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
34
45
|
*/
|
|
35
46
|
export declare class SendActivationCodeCommand extends $Command<SendActivationCodeCommandInput, SendActivationCodeCommandOutput, SSMContactsClientResolvedConfig> {
|
|
36
47
|
readonly input: SendActivationCodeCommandInput;
|
|
@@ -30,6 +30,48 @@ export interface StartEngagementCommandOutput extends StartEngagementResult, __M
|
|
|
30
30
|
* @see {@link StartEngagementCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example Example 1: To page a contact's contact channels
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // 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.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
38
|
+
* "Content": "Testing engagements",
|
|
39
|
+
* "PublicContent": "Testing engagements",
|
|
40
|
+
* "PublicSubject": "test",
|
|
41
|
+
* "Sender": "tester",
|
|
42
|
+
* "Subject": "test"
|
|
43
|
+
* };
|
|
44
|
+
* const command = new StartEngagementCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* /* response ==
|
|
47
|
+
* {
|
|
48
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f"
|
|
49
|
+
* }
|
|
50
|
+
* *\/
|
|
51
|
+
* // example id: example-1-to-page-a-contacts-contact-channels-1630436634872
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @example Example 2: To page a contact in the provided escalation plan.
|
|
55
|
+
* ```javascript
|
|
56
|
+
* // The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their engagement plan.
|
|
57
|
+
* const input = {
|
|
58
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
|
|
59
|
+
* "Content": "Testing engagements",
|
|
60
|
+
* "PublicContent": "Testing engagements",
|
|
61
|
+
* "PublicSubject": "test",
|
|
62
|
+
* "Sender": "tester",
|
|
63
|
+
* "Subject": "test"
|
|
64
|
+
* };
|
|
65
|
+
* const command = new StartEngagementCommand(input);
|
|
66
|
+
* const response = await client.send(command);
|
|
67
|
+
* /* response ==
|
|
68
|
+
* {
|
|
69
|
+
* "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
|
|
70
|
+
* }
|
|
71
|
+
* *\/
|
|
72
|
+
* // example id: example-2-to-page-a-contact-in-the-provided-escalation-plan-1630436808480
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
33
75
|
*/
|
|
34
76
|
export declare class StartEngagementCommand extends $Command<StartEngagementCommandInput, StartEngagementCommandOutput, SSMContactsClientResolvedConfig> {
|
|
35
77
|
readonly input: StartEngagementCommandInput;
|
|
@@ -30,6 +30,17 @@ export interface StopEngagementCommandOutput extends StopEngagementResult, __Met
|
|
|
30
30
|
* @see {@link StopEngagementCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example To stop an engagement
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following stop-engagement example stops an engagement from paging further contacts and contact channels.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
|
|
38
|
+
* };
|
|
39
|
+
* const command = new StopEngagementCommand(input);
|
|
40
|
+
* await client.send(command);
|
|
41
|
+
* // example id: to-stop-an-engagement-1630436882864
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
33
44
|
*/
|
|
34
45
|
export declare class StopEngagementCommand extends $Command<StopEngagementCommandInput, StopEngagementCommandOutput, SSMContactsClientResolvedConfig> {
|
|
35
46
|
readonly input: StopEngagementCommandInput;
|
|
@@ -30,6 +30,23 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
|
|
|
30
30
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example To tag a contact
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following tag-resource example tags a specified contact with the provided tag key value pair.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "ResourceARN": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
|
38
|
+
* "Tags": [
|
|
39
|
+
* {
|
|
40
|
+
* "Key": "group1",
|
|
41
|
+
* "Value": "1"
|
|
42
|
+
* }
|
|
43
|
+
* ]
|
|
44
|
+
* };
|
|
45
|
+
* const command = new TagResourceCommand(input);
|
|
46
|
+
* await client.send(command);
|
|
47
|
+
* // example id: to-tag-a-contact-1630437124572
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
33
50
|
*/
|
|
34
51
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SSMContactsClientResolvedConfig> {
|
|
35
52
|
readonly input: TagResourceCommandInput;
|
|
@@ -29,6 +29,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad
|
|
|
29
29
|
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To remove tags from a contact
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following untag-resource example removes the group1 tag from the specified contact.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ResourceARN": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
|
|
37
|
+
* "TagKeys": [
|
|
38
|
+
* "group1"
|
|
39
|
+
* ]
|
|
40
|
+
* };
|
|
41
|
+
* const command = new UntagResourceCommand(input);
|
|
42
|
+
* await client.send(command);
|
|
43
|
+
* // example id: to-remove-tags-from-a-contact-1630437251110
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
32
46
|
*/
|
|
33
47
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
48
|
readonly input: UntagResourceCommandInput;
|
|
@@ -29,6 +29,21 @@ export interface UpdateContactChannelCommandOutput extends UpdateContactChannelR
|
|
|
29
29
|
* @see {@link UpdateContactChannelCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To update a contact channel
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following update-contact-channel example updates the name and delivery address of a contact channel.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
|
37
|
+
* "DeliveryAddress": {
|
|
38
|
+
* "SimpleAddress": "+15005550198"
|
|
39
|
+
* },
|
|
40
|
+
* "Name": "akuas voice channel"
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UpdateContactChannelCommand(input);
|
|
43
|
+
* await client.send(command);
|
|
44
|
+
* // example id: to-update-a-contact-channel-1630437610256
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
32
47
|
*/
|
|
33
48
|
export declare class UpdateContactChannelCommand extends $Command<UpdateContactChannelCommandInput, UpdateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
49
|
readonly input: UpdateContactChannelCommandInput;
|
|
@@ -29,6 +29,54 @@ export interface UpdateContactCommandOutput extends UpdateContactResult, __Metad
|
|
|
29
29
|
* @see {@link UpdateContactCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To update the engagement plan of contact
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // 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.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
|
|
37
|
+
* "Plan": {
|
|
38
|
+
* "Stages": [
|
|
39
|
+
* {
|
|
40
|
+
* "DurationInMinutes": 5,
|
|
41
|
+
* "Targets": [
|
|
42
|
+
* {
|
|
43
|
+
* "ChannelTargetInfo": {
|
|
44
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
|
|
45
|
+
* "RetryIntervalInMinutes": 1
|
|
46
|
+
* }
|
|
47
|
+
* }
|
|
48
|
+
* ]
|
|
49
|
+
* },
|
|
50
|
+
* {
|
|
51
|
+
* "DurationInMinutes": 5,
|
|
52
|
+
* "Targets": [
|
|
53
|
+
* {
|
|
54
|
+
* "ChannelTargetInfo": {
|
|
55
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
|
|
56
|
+
* "RetryIntervalInMinutes": 1
|
|
57
|
+
* }
|
|
58
|
+
* }
|
|
59
|
+
* ]
|
|
60
|
+
* },
|
|
61
|
+
* {
|
|
62
|
+
* "DurationInMinutes": 5,
|
|
63
|
+
* "Targets": [
|
|
64
|
+
* {
|
|
65
|
+
* "ChannelTargetInfo": {
|
|
66
|
+
* "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
|
|
67
|
+
* "RetryIntervalInMinutes": 1
|
|
68
|
+
* }
|
|
69
|
+
* }
|
|
70
|
+
* ]
|
|
71
|
+
* }
|
|
72
|
+
* ]
|
|
73
|
+
* }
|
|
74
|
+
* };
|
|
75
|
+
* const command = new UpdateContactCommand(input);
|
|
76
|
+
* await client.send(command);
|
|
77
|
+
* // example id: to-update-the-engagement-plan-of-contact-1630437436599
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
32
80
|
*/
|
|
33
81
|
export declare class UpdateContactCommand extends $Command<UpdateContactCommandInput, UpdateContactCommandOutput, SSMContactsClientResolvedConfig> {
|
|
34
82
|
readonly input: UpdateContactCommandInput;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-ssm-contacts",
|
|
3
3
|
"description": "AWS SDK for JavaScript Ssm Contacts Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.289.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",
|
|
@@ -20,37 +20,37 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/config-resolver": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
27
|
-
"@aws-sdk/hash-node": "3.
|
|
28
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
29
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
30
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
31
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
32
|
-
"@aws-sdk/middleware-logger": "3.
|
|
33
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
34
|
-
"@aws-sdk/middleware-retry": "3.
|
|
35
|
-
"@aws-sdk/middleware-serde": "3.
|
|
36
|
-
"@aws-sdk/middleware-signing": "3.
|
|
37
|
-
"@aws-sdk/middleware-stack": "3.
|
|
38
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
39
|
-
"@aws-sdk/node-config-provider": "3.
|
|
40
|
-
"@aws-sdk/node-http-handler": "3.
|
|
41
|
-
"@aws-sdk/protocol-http": "3.
|
|
42
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
-
"@aws-sdk/types": "3.
|
|
44
|
-
"@aws-sdk/url-parser": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.289.0",
|
|
24
|
+
"@aws-sdk/config-resolver": "3.289.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.289.0",
|
|
26
|
+
"@aws-sdk/fetch-http-handler": "3.289.0",
|
|
27
|
+
"@aws-sdk/hash-node": "3.289.0",
|
|
28
|
+
"@aws-sdk/invalid-dependency": "3.289.0",
|
|
29
|
+
"@aws-sdk/middleware-content-length": "3.289.0",
|
|
30
|
+
"@aws-sdk/middleware-endpoint": "3.289.0",
|
|
31
|
+
"@aws-sdk/middleware-host-header": "3.289.0",
|
|
32
|
+
"@aws-sdk/middleware-logger": "3.289.0",
|
|
33
|
+
"@aws-sdk/middleware-recursion-detection": "3.289.0",
|
|
34
|
+
"@aws-sdk/middleware-retry": "3.289.0",
|
|
35
|
+
"@aws-sdk/middleware-serde": "3.289.0",
|
|
36
|
+
"@aws-sdk/middleware-signing": "3.289.0",
|
|
37
|
+
"@aws-sdk/middleware-stack": "3.289.0",
|
|
38
|
+
"@aws-sdk/middleware-user-agent": "3.289.0",
|
|
39
|
+
"@aws-sdk/node-config-provider": "3.289.0",
|
|
40
|
+
"@aws-sdk/node-http-handler": "3.289.0",
|
|
41
|
+
"@aws-sdk/protocol-http": "3.289.0",
|
|
42
|
+
"@aws-sdk/smithy-client": "3.289.0",
|
|
43
|
+
"@aws-sdk/types": "3.289.0",
|
|
44
|
+
"@aws-sdk/url-parser": "3.289.0",
|
|
45
45
|
"@aws-sdk/util-base64": "3.208.0",
|
|
46
46
|
"@aws-sdk/util-body-length-browser": "3.188.0",
|
|
47
47
|
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
48
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
49
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
-
"@aws-sdk/util-endpoints": "3.
|
|
51
|
-
"@aws-sdk/util-retry": "3.
|
|
52
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
53
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
48
|
+
"@aws-sdk/util-defaults-mode-browser": "3.289.0",
|
|
49
|
+
"@aws-sdk/util-defaults-mode-node": "3.289.0",
|
|
50
|
+
"@aws-sdk/util-endpoints": "3.289.0",
|
|
51
|
+
"@aws-sdk/util-retry": "3.289.0",
|
|
52
|
+
"@aws-sdk/util-user-agent-browser": "3.289.0",
|
|
53
|
+
"@aws-sdk/util-user-agent-node": "3.289.0",
|
|
54
54
|
"@aws-sdk/util-utf8": "3.254.0",
|
|
55
55
|
"tslib": "^2.3.1",
|
|
56
56
|
"uuid": "^8.3.2"
|