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

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

@@ -26,9 +26,9 @@ 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 = {
+ * const input = { // TagResourceRequest
  *   resourceArn: "STRING_VALUE", // required
- *   tags: { // required
+ *   tags: { // TagMap // required
  *     "<keys>": "STRING_VALUE",
  *   },
  * };

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

@@ -26,9 +26,9 @@ 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 = {
+ * const input = { // UntagResourceRequest
  *   resourceArn: "STRING_VALUE", // required
- *   tagKeys: [ // required
+ *   tagKeys: [ // TagKeyList // required
  *     "STRING_VALUE",
  *   ],
  * };

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

@@ -20,14 +20,14 @@ 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 = {
+ * const input = { // UpdateDeletionProtectionInput
  *   arn: "STRING_VALUE", // required
  *   deletionProtected: true || false, // required
  *   clientToken: "STRING_VALUE",

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

@@ -19,30 +19,30 @@ 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 = {
+ * const input = { // UpdateIncidentRecordInput
  *   clientToken: "STRING_VALUE",
  *   arn: "STRING_VALUE", // required
  *   title: "STRING_VALUE",
  *   summary: "STRING_VALUE",
  *   impact: Number("int"),
  *   status: "STRING_VALUE",
- *   chatChannel: { // Union: only one key present
+ *   chatChannel: { // ChatChannel Union: only one key present
  *     empty: {},
- *     chatbotSns: [
+ *     chatbotSns: [ // ChatbotSnsConfigurationSet
  *       "STRING_VALUE",
  *     ],
  *   },
- *   notificationTargets: [
- *     { // Union: only one key present
+ *   notificationTargets: [ // NotificationTargetSet
+ *     { // NotificationTargetItem Union: only one key present
  *       snsTopicArn: "STRING_VALUE",
  *     },
  *   ],

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

@@ -26,17 +26,17 @@ 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 = {
+ * const input = { // UpdateRelatedItemsInput
  *   clientToken: "STRING_VALUE",
  *   incidentRecordArn: "STRING_VALUE", // required
- *   relatedItemsUpdate: { // Union: only one key present
- *     itemToAdd: {
- *       identifier: {
- *         value: { // Union: only one key present
+ *   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: { // PagerDutyIncidentDetail
  *             id: "STRING_VALUE", // required
  *             autoResolve: true || false,
  *             secretId: "STRING_VALUE",
@@ -48,7 +48,7 @@ export interface UpdateRelatedItemsCommandOutput extends UpdateRelatedItemsOutpu
  *       generatedId: "STRING_VALUE",
  *     },
  *     itemToRemove: {
- *       value: { // Union: only one key present
+ *       value: {//  Union: only one key present
  *         arn: "STRING_VALUE",
  *         url: "STRING_VALUE",
  *         metricDefinition: "STRING_VALUE",

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

@@ -26,15 +26,15 @@ 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 = {
+ * const input = { // UpdateReplicationSetInput
  *   arn: "STRING_VALUE", // required
- *   actions: [ // required
- *     { // Union: only one key present
- *       addRegionAction: {
+ *   actions: [ // UpdateActionList // required
+ *     { // UpdateReplicationSetAction Union: only one key present
+ *       addRegionAction: { // AddRegionAction
  *         regionName: "STRING_VALUE", // required
  *         sseKmsKeyId: "STRING_VALUE",
  *       },
- *       deleteRegionAction: {
+ *       deleteRegionAction: { // DeleteRegionAction
  *         regionName: "STRING_VALUE", // required
  *       },
  *     },

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

@@ -26,7 +26,7 @@ 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 = {
+ * const input = { // UpdateResponsePlanInput
  *   clientToken: "STRING_VALUE",
  *   arn: "STRING_VALUE", // required
  *   displayName: "STRING_VALUE",
@@ -34,49 +34,49 @@ export interface UpdateResponsePlanCommandOutput extends UpdateResponsePlanOutpu
  *   incidentTemplateImpact: Number("int"),
  *   incidentTemplateSummary: "STRING_VALUE",
  *   incidentTemplateDedupeString: "STRING_VALUE",
- *   incidentTemplateNotificationTargets: [
- *     { // Union: only one key present
+ *   incidentTemplateNotificationTargets: [ // NotificationTargetSet
+ *     { // NotificationTargetItem Union: only one key present
  *       snsTopicArn: "STRING_VALUE",
  *     },
  *   ],
- *   chatChannel: { // Union: only one key present
+ *   chatChannel: { // ChatChannel Union: only one key present
  *     empty: {},
- *     chatbotSns: [
+ *     chatbotSns: [ // ChatbotSnsConfigurationSet
  *       "STRING_VALUE",
  *     ],
  *   },
- *   engagements: [
+ *   engagements: [ // EngagementSet
  *     "STRING_VALUE",
  *   ],
- *   actions: [
- *     { // Union: only one key present
- *       ssmAutomation: {
+ *   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: {
- *           "<keys>": [
+ *         parameters: { // SsmParameters
+ *           "<keys>": [ // SsmParameterValues
  *             "STRING_VALUE",
  *           ],
  *         },
- *         dynamicParameters: {
- *           "<keys>": { // Union: only one key present
+ *         dynamicParameters: { // DynamicSsmParameters
+ *           "<keys>": { // DynamicSsmParameterValue Union: only one key present
  *             variable: "STRING_VALUE",
  *           },
  *         },
  *       },
  *     },
  *   ],
- *   incidentTemplateTags: {
+ *   incidentTemplateTags: { // TagMapUpdate
  *     "<keys>": "STRING_VALUE",
  *   },
- *   integrations: [
- *     { // Union: only one key present
- *       pagerDutyConfiguration: {
+ *   integrations: [ // Integrations
+ *     { // Integration Union: only one key present
+ *       pagerDutyConfiguration: { // PagerDutyConfiguration
  *         name: "STRING_VALUE", // required
  *         secretId: "STRING_VALUE", // required
- *         pagerDutyIncidentConfiguration: {
+ *         pagerDutyIncidentConfiguration: { // PagerDutyIncidentConfiguration
  *           serviceId: "STRING_VALUE", // required
  *         },
  *       },

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

@@ -19,23 +19,22 @@ 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 = {
+ * 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: [
- *     { // Union: only one key present
+ *   eventReferences: [ // EventReferenceList
+ *     { // EventReference Union: only one key present
  *       resource: "STRING_VALUE",
  *       relatedItemId: "STRING_VALUE",
  *     },