@aws-sdk/client-ssm-incidents 3.299.0 → 3.301.0

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

@@ -20,13 +20,44 @@ export interface StartIncidentCommandOutput extends StartIncidentOutput, __Metad
 /**
  * @public
  * <p>Used to start an incident from CloudWatch alarms, EventBridge events, or
- *             manually. </p>
+ *       manually. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
  * import { SSMIncidentsClient, StartIncidentCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
  * // const { SSMIncidentsClient, StartIncidentCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
  * const client = new SSMIncidentsClient(config);
+ * const input = { // StartIncidentInput
+ *   clientToken: "STRING_VALUE",
+ *   responsePlanArn: "STRING_VALUE", // required
+ *   title: "STRING_VALUE",
+ *   impact: Number("int"),
+ *   triggerDetails: { // TriggerDetails
+ *     source: "STRING_VALUE", // required
+ *     triggerArn: "STRING_VALUE",
+ *     timestamp: new Date("TIMESTAMP"), // required
+ *     rawData: "STRING_VALUE",
+ *   },
+ *   relatedItems: [ // RelatedItemList
+ *     { // RelatedItem
+ *       identifier: { // ItemIdentifier
+ *         value: { // ItemValue Union: only one key present
+ *           arn: "STRING_VALUE",
+ *           url: "STRING_VALUE",
+ *           metricDefinition: "STRING_VALUE",
+ *           pagerDutyIncidentDetail: { // PagerDutyIncidentDetail
+ *             id: "STRING_VALUE", // required
+ *             autoResolve: true || false,
+ *             secretId: "STRING_VALUE",
+ *           },
+ *         },
+ *         type: "STRING_VALUE", // required
+ *       },
+ *       title: "STRING_VALUE",
+ *       generatedId: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new StartIncidentCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,12 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * import { SSMIncidentsClient, TagResourceCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
  * // const { SSMIncidentsClient, TagResourceCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
  * const client = new SSMIncidentsClient(config);
+ * const input = { // TagResourceRequest
+ *   resourceArn: "STRING_VALUE", // required
+ *   tags: { // TagMap // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
  * const command = new TagResourceCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,12 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * import { SSMIncidentsClient, UntagResourceCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
  * // const { SSMIncidentsClient, UntagResourceCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
  * const client = new SSMIncidentsClient(config);
+ * const input = { // UntagResourceRequest
+ *   resourceArn: "STRING_VALUE", // required
+ *   tagKeys: [ // TagKeyList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
  * const command = new UntagResourceCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -20,13 +20,18 @@ export interface UpdateDeletionProtectionCommandOutput extends UpdateDeletionPro
 /**
  * @public
  * <p>Update deletion protection to either allow or deny deletion of the final Region in a
- *             replication set.</p>
+ *       replication set.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
  * import { SSMIncidentsClient, UpdateDeletionProtectionCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
  * // const { SSMIncidentsClient, UpdateDeletionProtectionCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
  * const client = new SSMIncidentsClient(config);
+ * const input = { // UpdateDeletionProtectionInput
+ *   arn: "STRING_VALUE", // required
+ *   deletionProtected: true || false, // required
+ *   clientToken: "STRING_VALUE",
+ * };
  * const command = new UpdateDeletionProtectionCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -19,15 +19,34 @@ export interface UpdateIncidentRecordCommandOutput extends UpdateIncidentRecordO
 }
 /**
  * @public
- * <p>Update the details of an incident record. You can use this operation to update an
- *             incident record from the defined chat channel. For more information about using actions
- *             in chat channels, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact">Interacting through chat</a>.</p>
+ * <p>Update the details of an incident record. You can use this operation to update an incident
+ *       record from the defined chat channel. For more information about using actions in chat
+ *       channels, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact">Interacting through chat</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
  * import { SSMIncidentsClient, UpdateIncidentRecordCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
  * // const { SSMIncidentsClient, UpdateIncidentRecordCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
  * const client = new SSMIncidentsClient(config);
+ * const input = { // UpdateIncidentRecordInput
+ *   clientToken: "STRING_VALUE",
+ *   arn: "STRING_VALUE", // required
+ *   title: "STRING_VALUE",
+ *   summary: "STRING_VALUE",
+ *   impact: Number("int"),
+ *   status: "STRING_VALUE",
+ *   chatChannel: { // ChatChannel Union: only one key present
+ *     empty: {},
+ *     chatbotSns: [ // ChatbotSnsConfigurationSet
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   notificationTargets: [ // NotificationTargetSet
+ *     { // NotificationTargetItem Union: only one key present
+ *       snsTopicArn: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new UpdateIncidentRecordCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,42 @@ export interface UpdateRelatedItemsCommandOutput extends UpdateRelatedItemsOutpu
  * import { SSMIncidentsClient, UpdateRelatedItemsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
  * // const { SSMIncidentsClient, UpdateRelatedItemsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
  * const client = new SSMIncidentsClient(config);
+ * const input = { // UpdateRelatedItemsInput
+ *   clientToken: "STRING_VALUE",
+ *   incidentRecordArn: "STRING_VALUE", // required
+ *   relatedItemsUpdate: { // RelatedItemsUpdate Union: only one key present
+ *     itemToAdd: { // RelatedItem
+ *       identifier: { // ItemIdentifier
+ *         value: { // ItemValue Union: only one key present
+ *           arn: "STRING_VALUE",
+ *           url: "STRING_VALUE",
+ *           metricDefinition: "STRING_VALUE",
+ *           pagerDutyIncidentDetail: { // PagerDutyIncidentDetail
+ *             id: "STRING_VALUE", // required
+ *             autoResolve: true || false,
+ *             secretId: "STRING_VALUE",
+ *           },
+ *         },
+ *         type: "STRING_VALUE", // required
+ *       },
+ *       title: "STRING_VALUE",
+ *       generatedId: "STRING_VALUE",
+ *     },
+ *     itemToRemove: {
+ *       value: {//  Union: only one key present
+ *         arn: "STRING_VALUE",
+ *         url: "STRING_VALUE",
+ *         metricDefinition: "STRING_VALUE",
+ *         pagerDutyIncidentDetail: {
+ *           id: "STRING_VALUE", // required
+ *           autoResolve: true || false,
+ *           secretId: "STRING_VALUE",
+ *         },
+ *       },
+ *       type: "STRING_VALUE", // required
+ *     },
+ *   },
+ * };
  * const command = new UpdateRelatedItemsCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,21 @@ export interface UpdateReplicationSetCommandOutput extends UpdateReplicationSetO
  * import { SSMIncidentsClient, UpdateReplicationSetCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
  * // const { SSMIncidentsClient, UpdateReplicationSetCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
  * const client = new SSMIncidentsClient(config);
+ * const input = { // UpdateReplicationSetInput
+ *   arn: "STRING_VALUE", // required
+ *   actions: [ // UpdateActionList // required
+ *     { // UpdateReplicationSetAction Union: only one key present
+ *       addRegionAction: { // AddRegionAction
+ *         regionName: "STRING_VALUE", // required
+ *         sseKmsKeyId: "STRING_VALUE",
+ *       },
+ *       deleteRegionAction: { // DeleteRegionAction
+ *         regionName: "STRING_VALUE", // required
+ *       },
+ *     },
+ *   ],
+ *   clientToken: "STRING_VALUE",
+ * };
  * const command = new UpdateReplicationSetCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,63 @@ export interface UpdateResponsePlanCommandOutput extends UpdateResponsePlanOutpu
  * import { SSMIncidentsClient, UpdateResponsePlanCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
  * // const { SSMIncidentsClient, UpdateResponsePlanCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
  * const client = new SSMIncidentsClient(config);
+ * const input = { // UpdateResponsePlanInput
+ *   clientToken: "STRING_VALUE",
+ *   arn: "STRING_VALUE", // required
+ *   displayName: "STRING_VALUE",
+ *   incidentTemplateTitle: "STRING_VALUE",
+ *   incidentTemplateImpact: Number("int"),
+ *   incidentTemplateSummary: "STRING_VALUE",
+ *   incidentTemplateDedupeString: "STRING_VALUE",
+ *   incidentTemplateNotificationTargets: [ // NotificationTargetSet
+ *     { // NotificationTargetItem Union: only one key present
+ *       snsTopicArn: "STRING_VALUE",
+ *     },
+ *   ],
+ *   chatChannel: { // ChatChannel Union: only one key present
+ *     empty: {},
+ *     chatbotSns: [ // ChatbotSnsConfigurationSet
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   engagements: [ // EngagementSet
+ *     "STRING_VALUE",
+ *   ],
+ *   actions: [ // ActionsList
+ *     { // Action Union: only one key present
+ *       ssmAutomation: { // SsmAutomation
+ *         roleArn: "STRING_VALUE", // required
+ *         documentName: "STRING_VALUE", // required
+ *         documentVersion: "STRING_VALUE",
+ *         targetAccount: "STRING_VALUE",
+ *         parameters: { // SsmParameters
+ *           "<keys>": [ // SsmParameterValues
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         dynamicParameters: { // DynamicSsmParameters
+ *           "<keys>": { // DynamicSsmParameterValue Union: only one key present
+ *             variable: "STRING_VALUE",
+ *           },
+ *         },
+ *       },
+ *     },
+ *   ],
+ *   incidentTemplateTags: { // TagMapUpdate
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   integrations: [ // Integrations
+ *     { // Integration Union: only one key present
+ *       pagerDutyConfiguration: { // PagerDutyConfiguration
+ *         name: "STRING_VALUE", // required
+ *         secretId: "STRING_VALUE", // required
+ *         pagerDutyIncidentConfiguration: { // PagerDutyIncidentConfiguration
+ *           serviceId: "STRING_VALUE", // required
+ *         },
+ *       },
+ *     },
+ *   ],
+ * };
  * const command = new UpdateResponsePlanCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -19,14 +19,27 @@ export interface UpdateTimelineEventCommandOutput extends UpdateTimelineEventOut
 }
 /**
  * @public
- * <p>Updates a timeline event. You can update events of type <code>Custom
- *             Event</code>.</p>
+ * <p>Updates a timeline event. You can update events of type <code>Custom Event</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
  * import { SSMIncidentsClient, UpdateTimelineEventCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
  * // const { SSMIncidentsClient, UpdateTimelineEventCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
  * const client = new SSMIncidentsClient(config);
+ * const input = { // UpdateTimelineEventInput
+ *   clientToken: "STRING_VALUE",
+ *   incidentRecordArn: "STRING_VALUE", // required
+ *   eventId: "STRING_VALUE", // required
+ *   eventTime: new Date("TIMESTAMP"),
+ *   eventType: "STRING_VALUE",
+ *   eventData: "STRING_VALUE",
+ *   eventReferences: [ // EventReferenceList
+ *     { // EventReference Union: only one key present
+ *       resource: "STRING_VALUE",
+ *       relatedItemId: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new UpdateTimelineEventCommand(input);
  * const response = await client.send(command);
  * ```