aws-sdk-ssmincidents 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d919f09398406aa98e6710031732b4a5e0aedb099943af8c86ae5b87ceb4fd7
-  data.tar.gz: db55a7a8caba0320d3f6b167abe44b47aa1e6afd346df681426c12c7cca6db19
+  metadata.gz: f6b2ee80c3185adba475faa323cdcb7aad23956b8e8bed5c0df3618fc028c0c2
+  data.tar.gz: f6a3606e949f6714d562b103cb01827cae2a8bda0ded4a4cdc05d4818317cf3d
 SHA512:
-  metadata.gz: e108d75c92c8b530cd75578ec610a434e562095b31f546c3a32a4fb87579c4d44d3248325c41d9c1c9f836b95ac5d1380dae505be96ebdc2c39ea7fd3dcd5d14
-  data.tar.gz: 7b0510817cee41b787b24866c9359e508b8ad462f6251cfb4d52e07475692a812a67cd38657b3684b86fc13c7e867716d355b1919a9dd9456192b8e8aad615b4
+  metadata.gz: 4b68cd0b5b91f49994327420859795ba8210ea29e8d5f0a00fbfa5bd35d70b310a69758c181b4d1258b9ab729eba46aaa698bcda3d8c065d39474755459beebd
+  data.tar.gz: 9ce6c014fb9b1f9370d6991cfe00dd21b9b46840974f5ffa71cd4ab2b6e3c2e852621fc231ab09dcac009dd436bd5fef09d68f5440e762bc94381fe3b30988f2

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.19.0 (2022-11-11)
+------------------
+
+* Feature - 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.
+
 1.18.0 (2022-11-02)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.18.0
+1.19.0

data/lib/aws-sdk-ssmincidents/client.rb

@@ -533,6 +533,16 @@ module Aws::SSMIncidents
     # @option params [required, String] :event_data
     #   A short description of the event.
     #
+    # @option params [Array<Types::EventReference>] :event_references
+    #   Adds one or more references to the `TimelineEvent`. 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.
+    #
     # @option params [required, Time,DateTime,Date,Integer,String] :event_time
     #   The time that the event occurred.
     #
@@ -554,6 +564,12 @@ module Aws::SSMIncidents
     #   resp = client.create_timeline_event({
     #     client_token: "ClientToken",
     #     event_data: "EventData", # required
+    #     event_references: [
+    #       {
+    #         related_item_id: "GeneratedId",
+    #         resource: "Arn",
+    #       },
+    #     ],
     #     event_time: Time.now, # required
     #     event_type: "TimelineEventType", # required
     #     incident_record_arn: "Arn", # required
@@ -922,6 +938,9 @@ module Aws::SSMIncidents
     #
     #   resp.event.event_data #=> String
     #   resp.event.event_id #=> String
+    #   resp.event.event_references #=> Array
+    #   resp.event.event_references[0].related_item_id #=> String
+    #   resp.event.event_references[0].resource #=> String
     #   resp.event.event_time #=> Time
     #   resp.event.event_type #=> String
     #   resp.event.event_updated_time #=> Time
@@ -1051,6 +1070,7 @@ module Aws::SSMIncidents
     #
     #   resp.next_token #=> String
     #   resp.related_items #=> Array
+    #   resp.related_items[0].generated_id #=> String
     #   resp.related_items[0].identifier.type #=> String, one of "ANALYSIS", "INCIDENT", "METRIC", "PARENT", "ATTACHMENT", "OTHER", "AUTOMATION", "INVOLVED_RESOURCE", "TASK"
     #   resp.related_items[0].identifier.value.arn #=> String
     #   resp.related_items[0].identifier.value.metric_definition #=> String
@@ -1243,6 +1263,9 @@ module Aws::SSMIncidents
     #
     #   resp.event_summaries #=> Array
     #   resp.event_summaries[0].event_id #=> String
+    #   resp.event_summaries[0].event_references #=> Array
+    #   resp.event_summaries[0].event_references[0].related_item_id #=> String
+    #   resp.event_summaries[0].event_references[0].resource #=> String
     #   resp.event_summaries[0].event_time #=> Time
     #   resp.event_summaries[0].event_type #=> String
     #   resp.event_summaries[0].event_updated_time #=> Time
@@ -1357,6 +1380,7 @@ module Aws::SSMIncidents
     #     impact: 1,
     #     related_items: [
     #       {
+    #         generated_id: "GeneratedId",
     #         identifier: { # required
     #           type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
     #           value: { # required
@@ -1600,6 +1624,7 @@ module Aws::SSMIncidents
     #     incident_record_arn: "Arn", # required
     #     related_items_update: { # required
     #       item_to_add: {
+    #         generated_id: "GeneratedId",
     #         identifier: { # required
     #           type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
     #           value: { # required
@@ -1815,6 +1840,20 @@ module Aws::SSMIncidents
     #   The ID of the event you are updating. You can find this by using
     #   `ListTimelineEvents`.
     #
+    # @option params [Array<Types::EventReference>] :event_references
+    #   Updates all existing references in a `TimelineEvent`. 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.
+    #
+    #   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.
+    #
     # @option params [Time,DateTime,Date,Integer,String] :event_time
     #   The time that the event occurred.
     #
@@ -1833,6 +1872,12 @@ module Aws::SSMIncidents
     #     client_token: "ClientToken",
     #     event_data: "EventData",
     #     event_id: "UUID", # required
+    #     event_references: [
+    #       {
+    #         related_item_id: "GeneratedId",
+    #         resource: "Arn",
+    #       },
+    #     ],
     #     event_time: Time.now,
     #     event_type: "TimelineEventType",
     #     incident_record_arn: "Arn", # required
@@ -1860,7 +1905,7 @@ module Aws::SSMIncidents
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ssmincidents'
-      context[:gem_version] = '1.18.0'
+      context[:gem_version] = '1.19.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-ssmincidents/client_api.rb

@@ -51,12 +51,15 @@ module Aws::SSMIncidents
     EmptyChatChannel = Shapes::StructureShape.new(name: 'EmptyChatChannel')
     EngagementSet = Shapes::ListShape.new(name: 'EngagementSet')
     EventData = Shapes::StringShape.new(name: 'EventData')
+    EventReference = Shapes::UnionShape.new(name: 'EventReference')
+    EventReferenceList = Shapes::ListShape.new(name: 'EventReferenceList')
     EventSummary = Shapes::StructureShape.new(name: 'EventSummary')
     EventSummaryList = Shapes::ListShape.new(name: 'EventSummaryList')
     ExceptionMessage = Shapes::StringShape.new(name: 'ExceptionMessage')
     Filter = Shapes::StructureShape.new(name: 'Filter')
     FilterKeyString = Shapes::StringShape.new(name: 'FilterKeyString')
     FilterList = Shapes::ListShape.new(name: 'FilterList')
+    GeneratedId = Shapes::StringShape.new(name: 'GeneratedId')
     GetIncidentRecordInput = Shapes::StructureShape.new(name: 'GetIncidentRecordInput')
     GetIncidentRecordOutput = Shapes::StructureShape.new(name: 'GetIncidentRecordOutput')
     GetReplicationSetInput = Shapes::StructureShape.new(name: 'GetReplicationSetInput')
@@ -261,6 +264,7 @@ module Aws::SSMIncidents
 
     CreateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
     CreateTimelineEventInput.add_member(:event_data, Shapes::ShapeRef.new(shape: EventData, required: true, location_name: "eventData"))
+    CreateTimelineEventInput.add_member(:event_references, Shapes::ShapeRef.new(shape: EventReferenceList, location_name: "eventReferences"))
     CreateTimelineEventInput.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventTime"))
     CreateTimelineEventInput.add_member(:event_type, Shapes::ShapeRef.new(shape: TimelineEventType, required: true, location_name: "eventType"))
     CreateTimelineEventInput.add_member(:incident_record_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "incidentRecordArn"))
@@ -313,7 +317,18 @@ module Aws::SSMIncidents
 
     EngagementSet.member = Shapes::ShapeRef.new(shape: SsmContactsArn)
 
+    EventReference.add_member(:related_item_id, Shapes::ShapeRef.new(shape: GeneratedId, location_name: "relatedItemId"))
+    EventReference.add_member(:resource, Shapes::ShapeRef.new(shape: Arn, location_name: "resource"))
+    EventReference.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    EventReference.add_member_subclass(:related_item_id, Types::EventReference::RelatedItemId)
+    EventReference.add_member_subclass(:resource, Types::EventReference::Resource)
+    EventReference.add_member_subclass(:unknown, Types::EventReference::Unknown)
+    EventReference.struct_class = Types::EventReference
+
+    EventReferenceList.member = Shapes::ShapeRef.new(shape: EventReference)
+
     EventSummary.add_member(:event_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "eventId"))
+    EventSummary.add_member(:event_references, Shapes::ShapeRef.new(shape: EventReferenceList, location_name: "eventReferences"))
     EventSummary.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventTime"))
     EventSummary.add_member(:event_type, Shapes::ShapeRef.new(shape: TimelineEventType, required: true, location_name: "eventType"))
     EventSummary.add_member(:event_updated_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventUpdatedTime"))
@@ -510,6 +525,7 @@ module Aws::SSMIncidents
     RegionMapInputValue.add_member(:sse_kms_key_id, Shapes::ShapeRef.new(shape: SseKmsKey, location_name: "sseKmsKeyId"))
     RegionMapInputValue.struct_class = Types::RegionMapInputValue
 
+    RelatedItem.add_member(:generated_id, Shapes::ShapeRef.new(shape: GeneratedId, location_name: "generatedId"))
     RelatedItem.add_member(:identifier, Shapes::ShapeRef.new(shape: ItemIdentifier, required: true, location_name: "identifier"))
     RelatedItem.add_member(:title, Shapes::ShapeRef.new(shape: RelatedItemTitleString, location_name: "title"))
     RelatedItem.struct_class = Types::RelatedItem
@@ -609,6 +625,7 @@ module Aws::SSMIncidents
 
     TimelineEvent.add_member(:event_data, Shapes::ShapeRef.new(shape: EventData, required: true, location_name: "eventData"))
     TimelineEvent.add_member(:event_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "eventId"))
+    TimelineEvent.add_member(:event_references, Shapes::ShapeRef.new(shape: EventReferenceList, location_name: "eventReferences"))
     TimelineEvent.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventTime"))
     TimelineEvent.add_member(:event_type, Shapes::ShapeRef.new(shape: TimelineEventType, required: true, location_name: "eventType"))
     TimelineEvent.add_member(:event_updated_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "eventUpdatedTime"))
@@ -689,6 +706,7 @@ module Aws::SSMIncidents
     UpdateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
     UpdateTimelineEventInput.add_member(:event_data, Shapes::ShapeRef.new(shape: EventData, location_name: "eventData"))
     UpdateTimelineEventInput.add_member(:event_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "eventId"))
+    UpdateTimelineEventInput.add_member(:event_references, Shapes::ShapeRef.new(shape: EventReferenceList, location_name: "eventReferences"))
     UpdateTimelineEventInput.add_member(:event_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "eventTime"))
     UpdateTimelineEventInput.add_member(:event_type, Shapes::ShapeRef.new(shape: TimelineEventType, location_name: "eventType"))
     UpdateTimelineEventInput.add_member(:incident_record_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "incidentRecordArn"))

data/lib/aws-sdk-ssmincidents/types.rb

@@ -399,6 +399,12 @@ module Aws::SSMIncidents
     #       {
     #         client_token: "ClientToken",
     #         event_data: "EventData", # required
+    #         event_references: [
+    #           {
+    #             related_item_id: "GeneratedId",
+    #             resource: "Arn",
+    #           },
+    #         ],
     #         event_time: Time.now, # required
     #         event_type: "TimelineEventType", # required
     #         incident_record_arn: "Arn", # required
@@ -416,6 +422,17 @@ module Aws::SSMIncidents
     #   A short description of the event.
     #   @return [String]
     #
+    # @!attribute [rw] event_references
+    #   Adds one or more references to the `TimelineEvent`. 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.
+    #   @return [Array<Types::EventReference>]
+    #
     # @!attribute [rw] event_time
     #   The time that the event occurred.
     #   @return [Time]
@@ -435,6 +452,7 @@ module Aws::SSMIncidents
     class CreateTimelineEventInput < Struct.new(
       :client_token,
       :event_data,
+      :event_references,
       :event_time,
       :event_type,
       :incident_record_arn)
@@ -647,12 +665,48 @@ module Aws::SSMIncidents
     #
     class EmptyChatChannel < Aws::EmptyStructure; end
 
+    # An item referenced in a `TimelineEvent` 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 `RelatedItem` ID.
+    #
+    # @note EventReference is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note EventReference is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EventReference corresponding to the set member.
+    #
+    # @!attribute [rw] related_item_id
+    #   The ID of a `RelatedItem` referenced in a `TimelineEvent`.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource
+    #   The Amazon Resource Name (ARN) of an Amazon Web Services resource
+    #   referenced in a `TimelineEvent`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/EventReference AWS API Documentation
+    #
+    class EventReference < Struct.new(
+      :related_item_id,
+      :resource,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class RelatedItemId < EventReference; end
+      class Resource < EventReference; end
+      class Unknown < EventReference; end
+    end
+
     # Details about a timeline event during an incident.
     #
     # @!attribute [rw] event_id
     #   The timeline event ID.
     #   @return [String]
     #
+    # @!attribute [rw] event_references
+    #   A list of references in a `TimelineEvent`.
+    #   @return [Array<Types::EventReference>]
+    #
     # @!attribute [rw] event_time
     #   The time that the event occurred.
     #   @return [Time]
@@ -674,6 +728,7 @@ module Aws::SSMIncidents
     #
     class EventSummary < Struct.new(
       :event_id,
+      :event_references,
       :event_time,
       :event_type,
       :event_updated_time,
@@ -1704,6 +1759,7 @@ module Aws::SSMIncidents
     #   data as a hash:
     #
     #       {
+    #         generated_id: "GeneratedId",
     #         identifier: { # required
     #           type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
     #           value: { # required
@@ -1715,6 +1771,13 @@ module Aws::SSMIncidents
     #         title: "RelatedItemTitleString",
     #       }
     #
+    # @!attribute [rw] generated_id
+    #   A unique ID for a `RelatedItem`.
+    #
+    #   Don't specify this parameter when you add a `RelatedItem` by using
+    #   the UpdateRelatedItems API action.
+    #   @return [String]
+    #
     # @!attribute [rw] identifier
     #   Details about the related item.
     #   @return [Types::ItemIdentifier]
@@ -1726,6 +1789,7 @@ module Aws::SSMIncidents
     # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/RelatedItem AWS API Documentation
     #
     class RelatedItem < Struct.new(
+      :generated_id,
       :identifier,
       :title)
       SENSITIVE = []
@@ -1990,6 +2054,7 @@ module Aws::SSMIncidents
     #         impact: 1,
     #         related_items: [
     #           {
+    #             generated_id: "GeneratedId",
     #             identifier: { # required
     #               type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
     #               value: { # required
@@ -2152,6 +2217,10 @@ module Aws::SSMIncidents
     #   The ID of the timeline event.
     #   @return [String]
     #
+    # @!attribute [rw] event_references
+    #   A list of references in a `TimelineEvent`.
+    #   @return [Array<Types::EventReference>]
+    #
     # @!attribute [rw] event_time
     #   The time that the event occurred.
     #   @return [Time]
@@ -2175,6 +2244,7 @@ module Aws::SSMIncidents
     class TimelineEvent < Struct.new(
       :event_data,
       :event_id,
+      :event_references,
       :event_time,
       :event_type,
       :event_updated_time,
@@ -2407,6 +2477,7 @@ module Aws::SSMIncidents
     #         incident_record_arn: "Arn", # required
     #         related_items_update: { # required
     #           item_to_add: {
+    #             generated_id: "GeneratedId",
     #             identifier: { # required
     #               type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER, AUTOMATION, INVOLVED_RESOURCE, TASK
     #               value: { # required
@@ -2692,6 +2763,12 @@ module Aws::SSMIncidents
     #         client_token: "ClientToken",
     #         event_data: "EventData",
     #         event_id: "UUID", # required
+    #         event_references: [
+    #           {
+    #             related_item_id: "GeneratedId",
+    #             resource: "Arn",
+    #           },
+    #         ],
     #         event_time: Time.now,
     #         event_type: "TimelineEventType",
     #         incident_record_arn: "Arn", # required
@@ -2714,6 +2791,21 @@ module Aws::SSMIncidents
     #   `ListTimelineEvents`.
     #   @return [String]
     #
+    # @!attribute [rw] event_references
+    #   Updates all existing references in a `TimelineEvent`. 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.
+    #
+    #   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.
+    #   @return [Array<Types::EventReference>]
+    #
     # @!attribute [rw] event_time
     #   The time that the event occurred.
     #   @return [Time]
@@ -2733,6 +2825,7 @@ module Aws::SSMIncidents
       :client_token,
       :event_data,
       :event_id,
+      :event_references,
       :event_time,
       :event_type,
       :incident_record_arn)

data/lib/aws-sdk-ssmincidents.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-ssmincidents/customizations'
 # @!group service
 module Aws::SSMIncidents
 
-  GEM_VERSION = '1.18.0'
+  GEM_VERSION = '1.19.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ssmincidents
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2022-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core