feat(client-ssm-incidents): RelatedItems now have an ID field which can be used for referencing them else where. Introducing event references in TimelineEvent API and increasing maximum length of "eventData" to 12K characters.

Author: awstools

clients/client-ssm-incidents/src/models/models_0.ts

@@ -610,8 +610,7 @@ export interface IncidentTemplate {
 
   /**
    * <p>Tags to assign to the template. When the <code>StartIncident</code> API action is
-   *          called, Incident Manager assigns the tags specified in the template to the
-   *          incident.</p>
+   *          called, Incident Manager assigns the tags specified in the template to the incident.</p>
    */
   incidentTags?: Record<string, string>;
 }
@@ -699,6 +698,55 @@ export class ResourceNotFoundException extends __BaseException {
   }
 }
 
+/**
+ * <p>An item referenced in a <code>TimelineEvent</code> that is involved in or somehow
+ *          associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services
+ *          resource or a <code>RelatedItem</code> ID.</p>
+ */
+export type EventReference =
+  | EventReference.RelatedItemIdMember
+  | EventReference.ResourceMember
+  | EventReference.$UnknownMember;
+
+export namespace EventReference {
+  /**
+   * <p>The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a
+   *             <code>TimelineEvent</code>.</p>
+   */
+  export interface ResourceMember {
+    resource: string;
+    relatedItemId?: never;
+    $unknown?: never;
+  }
+
+  /**
+   * <p>The ID of a <code>RelatedItem</code> referenced in a <code>TimelineEvent</code>.</p>
+   */
+  export interface RelatedItemIdMember {
+    resource?: never;
+    relatedItemId: string;
+    $unknown?: never;
+  }
+
+  export interface $UnknownMember {
+    resource?: never;
+    relatedItemId?: never;
+    $unknown: [string, any];
+  }
+
+  export interface Visitor<T> {
+    resource: (value: string) => T;
+    relatedItemId: (value: string) => T;
+    _: (name: string, value: any) => T;
+  }
+
+  export const visit = <T>(value: EventReference, visitor: Visitor<T>): T => {
+    if (value.resource !== undefined) return visitor.resource(value.resource);
+    if (value.relatedItemId !== undefined) return visitor.relatedItemId(value.relatedItemId);
+    return visitor._(value.$unknown[0], value.$unknown[1]);
+  };
+}
+
 export interface CreateTimelineEventInput {
   /**
    * <p>A token ensuring that the action is called only once with the specified
@@ -727,6 +775,11 @@ export interface CreateTimelineEventInput {
    * <p>A short description of the event.</p>
    */
   eventData: string | undefined;
+
+  /**
+   * <p>Adds one or more references to the <code>TimelineEvent</code>. A reference can be an Amazon Web Services resource involved in the incident or in some way associated with it. When you specify a reference, you enter the Amazon Resource Name (ARN) of the resource. You can also specify a related item. As an example, you could specify the ARN of an Amazon DynamoDB (DynamoDB) table. The table for this example is the resource. You could also specify a Amazon CloudWatch metric for that table. The metric is the related item.</p>
+   */
+  eventReferences?: EventReference[];
 }
 
 export interface CreateTimelineEventOutput {
@@ -838,6 +891,11 @@ export interface EventSummary {
    * <p>The type of event. The timeline event must be <code>Custom Event</code>.</p>
    */
   eventType: string | undefined;
+
+  /**
+   * <p>A list of references in a <code>TimelineEvent</code>.</p>
+   */
+  eventReferences?: EventReference[];
 }
 
 /**
@@ -1256,6 +1314,11 @@ export interface TimelineEvent {
    * <p>A short description of the event.</p>
    */
   eventData: string | undefined;
+
+  /**
+   * <p>A list of references in a <code>TimelineEvent</code>.</p>
+   */
+  eventReferences?: EventReference[];
 }
 
 export interface GetTimelineEventOutput {
@@ -1494,6 +1557,15 @@ export interface RelatedItem {
    * <p>The title of the related item.</p>
    */
   title?: string;
+
+  /**
+   * <p>A unique ID for a <code>RelatedItem</code>.</p>
+   *          <important>
+   *             <p>Don't specify this parameter when you add a <code>RelatedItem</code> by using the
+   *                <a>UpdateRelatedItems</a> API action.</p>
+   *          </important>
+   */
+  generatedId?: string;
 }
 
 export interface ListRelatedItemsOutput {
@@ -2192,6 +2264,16 @@ export interface UpdateTimelineEventInput {
    * <p>A short description of the event.</p>
    */
   eventData?: string;
+
+  /**
+   * <p>Updates all existing references in a <code>TimelineEvent</code>. A reference can be an Amazon Web Services resource involved in the incident or in some way associated with it. When you specify a reference, you enter the Amazon Resource Name (ARN) of the resource. You can also specify a related item. As an example, you could specify the ARN of an Amazon DynamoDB (DynamoDB) table. The table for this example is the resource. You could also specify a Amazon CloudWatch metric for that table. The metric is the related item.</p>
+   *         <important>
+   *             <p>This update action overrides all existing references. If you want to keep existing
+   *                 references, you must specify them in the call. If you don't, this action removes
+   *                 them and enters only new references.</p>
+   *         </important>
+   */
+  eventReferences?: EventReference[];
 }
 
 export interface UpdateTimelineEventOutput {}
@@ -2334,11 +2416,23 @@ export const CreateResponsePlanOutputFilterSensitiveLog = (obj: CreateResponsePl
   ...obj,
 });
 
+/**
+ * @internal
+ */
+export const EventReferenceFilterSensitiveLog = (obj: EventReference): any => {
+  if (obj.resource !== undefined) return { resource: obj.resource };
+  if (obj.relatedItemId !== undefined) return { relatedItemId: obj.relatedItemId };
+  if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
+};
+
 /**
  * @internal
  */
 export const CreateTimelineEventInputFilterSensitiveLog = (obj: CreateTimelineEventInput): any => ({
   ...obj,
+  ...(obj.eventReferences && {
+    eventReferences: obj.eventReferences.map((item) => EventReferenceFilterSensitiveLog(item)),
+  }),
 });
 
 /**
@@ -2430,6 +2524,9 @@ export const DeleteTimelineEventOutputFilterSensitiveLog = (obj: DeleteTimelineE
  */
 export const EventSummaryFilterSensitiveLog = (obj: EventSummary): any => ({
   ...obj,
+  ...(obj.eventReferences && {
+    eventReferences: obj.eventReferences.map((item) => EventReferenceFilterSensitiveLog(item)),
+  }),
 });
 
 /**
@@ -2554,13 +2651,17 @@ export const GetTimelineEventInputFilterSensitiveLog = (obj: GetTimelineEventInp
  */
 export const TimelineEventFilterSensitiveLog = (obj: TimelineEvent): any => ({
   ...obj,
+  ...(obj.eventReferences && {
+    eventReferences: obj.eventReferences.map((item) => EventReferenceFilterSensitiveLog(item)),
+  }),
 });
 
 /**
  * @internal
  */
 export const GetTimelineEventOutputFilterSensitiveLog = (obj: GetTimelineEventOutput): any => ({
   ...obj,
+  ...(obj.event && { event: TimelineEventFilterSensitiveLog(obj.event) }),
 });
 
 /**
@@ -2688,6 +2789,7 @@ export const ListTimelineEventsInputFilterSensitiveLog = (obj: ListTimelineEvent
  */
 export const ListTimelineEventsOutputFilterSensitiveLog = (obj: ListTimelineEventsOutput): any => ({
   ...obj,
+  ...(obj.eventSummaries && { eventSummaries: obj.eventSummaries.map((item) => EventSummaryFilterSensitiveLog(item)) }),
 });
 
 /**
@@ -2862,6 +2964,9 @@ export const UpdateResponsePlanOutputFilterSensitiveLog = (obj: UpdateResponsePl
  */
 export const UpdateTimelineEventInputFilterSensitiveLog = (obj: UpdateTimelineEventInput): any => ({
   ...obj,
+  ...(obj.eventReferences && {
+    eventReferences: obj.eventReferences.map((item) => EventReferenceFilterSensitiveLog(item)),
+  }),
 });
 
 /**

clients/client-ssm-incidents/src/protocols/Aws_restJson1.ts

@@ -105,6 +105,7 @@ import {
   DeleteRegionAction,
   DynamicSsmParameterValue,
   EmptyChatChannel,
+  EventReference,
   EventSummary,
   Filter,
   IncidentRecord,
@@ -205,6 +206,9 @@ export const serializeAws_restJson1CreateTimelineEventCommand = async (
   body = JSON.stringify({
     clientToken: input.clientToken ?? generateIdempotencyToken(),
     ...(input.eventData != null && { eventData: input.eventData }),
+    ...(input.eventReferences != null && {
+      eventReferences: serializeAws_restJson1EventReferenceList(input.eventReferences, context),
+    }),
     ...(input.eventTime != null && { eventTime: Math.round(input.eventTime.getTime() / 1000) }),
     ...(input.eventType != null && { eventType: input.eventType }),
     ...(input.incidentRecordArn != null && { incidentRecordArn: input.incidentRecordArn }),
@@ -893,6 +897,9 @@ export const serializeAws_restJson1UpdateTimelineEventCommand = async (
     clientToken: input.clientToken ?? generateIdempotencyToken(),
     ...(input.eventData != null && { eventData: input.eventData }),
     ...(input.eventId != null && { eventId: input.eventId }),
+    ...(input.eventReferences != null && {
+      eventReferences: serializeAws_restJson1EventReferenceList(input.eventReferences, context),
+    }),
     ...(input.eventTime != null && { eventTime: Math.round(input.eventTime.getTime() / 1000) }),
     ...(input.eventType != null && { eventType: input.eventType }),
     ...(input.incidentRecordArn != null && { incidentRecordArn: input.incidentRecordArn }),
@@ -2707,6 +2714,22 @@ const serializeAws_restJson1EngagementSet = (input: string[], context: __SerdeCo
     });
 };
 
+const serializeAws_restJson1EventReference = (input: EventReference, context: __SerdeContext): any => {
+  return EventReference.visit(input, {
+    relatedItemId: (value) => ({ relatedItemId: value }),
+    resource: (value) => ({ resource: value }),
+    _: (name, value) => ({ name: value } as any),
+  });
+};
+
+const serializeAws_restJson1EventReferenceList = (input: EventReference[], context: __SerdeContext): any => {
+  return input
+    .filter((e: any) => e != null)
+    .map((entry) => {
+      return serializeAws_restJson1EventReference(entry, context);
+    });
+};
+
 const serializeAws_restJson1Filter = (input: Filter, context: __SerdeContext): any => {
   return {
     ...(input.condition != null && { condition: serializeAws_restJson1Condition(input.condition, context) }),
@@ -2797,6 +2820,7 @@ const serializeAws_restJson1RegionMapInputValue = (input: RegionMapInputValue, c
 
 const serializeAws_restJson1RelatedItem = (input: RelatedItem, context: __SerdeContext): any => {
   return {
+    ...(input.generatedId != null && { generatedId: input.generatedId }),
     ...(input.identifier != null && { identifier: serializeAws_restJson1ItemIdentifier(input.identifier, context) }),
     ...(input.title != null && { title: input.title }),
   };
@@ -3021,9 +3045,35 @@ const deserializeAws_restJson1EngagementSet = (output: any, context: __SerdeCont
   return retVal;
 };
 
+const deserializeAws_restJson1EventReference = (output: any, context: __SerdeContext): EventReference => {
+  if (__expectString(output.relatedItemId) !== undefined) {
+    return { relatedItemId: __expectString(output.relatedItemId) as any };
+  }
+  if (__expectString(output.resource) !== undefined) {
+    return { resource: __expectString(output.resource) as any };
+  }
+  return { $unknown: Object.entries(output)[0] };
+};
+
+const deserializeAws_restJson1EventReferenceList = (output: any, context: __SerdeContext): EventReference[] => {
+  const retVal = (output || [])
+    .filter((e: any) => e != null)
+    .map((entry: any) => {
+      if (entry === null) {
+        return null as any;
+      }
+      return deserializeAws_restJson1EventReference(__expectUnion(entry), context);
+    });
+  return retVal;
+};
+
 const deserializeAws_restJson1EventSummary = (output: any, context: __SerdeContext): EventSummary => {
   return {
     eventId: __expectString(output.eventId),
+    eventReferences:
+      output.eventReferences != null
+        ? deserializeAws_restJson1EventReferenceList(output.eventReferences, context)
+        : undefined,
     eventTime:
       output.eventTime != null ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.eventTime))) : undefined,
     eventType: __expectString(output.eventType),
@@ -3218,6 +3268,7 @@ const deserializeAws_restJson1RegionInfoMap = (output: any, context: __SerdeCont
 
 const deserializeAws_restJson1RelatedItem = (output: any, context: __SerdeContext): RelatedItem => {
   return {
+    generatedId: __expectString(output.generatedId),
     identifier:
       output.identifier != null ? deserializeAws_restJson1ItemIdentifier(output.identifier, context) : undefined,
     title: __expectString(output.title),
@@ -3365,6 +3416,10 @@ const deserializeAws_restJson1TimelineEvent = (output: any, context: __SerdeCont
   return {
     eventData: __expectString(output.eventData),
     eventId: __expectString(output.eventId),
+    eventReferences:
+      output.eventReferences != null
+        ? deserializeAws_restJson1EventReferenceList(output.eventReferences, context)
+        : undefined,
     eventTime:
       output.eventTime != null ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.eventTime))) : undefined,
     eventType: __expectString(output.eventType),