@aws-sdk/client-ssm-contacts 3.289.0 → 3.292.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 (28) hide show
  1. package/dist-types/commands/AcceptPageCommand.d.ts +18 -0
  2. package/dist-types/commands/ActivateContactChannelCommand.d.ts +18 -0
  3. package/dist-types/commands/CreateContactChannelCommand.d.ts +21 -0
  4. package/dist-types/commands/CreateContactCommand.d.ts +24 -0
  5. package/dist-types/commands/DeactivateContactChannelCommand.d.ts +18 -0
  6. package/dist-types/commands/DeleteContactChannelCommand.d.ts +18 -0
  7. package/dist-types/commands/DeleteContactCommand.d.ts +18 -0
  8. package/dist-types/commands/DescribeEngagementCommand.d.ts +21 -0
  9. package/dist-types/commands/DescribePageCommand.d.ts +21 -0
  10. package/dist-types/commands/GetContactChannelCommand.d.ts +21 -0
  11. package/dist-types/commands/GetContactCommand.d.ts +21 -0
  12. package/dist-types/commands/GetContactPolicyCommand.d.ts +18 -0
  13. package/dist-types/commands/ListContactChannelsCommand.d.ts +21 -0
  14. package/dist-types/commands/ListContactsCommand.d.ts +15 -0
  15. package/dist-types/commands/ListEngagementsCommand.d.ts +15 -0
  16. package/dist-types/commands/ListPageReceiptsCommand.d.ts +18 -0
  17. package/dist-types/commands/ListPagesByContactCommand.d.ts +18 -0
  18. package/dist-types/commands/ListPagesByEngagementCommand.d.ts +18 -0
  19. package/dist-types/commands/ListTagsForResourceCommand.d.ts +18 -0
  20. package/dist-types/commands/PutContactPolicyCommand.d.ts +21 -0
  21. package/dist-types/commands/SendActivationCodeCommand.d.ts +24 -0
  22. package/dist-types/commands/StartEngagementCommand.d.ts +21 -0
  23. package/dist-types/commands/StopEngagementCommand.d.ts +18 -0
  24. package/dist-types/commands/TagResourceCommand.d.ts +21 -0
  25. package/dist-types/commands/UntagResourceCommand.d.ts +18 -0
  26. package/dist-types/commands/UpdateContactChannelCommand.d.ts +24 -0
  27. package/dist-types/commands/UpdateContactCommand.d.ts +24 -0
  28. package/package.json +35 -40
@@ -29,6 +29,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>Unexpected error occurred while
37
+ * processing the request.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>Request references a resource that doesn't exist.</p>
41
+ *
42
+ * @throws {@link ThrottlingException} (client fault)
43
+ * <p>The request was denied due to request throttling.</p>
44
+ *
45
+ * @throws {@link ValidationException} (client fault)
46
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
47
+ * service.</p>
48
+ *
49
+ *
32
50
  * @example To accept a page during and engagement
33
51
  * ```javascript
34
52
  * // The following accept-page operation uses an accept code sent to the contact channel to accept a page.
@@ -30,6 +30,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You don't have sufficient access to perform this operation.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>Unexpected error occurred while
38
+ * processing the request.</p>
39
+ *
40
+ * @throws {@link ResourceNotFoundException} (client fault)
41
+ * <p>Request references a resource that doesn't exist.</p>
42
+ *
43
+ * @throws {@link ThrottlingException} (client fault)
44
+ * <p>The request was denied due to request throttling.</p>
45
+ *
46
+ * @throws {@link ValidationException} (client fault)
47
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
48
+ * service.</p>
49
+ *
50
+ *
33
51
  * @example Activate a contact's contact channel
34
52
  * ```javascript
35
53
  * // The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.
@@ -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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link ConflictException} (client fault)
36
+ * <p>Updating or deleting a resource causes an inconsistent state.</p>
37
+ *
38
+ * @throws {@link DataEncryptionException} (client fault)
39
+ * <p>The operation failed to due an encryption key error.</p>
40
+ *
41
+ * @throws {@link InternalServerException} (server fault)
42
+ * <p>Unexpected error occurred while
43
+ * processing the request.</p>
44
+ *
45
+ * @throws {@link ThrottlingException} (client fault)
46
+ * <p>The request was denied due to request throttling.</p>
47
+ *
48
+ * @throws {@link ValidationException} (client fault)
49
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
50
+ * service.</p>
51
+ *
52
+ *
32
53
  * @example To create a contact channel
33
54
  * ```javascript
34
55
  * // Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.
@@ -31,6 +31,30 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
35
+ * <p>You don't have sufficient access to perform this operation.</p>
36
+ *
37
+ * @throws {@link ConflictException} (client fault)
38
+ * <p>Updating or deleting a resource causes an inconsistent state.</p>
39
+ *
40
+ * @throws {@link DataEncryptionException} (client fault)
41
+ * <p>The operation failed to due an encryption key error.</p>
42
+ *
43
+ * @throws {@link InternalServerException} (server fault)
44
+ * <p>Unexpected error occurred while
45
+ * processing the request.</p>
46
+ *
47
+ * @throws {@link ServiceQuotaExceededException} (client fault)
48
+ * <p>Request would cause a service quota to be exceeded.</p>
49
+ *
50
+ * @throws {@link ThrottlingException} (client fault)
51
+ * <p>The request was denied due to request throttling.</p>
52
+ *
53
+ * @throws {@link ValidationException} (client fault)
54
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
55
+ * service.</p>
56
+ *
57
+ *
34
58
  * @example To create a contact
35
59
  * ```javascript
36
60
  * // 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.
@@ -30,6 +30,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You don't have sufficient access to perform this operation.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>Unexpected error occurred while
38
+ * processing the request.</p>
39
+ *
40
+ * @throws {@link ResourceNotFoundException} (client fault)
41
+ * <p>Request references a resource that doesn't exist.</p>
42
+ *
43
+ * @throws {@link ThrottlingException} (client fault)
44
+ * <p>The request was denied due to request throttling.</p>
45
+ *
46
+ * @throws {@link ValidationException} (client fault)
47
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
48
+ * service.</p>
49
+ *
50
+ *
33
51
  * @example To deactivate a contact channel
34
52
  * ```javascript
35
53
  * // 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.
@@ -32,6 +32,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
36
+ * <p>You don't have sufficient access to perform this operation.</p>
37
+ *
38
+ * @throws {@link InternalServerException} (server fault)
39
+ * <p>Unexpected error occurred while
40
+ * processing the request.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>Request references a resource that doesn't exist.</p>
44
+ *
45
+ * @throws {@link ThrottlingException} (client fault)
46
+ * <p>The request was denied due to request throttling.</p>
47
+ *
48
+ * @throws {@link ValidationException} (client fault)
49
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
50
+ * service.</p>
51
+ *
52
+ *
35
53
  * @example To delete a contact channel
36
54
  * ```javascript
37
55
  * // 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.
@@ -32,6 +32,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
36
+ * <p>You don't have sufficient access to perform this operation.</p>
37
+ *
38
+ * @throws {@link InternalServerException} (server fault)
39
+ * <p>Unexpected error occurred while
40
+ * processing the request.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>Request references a resource that doesn't exist.</p>
44
+ *
45
+ * @throws {@link ThrottlingException} (client fault)
46
+ * <p>The request was denied due to request throttling.</p>
47
+ *
48
+ * @throws {@link ValidationException} (client fault)
49
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
50
+ * service.</p>
51
+ *
52
+ *
35
53
  * @example To delete a contact
36
54
  * ```javascript
37
55
  * // The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them.
@@ -30,6 +30,27 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You don't have sufficient access to perform this operation.</p>
35
+ *
36
+ * @throws {@link DataEncryptionException} (client fault)
37
+ * <p>The operation failed to due an encryption key error.</p>
38
+ *
39
+ * @throws {@link InternalServerException} (server fault)
40
+ * <p>Unexpected error occurred while
41
+ * processing the request.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>Request references a resource that doesn't exist.</p>
45
+ *
46
+ * @throws {@link ThrottlingException} (client fault)
47
+ * <p>The request was denied due to request throttling.</p>
48
+ *
49
+ * @throws {@link ValidationException} (client fault)
50
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
51
+ * service.</p>
52
+ *
53
+ *
33
54
  * @example To describe the details of an engagement
34
55
  * ```javascript
35
56
  * // 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.
@@ -29,6 +29,27 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link DataEncryptionException} (client fault)
36
+ * <p>The operation failed to due an encryption key error.</p>
37
+ *
38
+ * @throws {@link InternalServerException} (server fault)
39
+ * <p>Unexpected error occurred while
40
+ * processing the request.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>Request references a resource that doesn't exist.</p>
44
+ *
45
+ * @throws {@link ThrottlingException} (client fault)
46
+ * <p>The request was denied due to request throttling.</p>
47
+ *
48
+ * @throws {@link ValidationException} (client fault)
49
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
50
+ * service.</p>
51
+ *
52
+ *
32
53
  * @example To list the details of a page to a contact channel
33
54
  * ```javascript
34
55
  * // The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided.
@@ -29,6 +29,27 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link DataEncryptionException} (client fault)
36
+ * <p>The operation failed to due an encryption key error.</p>
37
+ *
38
+ * @throws {@link InternalServerException} (server fault)
39
+ * <p>Unexpected error occurred while
40
+ * processing the request.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>Request references a resource that doesn't exist.</p>
44
+ *
45
+ * @throws {@link ThrottlingException} (client fault)
46
+ * <p>The request was denied due to request throttling.</p>
47
+ *
48
+ * @throws {@link ValidationException} (client fault)
49
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
50
+ * service.</p>
51
+ *
52
+ *
32
53
  * @example To list the details of a contact channel
33
54
  * ```javascript
34
55
  * // The following get-contact-channel example lists the details of a contact channel.
@@ -29,6 +29,27 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link DataEncryptionException} (client fault)
36
+ * <p>The operation failed to due an encryption key error.</p>
37
+ *
38
+ * @throws {@link InternalServerException} (server fault)
39
+ * <p>Unexpected error occurred while
40
+ * processing the request.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>Request references a resource that doesn't exist.</p>
44
+ *
45
+ * @throws {@link ThrottlingException} (client fault)
46
+ * <p>The request was denied due to request throttling.</p>
47
+ *
48
+ * @throws {@link ValidationException} (client fault)
49
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
50
+ * service.</p>
51
+ *
52
+ *
32
53
  * @example Example 1: To describe a contact plan
33
54
  * ```javascript
34
55
  * // The following get-contact example describes a contact.
@@ -30,6 +30,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You don't have sufficient access to perform this operation.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>Unexpected error occurred while
38
+ * processing the request.</p>
39
+ *
40
+ * @throws {@link ResourceNotFoundException} (client fault)
41
+ * <p>Request references a resource that doesn't exist.</p>
42
+ *
43
+ * @throws {@link ThrottlingException} (client fault)
44
+ * <p>The request was denied due to request throttling.</p>
45
+ *
46
+ * @throws {@link ValidationException} (client fault)
47
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
48
+ * service.</p>
49
+ *
50
+ *
33
51
  * @example To list the resource policies of a contact
34
52
  * ```javascript
35
53
  * // The following get-contact-policy example lists the resource policies associated with the specified contact.
@@ -29,6 +29,27 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link DataEncryptionException} (client fault)
36
+ * <p>The operation failed to due an encryption key error.</p>
37
+ *
38
+ * @throws {@link InternalServerException} (server fault)
39
+ * <p>Unexpected error occurred while
40
+ * processing the request.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>Request references a resource that doesn't exist.</p>
44
+ *
45
+ * @throws {@link ThrottlingException} (client fault)
46
+ * <p>The request was denied due to request throttling.</p>
47
+ *
48
+ * @throws {@link ValidationException} (client fault)
49
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
50
+ * service.</p>
51
+ *
52
+ *
32
53
  * @example To list the contact channels of a contact
33
54
  * ```javascript
34
55
  * // The following list-contact-channels example lists the available contact channels of the specified contact.
@@ -29,6 +29,21 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>Unexpected error occurred while
37
+ * processing the request.</p>
38
+ *
39
+ * @throws {@link ThrottlingException} (client fault)
40
+ * <p>The request was denied due to request throttling.</p>
41
+ *
42
+ * @throws {@link ValidationException} (client fault)
43
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
44
+ * service.</p>
45
+ *
46
+ *
32
47
  * @example To list all escalation plans and contacts
33
48
  * ```javascript
34
49
  * // The following list-contacts example lists the contacts and escalation plans in your account.
@@ -29,6 +29,21 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>Unexpected error occurred while
37
+ * processing the request.</p>
38
+ *
39
+ * @throws {@link ThrottlingException} (client fault)
40
+ * <p>The request was denied due to request throttling.</p>
41
+ *
42
+ * @throws {@link ValidationException} (client fault)
43
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
44
+ * service.</p>
45
+ *
46
+ *
32
47
  * @example To list all engagements
33
48
  * ```javascript
34
49
  * // The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements for a single incident.
@@ -29,6 +29,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>Unexpected error occurred while
37
+ * processing the request.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>Request references a resource that doesn't exist.</p>
41
+ *
42
+ * @throws {@link ThrottlingException} (client fault)
43
+ * <p>The request was denied due to request throttling.</p>
44
+ *
45
+ * @throws {@link ValidationException} (client fault)
46
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
47
+ * service.</p>
48
+ *
49
+ *
32
50
  * @example To list page receipts
33
51
  * ```javascript
34
52
  * // The following command-name example lists whether a page was received or not by a contact.
@@ -29,6 +29,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>Unexpected error occurred while
37
+ * processing the request.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>Request references a resource that doesn't exist.</p>
41
+ *
42
+ * @throws {@link ThrottlingException} (client fault)
43
+ * <p>The request was denied due to request throttling.</p>
44
+ *
45
+ * @throws {@link ValidationException} (client fault)
46
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
47
+ * service.</p>
48
+ *
49
+ *
32
50
  * @example To list pages by contact
33
51
  * ```javascript
34
52
  * // The following list-pages-by-contact example lists all pages to the specified contact.
@@ -29,6 +29,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>Unexpected error occurred while
37
+ * processing the request.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>Request references a resource that doesn't exist.</p>
41
+ *
42
+ * @throws {@link ThrottlingException} (client fault)
43
+ * <p>The request was denied due to request throttling.</p>
44
+ *
45
+ * @throws {@link ValidationException} (client fault)
46
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
47
+ * service.</p>
48
+ *
49
+ *
32
50
  * @example To list pages to contact channels started from an engagement.
33
51
  * ```javascript
34
52
  * // The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.
@@ -29,6 +29,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>Unexpected error occurred while
37
+ * processing the request.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>Request references a resource that doesn't exist.</p>
41
+ *
42
+ * @throws {@link ThrottlingException} (client fault)
43
+ * <p>The request was denied due to request throttling.</p>
44
+ *
45
+ * @throws {@link ValidationException} (client fault)
46
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
47
+ * service.</p>
48
+ *
49
+ *
32
50
  * @example To list tags for a contact
33
51
  * ```javascript
34
52
  * // The following list-tags-for-resource example lists the tags of the specified contact.
@@ -31,6 +31,27 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
35
+ * <p>You don't have sufficient access to perform this operation.</p>
36
+ *
37
+ * @throws {@link ConflictException} (client fault)
38
+ * <p>Updating or deleting a resource causes an inconsistent state.</p>
39
+ *
40
+ * @throws {@link InternalServerException} (server fault)
41
+ * <p>Unexpected error occurred while
42
+ * processing the request.</p>
43
+ *
44
+ * @throws {@link ResourceNotFoundException} (client fault)
45
+ * <p>Request references a resource that doesn't exist.</p>
46
+ *
47
+ * @throws {@link ThrottlingException} (client fault)
48
+ * <p>The request was denied due to request throttling.</p>
49
+ *
50
+ * @throws {@link ValidationException} (client fault)
51
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
52
+ * service.</p>
53
+ *
54
+ *
34
55
  * @example To share a contact and engagements
35
56
  * ```javascript
36
57
  * // The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related engagements with the principal.
@@ -31,6 +31,30 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
35
+ * <p>You don't have sufficient access to perform this operation.</p>
36
+ *
37
+ * @throws {@link DataEncryptionException} (client fault)
38
+ * <p>The operation failed to due an encryption key error.</p>
39
+ *
40
+ * @throws {@link InternalServerException} (server fault)
41
+ * <p>Unexpected error occurred while
42
+ * processing the request.</p>
43
+ *
44
+ * @throws {@link ResourceNotFoundException} (client fault)
45
+ * <p>Request references a resource that doesn't exist.</p>
46
+ *
47
+ * @throws {@link ServiceQuotaExceededException} (client fault)
48
+ * <p>Request would cause a service quota to be exceeded.</p>
49
+ *
50
+ * @throws {@link ThrottlingException} (client fault)
51
+ * <p>The request was denied due to request throttling.</p>
52
+ *
53
+ * @throws {@link ValidationException} (client fault)
54
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
55
+ * service.</p>
56
+ *
57
+ *
34
58
  * @example To send an activation code
35
59
  * ```javascript
36
60
  * // The following send-activation-code example sends an activation code and message to the specified contact channel.
@@ -30,6 +30,27 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You don't have sufficient access to perform this operation.</p>
35
+ *
36
+ * @throws {@link DataEncryptionException} (client fault)
37
+ * <p>The operation failed to due an encryption key error.</p>
38
+ *
39
+ * @throws {@link InternalServerException} (server fault)
40
+ * <p>Unexpected error occurred while
41
+ * processing the request.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>Request references a resource that doesn't exist.</p>
45
+ *
46
+ * @throws {@link ThrottlingException} (client fault)
47
+ * <p>The request was denied due to request throttling.</p>
48
+ *
49
+ * @throws {@link ValidationException} (client fault)
50
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
51
+ * service.</p>
52
+ *
53
+ *
33
54
  * @example Example 1: To page a contact's contact channels
34
55
  * ```javascript
35
56
  * // 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.
@@ -30,6 +30,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You don't have sufficient access to perform this operation.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>Unexpected error occurred while
38
+ * processing the request.</p>
39
+ *
40
+ * @throws {@link ResourceNotFoundException} (client fault)
41
+ * <p>Request references a resource that doesn't exist.</p>
42
+ *
43
+ * @throws {@link ThrottlingException} (client fault)
44
+ * <p>The request was denied due to request throttling.</p>
45
+ *
46
+ * @throws {@link ValidationException} (client fault)
47
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
48
+ * service.</p>
49
+ *
50
+ *
33
51
  * @example To stop an engagement
34
52
  * ```javascript
35
53
  * // The following stop-engagement example stops an engagement from paging further contacts and contact channels.
@@ -30,6 +30,27 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You don't have sufficient access to perform this operation.</p>
35
+ *
36
+ * @throws {@link InternalServerException} (server fault)
37
+ * <p>Unexpected error occurred while
38
+ * processing the request.</p>
39
+ *
40
+ * @throws {@link ResourceNotFoundException} (client fault)
41
+ * <p>Request references a resource that doesn't exist.</p>
42
+ *
43
+ * @throws {@link ServiceQuotaExceededException} (client fault)
44
+ * <p>Request would cause a service quota to be exceeded.</p>
45
+ *
46
+ * @throws {@link ThrottlingException} (client fault)
47
+ * <p>The request was denied due to request throttling.</p>
48
+ *
49
+ * @throws {@link ValidationException} (client fault)
50
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
51
+ * service.</p>
52
+ *
53
+ *
33
54
  * @example To tag a contact
34
55
  * ```javascript
35
56
  * // The following tag-resource example tags a specified contact with the provided tag key value pair.
@@ -29,6 +29,24 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link InternalServerException} (server fault)
36
+ * <p>Unexpected error occurred while
37
+ * processing the request.</p>
38
+ *
39
+ * @throws {@link ResourceNotFoundException} (client fault)
40
+ * <p>Request references a resource that doesn't exist.</p>
41
+ *
42
+ * @throws {@link ThrottlingException} (client fault)
43
+ * <p>The request was denied due to request throttling.</p>
44
+ *
45
+ * @throws {@link ValidationException} (client fault)
46
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
47
+ * service.</p>
48
+ *
49
+ *
32
50
  * @example To remove tags from a contact
33
51
  * ```javascript
34
52
  * // The following untag-resource example removes the group1 tag from the specified contact.
@@ -29,6 +29,30 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link ConflictException} (client fault)
36
+ * <p>Updating or deleting a resource causes an inconsistent state.</p>
37
+ *
38
+ * @throws {@link DataEncryptionException} (client fault)
39
+ * <p>The operation failed to due an encryption key error.</p>
40
+ *
41
+ * @throws {@link InternalServerException} (server fault)
42
+ * <p>Unexpected error occurred while
43
+ * processing the request.</p>
44
+ *
45
+ * @throws {@link ResourceNotFoundException} (client fault)
46
+ * <p>Request references a resource that doesn't exist.</p>
47
+ *
48
+ * @throws {@link ThrottlingException} (client fault)
49
+ * <p>The request was denied due to request throttling.</p>
50
+ *
51
+ * @throws {@link ValidationException} (client fault)
52
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
53
+ * service.</p>
54
+ *
55
+ *
32
56
  * @example To update a contact channel
33
57
  * ```javascript
34
58
  * // The following update-contact-channel example updates the name and delivery address of a contact channel.
@@ -29,6 +29,30 @@ 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
+ * @throws {@link AccessDeniedException} (client fault)
33
+ * <p>You don't have sufficient access to perform this operation.</p>
34
+ *
35
+ * @throws {@link DataEncryptionException} (client fault)
36
+ * <p>The operation failed to due an encryption key error.</p>
37
+ *
38
+ * @throws {@link InternalServerException} (server fault)
39
+ * <p>Unexpected error occurred while
40
+ * processing the request.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>Request references a resource that doesn't exist.</p>
44
+ *
45
+ * @throws {@link ServiceQuotaExceededException} (client fault)
46
+ * <p>Request would cause a service quota to be exceeded.</p>
47
+ *
48
+ * @throws {@link ThrottlingException} (client fault)
49
+ * <p>The request was denied due to request throttling.</p>
50
+ *
51
+ * @throws {@link ValidationException} (client fault)
52
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
53
+ * service.</p>
54
+ *
55
+ *
32
56
  * @example To update the engagement plan of contact
33
57
  * ```javascript
34
58
  * // 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.
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.289.0",
4
+ "version": "3.292.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,57 +20,52 @@
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.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
- "@aws-sdk/util-base64": "3.208.0",
46
- "@aws-sdk/util-body-length-browser": "3.188.0",
47
- "@aws-sdk/util-body-length-node": "3.208.0",
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
- "@aws-sdk/util-utf8": "3.254.0",
23
+ "@aws-sdk/client-sts": "3.292.0",
24
+ "@aws-sdk/config-resolver": "3.292.0",
25
+ "@aws-sdk/credential-provider-node": "3.292.0",
26
+ "@aws-sdk/fetch-http-handler": "3.292.0",
27
+ "@aws-sdk/hash-node": "3.292.0",
28
+ "@aws-sdk/invalid-dependency": "3.292.0",
29
+ "@aws-sdk/middleware-content-length": "3.292.0",
30
+ "@aws-sdk/middleware-endpoint": "3.292.0",
31
+ "@aws-sdk/middleware-host-header": "3.292.0",
32
+ "@aws-sdk/middleware-logger": "3.292.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.292.0",
34
+ "@aws-sdk/middleware-retry": "3.292.0",
35
+ "@aws-sdk/middleware-serde": "3.292.0",
36
+ "@aws-sdk/middleware-signing": "3.292.0",
37
+ "@aws-sdk/middleware-stack": "3.292.0",
38
+ "@aws-sdk/middleware-user-agent": "3.292.0",
39
+ "@aws-sdk/node-config-provider": "3.292.0",
40
+ "@aws-sdk/node-http-handler": "3.292.0",
41
+ "@aws-sdk/protocol-http": "3.292.0",
42
+ "@aws-sdk/smithy-client": "3.292.0",
43
+ "@aws-sdk/types": "3.292.0",
44
+ "@aws-sdk/url-parser": "3.292.0",
45
+ "@aws-sdk/util-base64": "3.292.0",
46
+ "@aws-sdk/util-body-length-browser": "3.292.0",
47
+ "@aws-sdk/util-body-length-node": "3.292.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.292.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.292.0",
50
+ "@aws-sdk/util-endpoints": "3.292.0",
51
+ "@aws-sdk/util-retry": "3.292.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.292.0",
53
+ "@aws-sdk/util-user-agent-node": "3.292.0",
54
+ "@aws-sdk/util-utf8": "3.292.0",
55
55
  "tslib": "^2.3.1",
56
56
  "uuid": "^8.3.2"
57
57
  },
58
58
  "devDependencies": {
59
- "@aws-sdk/service-client-documentation-generator": "3.208.0",
59
+ "@aws-sdk/service-client-documentation-generator": "3.292.0",
60
60
  "@tsconfig/node14": "1.0.3",
61
61
  "@types/node": "^14.14.31",
62
62
  "@types/uuid": "^8.3.0",
63
63
  "concurrently": "7.0.0",
64
64
  "downlevel-dts": "0.10.1",
65
65
  "rimraf": "3.0.2",
66
- "typedoc": "0.19.2",
66
+ "typedoc": "0.23.23",
67
67
  "typescript": "~4.6.2"
68
68
  },
69
- "overrides": {
70
- "typedoc": {
71
- "typescript": "~4.6.2"
72
- }
73
- },
74
69
  "engines": {
75
70
  "node": ">=14.0.0"
76
71
  },