@aws-sdk/client-ssm-contacts 3.288.0 → 3.290.0

package/dist-types/commands/AcceptPageCommand.d.ts

@@ -29,6 +29,37 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
  * @see {@link AcceptPageCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To accept a page during and engagement
+ * ```javascript
+ * // The following accept-page operation uses an accept code sent to the contact channel to accept a page.
+ * const input = {
+ *   "AcceptCode": "425440",
+ *   "AcceptType": "READ",
+ *   "PageId": "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"
+ * };
+ * const command = new AcceptPageCommand(input);
+ * await client.send(command);
+ * // example id: to-accept-a-page-during-and-engagement-1630357840187
+ * ```
+ *
  */
 export declare class AcceptPageCommand extends $Command<AcceptPageCommandInput, AcceptPageCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: AcceptPageCommandInput;

package/dist-types/commands/ActivateContactChannelCommand.d.ts

@@ -30,6 +30,36 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
  * @see {@link ActivateContactChannelCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example Activate a contact's contact channel
+ * ```javascript
+ * // The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.
+ * const input = {
+ *   "ActivationCode": "466136",
+ *   "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
+ * };
+ * const command = new ActivateContactChannelCommand(input);
+ * await client.send(command);
+ * // example id: activate-a-contacts-contact-channel-1630359780075
+ * ```
+ *
  */
 export declare class ActivateContactChannelCommand extends $Command<ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: ActivateContactChannelCommandInput;

package/dist-types/commands/CreateContactChannelCommand.d.ts

@@ -29,6 +29,48 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
  * @see {@link CreateContactChannelCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource causes an inconsistent state.</p>
+ *
+ * @throws {@link DataEncryptionException} (client fault)
+ *  <p>The operation failed to due an encryption key error.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To create a contact channel
+ * ```javascript
+ * // Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.
+ * const input = {
+ *   "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
+ *   "DeliveryAddress": {
+ *     "SimpleAddress": "+15005550199"
+ *   },
+ *   "Name": "akuas sms-test",
+ *   "Type": "SMS"
+ * };
+ * const command = new CreateContactChannelCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024"
+ * }
+ * *\/
+ * // example id: to-create-a-contact-channel-1630360447010
+ * ```
+ *
  */
 export declare class CreateContactChannelCommand extends $Command<CreateContactChannelCommandInput, CreateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: CreateContactChannelCommandInput;

package/dist-types/commands/CreateContactCommand.d.ts

@@ -31,6 +31,51 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
  * @see {@link CreateContactCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource causes an inconsistent state.</p>
+ *
+ * @throws {@link DataEncryptionException} (client fault)
+ *  <p>The operation failed to due an encryption key error.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Request would cause a service quota to be exceeded.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To create a contact
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "Alias": "akuam",
+ *   "DisplayName": "Akua Mansa",
+ *   "Plan": {
+ *     "Stages": []
+ *   },
+ *   "Type": "PERSONAL"
+ * };
+ * const command = new CreateContactCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
+ * }
+ * *\/
+ * // example id: to-create-a-contact-1630360152750
+ * ```
+ *
  */
 export declare class CreateContactCommand extends $Command<CreateContactCommandInput, CreateContactCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: CreateContactCommandInput;

package/dist-types/commands/DeactivateContactChannelCommand.d.ts

@@ -30,6 +30,35 @@ export interface DeactivateContactChannelCommandOutput extends DeactivateContact
  * @see {@link DeactivateContactChannelCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To deactivate a contact channel
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
+ * };
+ * const command = new DeactivateContactChannelCommand(input);
+ * await client.send(command);
+ * // example id: to-deactivate-a-contact-channel-1630360853894
+ * ```
+ *
  */
 export declare class DeactivateContactChannelCommand extends $Command<DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: DeactivateContactChannelCommandInput;

package/dist-types/commands/DeleteContactChannelCommand.d.ts

@@ -32,6 +32,35 @@ export interface DeleteContactChannelCommandOutput extends DeleteContactChannelR
  * @see {@link DeleteContactChannelCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To delete a contact channel
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2"
+ * };
+ * const command = new DeleteContactChannelCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-contact-channel-1630364616682
+ * ```
+ *
  */
 export declare class DeleteContactChannelCommand extends $Command<DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: DeleteContactChannelCommandInput;

package/dist-types/commands/DeleteContactCommand.d.ts

@@ -32,6 +32,35 @@ export interface DeleteContactCommandOutput extends DeleteContactResult, __Metad
  * @see {@link DeleteContactCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To delete a contact
+ * ```javascript
+ * // The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them.
+ * const input = {
+ *   "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"
+ * };
+ * const command = new DeleteContactCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-contact-1630361093863
+ * ```
+ *
  */
 export declare class DeleteContactCommand extends $Command<DeleteContactCommandInput, DeleteContactCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: DeleteContactCommandInput;

package/dist-types/commands/DescribeEngagementCommand.d.ts

@@ -30,6 +30,50 @@ export interface DescribeEngagementCommandOutput extends DescribeEngagementResul
  * @see {@link DescribeEngagementCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link DataEncryptionException} (client fault)
+ *  <p>The operation failed to due an encryption key error.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To describe the details of an engagement
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
+ * };
+ * const command = new DescribeEngagementCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
+ *   "Content": "Testing engagements",
+ *   "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
+ *   "PublicContent": "Testing engagements",
+ *   "PublicSubject": "test",
+ *   "Sender": "tester",
+ *   "StartTime": "2021-05-18T18:25:41.151000+00:00",
+ *   "Subject": "test"
+ * }
+ * *\/
+ * // example id: to-describe-the-details-of-an-engagement-1630364719475
+ * ```
+ *
  */
 export declare class DescribeEngagementCommand extends $Command<DescribeEngagementCommandInput, DescribeEngagementCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: DescribeEngagementCommandInput;

package/dist-types/commands/DescribePageCommand.d.ts

@@ -29,6 +29,53 @@ export interface DescribePageCommandOutput extends DescribePageResult, __Metadat
  * @see {@link DescribePageCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link DataEncryptionException} (client fault)
+ *  <p>The operation failed to due an encryption key error.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To list the details of a page to a contact channel
+ * ```javascript
+ * // The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided.
+ * const input = {
+ *   "PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"
+ * };
+ * const command = new DescribePageCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
+ *   "Content": "Testing engagements",
+ *   "DeliveryTime": "2021-05-18T18:43:55.265000+00:00",
+ *   "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
+ *   "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
+ *   "PublicContent": "Testing engagements",
+ *   "PublicSubject": "test",
+ *   "ReadTime": "2021-05-18T18:43:55.708000+00:00",
+ *   "Sender": "tester",
+ *   "SentTime": "2021-05-18T18:43:29.301000+00:00",
+ *   "Subject": "test"
+ * }
+ * *\/
+ * // example id: to-list-the-details-of-a-page-to-a-contact-channel-1630364907282
+ * ```
+ *
  */
 export declare class DescribePageCommand extends $Command<DescribePageCommandInput, DescribePageCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: DescribePageCommandInput;

package/dist-types/commands/GetContactChannelCommand.d.ts

@@ -29,6 +29,50 @@ export interface GetContactChannelCommandOutput extends GetContactChannelResult,
  * @see {@link GetContactChannelCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link DataEncryptionException} (client fault)
+ *  <p>The operation failed to due an encryption key error.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To list the details of a contact channel
+ * ```javascript
+ * // The following get-contact-channel example lists the details of a contact channel.
+ * const input = {
+ *   "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
+ * };
+ * const command = new GetContactChannelCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ActivationStatus": "ACTIVATED",
+ *   "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
+ *   "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
+ *   "DeliveryAddress": {
+ *     "SimpleAddress": "+15005550199"
+ *   },
+ *   "Name": "akuas sms",
+ *   "Type": "SMS"
+ * }
+ * *\/
+ * // example id: to-list-the-details-of-a-contact-channel-1630365682730
+ * ```
+ *
  */
 export declare class GetContactChannelCommand extends $Command<GetContactChannelCommandInput, GetContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: GetContactChannelCommandInput;

package/dist-types/commands/GetContactCommand.d.ts

@@ -29,6 +29,139 @@ export interface GetContactCommandOutput extends GetContactResult, __MetadataBea
  * @see {@link GetContactCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link DataEncryptionException} (client fault)
+ *  <p>The operation failed to due an encryption key error.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example Example 1: To describe a contact plan
+ * ```javascript
+ * // The following get-contact example describes a contact.
+ * const input = {
+ *   "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
+ * };
+ * const command = new GetContactCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Alias": "akuam",
+ *   "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
+ *   "DisplayName": "Akua Mansa",
+ *   "Plan": {
+ *     "Stages": [
+ *       {
+ *         "DurationInMinutes": 5,
+ *         "Targets": [
+ *           {
+ *             "ChannelTargetInfo": {
+ *               "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
+ *               "RetryIntervalInMinutes": 1
+ *             }
+ *           }
+ *         ]
+ *       },
+ *       {
+ *         "DurationInMinutes": 5,
+ *         "Targets": [
+ *           {
+ *             "ChannelTargetInfo": {
+ *               "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
+ *               "RetryIntervalInMinutes": 1
+ *             }
+ *           }
+ *         ]
+ *       },
+ *       {
+ *         "DurationInMinutes": 5,
+ *         "Targets": [
+ *           {
+ *             "ChannelTargetInfo": {
+ *               "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
+ *               "RetryIntervalInMinutes": 1
+ *             }
+ *           }
+ *         ]
+ *       }
+ *     ]
+ *   },
+ *   "Type": "PERSONAL"
+ * }
+ * *\/
+ * // example id: example-1-to-describe-a-contact-plan-1630365360005
+ * ```
+ *
+ * @example Example 2: To describe an escalation plan
+ * ```javascript
+ * // The following get-contact example describes an escalation plan.
+ * const input = {
+ *   "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"
+ * };
+ * const command = new GetContactCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Alias": "example_escalation",
+ *   "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
+ *   "DisplayName": "Example Escalation Plan",
+ *   "Plan": {
+ *     "Stages": [
+ *       {
+ *         "DurationInMinutes": 5,
+ *         "Targets": [
+ *           {
+ *             "ContactTargetInfo": {
+ *               "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
+ *               "IsEssential": true
+ *             }
+ *           }
+ *         ]
+ *       },
+ *       {
+ *         "DurationInMinutes": 5,
+ *         "Targets": [
+ *           {
+ *             "ContactTargetInfo": {
+ *               "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
+ *               "IsEssential": false
+ *             }
+ *           }
+ *         ]
+ *       },
+ *       {
+ *         "DurationInMinutes": 0,
+ *         "Targets": [
+ *           {
+ *             "ContactTargetInfo": {
+ *               "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
+ *               "IsEssential": false
+ *             }
+ *           }
+ *         ]
+ *       }
+ *     ]
+ *   },
+ *   "Type": "ESCALATION"
+ * }
+ * *\/
+ * // example id: example-2-to-describe-an-escalation-plan-1630365515731
+ * ```
+ *
  */
 export declare class GetContactCommand extends $Command<GetContactCommandInput, GetContactCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: GetContactCommandInput;

package/dist-types/commands/GetContactPolicyCommand.d.ts

@@ -30,6 +30,41 @@ export interface GetContactPolicyCommandOutput extends GetContactPolicyResult, _
  * @see {@link GetContactPolicyCommandOutput} for command's `response` shape.
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error occurred while
+ *          processing the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services
+ *          service.</p>
+ *
+ *
+ * @example To list the resource policies of a contact
+ * ```javascript
+ * // The following get-contact-policy example lists the resource policies associated with the specified contact.
+ * const input = {
+ *   "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
+ * };
+ * const command = new GetContactPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
+ *   "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/*\"]}]}"
+ * }
+ * *\/
+ * // example id: to-list-the-details-of-a-contact-channel-1630365682730
+ * ```
+ *
  */
 export declare class GetContactPolicyCommand extends $Command<GetContactPolicyCommandInput, GetContactPolicyCommandOutput, SSMContactsClientResolvedConfig> {
     readonly input: GetContactPolicyCommandInput;