aws-sdk-ssmincidents 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f314f025f5572783a552f444e5c6c6fcf22e40157a8a91e48ec6481f1f53351b
-  data.tar.gz: 45dfffb85369562edab2b76f1ffa53f518c88b5aa349d54ff24013b0a2da33ab
+  metadata.gz: a89e3d7bf92a0a0fdaaca35f7ed89af08ae3c3fdb7ab3c07912603f9be946425
+  data.tar.gz: bed65e0e1ccba74719fe2674f5c5fbedc54e0bff58fefa64f7a0c67b99466d99
 SHA512:
-  metadata.gz: 4145af8931615dba9beb7f6043b0ca007ef374e8b197f81d7de914603ff93c81f63fa6b0b3a31fa68bfebf2b112cf86b81c418891a18a94cf27e8ab2a8bd2805
-  data.tar.gz: b17328e7c5f0bdf0ab83677186b50766afc74da6c62f5e287444f227d90e05673772f120d17833e656ad00e7a1448b8e3ebdfe0c4f8fb3526b4b5f8bfc03dac3
+  metadata.gz: 25815331e96efc1f0facba2547e8cf7ca99512d0c0701170e01665b7a453d1e40de963ce23909acb2bb49c9a16aa7792c31188357e059cb91265fd3ba3a5cc69
+  data.tar.gz: f83bd9ae08057f2eebcb08419c68212b5745482b863c9df080120d3b936c3418279aa18ef9a24418639bba07900ec1b82f6d8c90c249a114e1b6cf81afcd8832

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.3.0 (2021-08-04)
+------------------
+
+* Feature - Documentation updates for Incident Manager.
+
 1.2.0 (2021-07-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/lib/aws-sdk-ssmincidents.rb

@@ -49,6 +49,6 @@ require_relative 'aws-sdk-ssmincidents/customizations'
 # @!group service
 module Aws::SSMIncidents
 
-  GEM_VERSION = '1.2.0'
+  GEM_VERSION = '1.3.0'
 
 end

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

@@ -469,7 +469,7 @@ module Aws::SSMIncidents
     # timeline events to mark important events that are automatically
     # detected by Incident Manager.
     #
-    # @option params [required, String] :client_token
+    # @option params [String] :client_token
     #   A token ensuring that the action is called only once with the
     #   specified details.
     #
@@ -477,7 +477,8 @@ module Aws::SSMIncidents
     #   not need to pass this option.**
     #
     # @option params [required, String] :event_data
-    #   A short description of the event.
+    #   A valid JSON string. There is no other schema imposed. A short
+    #   description of the event.
     #
     # @option params [required, Time,DateTime,Date,Integer,String] :event_time
     #   The time that the event occurred.
@@ -498,7 +499,7 @@ module Aws::SSMIncidents
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_timeline_event({
-    #     client_token: "ClientToken", # required
+    #     client_token: "ClientToken",
     #     event_data: "EventData", # required
     #     event_time: Time.now, # required
     #     event_type: "TimelineEventType", # required
@@ -711,6 +712,7 @@ module Aws::SSMIncidents
     #
     # @example Response structure
     #
+    #   resp.replication_set.arn #=> String
     #   resp.replication_set.created_by #=> String
     #   resp.replication_set.created_time #=> Time
     #   resp.replication_set.deletion_protected #=> Boolean
@@ -1440,9 +1442,8 @@ module Aws::SSMIncidents
     #     action is needed to avoid impact.
     #
     # @option params [Array<Types::NotificationTargetItem>] :notification_targets
-    #   The SNS targets that AWS Chatbot uses to notify the chat channel of
-    #   updates to an incident. You can also make updates to the incident
-    #   through the chat channel using the SNS topics.
+    #   The SNS targets that are notified when updates are made to an
+    #   incident.
     #
     #   Using multiple SNS topics creates redundancy in the case that a Region
     #   is down during the incident.
@@ -1602,6 +1603,9 @@ module Aws::SSMIncidents
     #   The AWS Chatbot chat channel used for collaboration during an
     #   incident.
     #
+    #   Use the empty structure to remove the chat channel from the response
+    #   plan.
+    #
     # @option params [String] :client_token
     #   A token ensuring that the action is called only once with the
     #   specified details.
@@ -1636,8 +1640,8 @@ module Aws::SSMIncidents
     #   * `1` - No impact
     #
     # @option params [Array<Types::NotificationTargetItem>] :incident_template_notification_targets
-    #   The SNS targets that AWS Chatbot uses to notify the chat channels and
-    #   perform actions on the incident record.
+    #   The SNS targets that are notified when updates are made to an
+    #   incident.
     #
     # @option params [String] :incident_template_summary
     #   A brief summary of the incident. This typically contains what has
@@ -1696,7 +1700,7 @@ module Aws::SSMIncidents
     # Updates a timeline event. You can update events of type `Custom
     # Event`.
     #
-    # @option params [required, String] :client_token
+    # @option params [String] :client_token
     #   A token ensuring that the action is called only once with the
     #   specified details.
     #
@@ -1725,7 +1729,7 @@ module Aws::SSMIncidents
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_timeline_event({
-    #     client_token: "ClientToken", # required
+    #     client_token: "ClientToken",
     #     event_data: "EventData",
     #     event_id: "UUID", # required
     #     event_time: Time.now,
@@ -1755,7 +1759,7 @@ module Aws::SSMIncidents
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ssmincidents'
-      context[:gem_version] = '1.2.0'
+      context[:gem_version] = '1.3.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -251,7 +251,7 @@ module Aws::SSMIncidents
     CreateResponsePlanOutput.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "arn"))
     CreateResponsePlanOutput.struct_class = Types::CreateResponsePlanOutput
 
-    CreateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, required: true, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
+    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_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"))
@@ -506,6 +506,7 @@ module Aws::SSMIncidents
     RelatedItemsUpdate.add_member_subclass(:unknown, Types::RelatedItemsUpdate::Unknown)
     RelatedItemsUpdate.struct_class = Types::RelatedItemsUpdate
 
+    ReplicationSet.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "arn"))
     ReplicationSet.add_member(:created_by, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "createdBy"))
     ReplicationSet.add_member(:created_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdTime"))
     ReplicationSet.add_member(:deletion_protected, Shapes::ShapeRef.new(shape: Boolean, required: true, location_name: "deletionProtected"))
@@ -662,7 +663,7 @@ module Aws::SSMIncidents
 
     UpdateResponsePlanOutput.struct_class = Types::UpdateResponsePlanOutput
 
-    UpdateTimelineEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, required: true, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
+    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_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "eventTime"))

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

@@ -376,7 +376,7 @@ module Aws::SSMIncidents
     #   data as a hash:
     #
     #       {
-    #         client_token: "ClientToken", # required
+    #         client_token: "ClientToken",
     #         event_data: "EventData", # required
     #         event_time: Time.now, # required
     #         event_type: "TimelineEventType", # required
@@ -392,7 +392,8 @@ module Aws::SSMIncidents
     #   @return [String]
     #
     # @!attribute [rw] event_data
-    #   A short description of the event.
+    #   A valid JSON string. There is no other schema imposed. A short
+    #   description of the event.
     #   @return [String]
     #
     # @!attribute [rw] event_time
@@ -928,8 +929,8 @@ module Aws::SSMIncidents
     #   @return [Time]
     #
     # @!attribute [rw] notification_targets
-    #   The SNS targets that AWS Chatbot uses to notify the chat channels
-    #   and perform actions on the incident record.
+    #   The SNS targets that are notified when updates are made to an
+    #   incident.
     #   @return [Array<Types::NotificationTargetItem>]
     #
     # @!attribute [rw] resolved_time
@@ -1075,9 +1076,8 @@ module Aws::SSMIncidents
     #   @return [Integer]
     #
     # @!attribute [rw] notification_targets
-    #   The SNS targets that AWS Chatbot uses to notify the chat channel of
-    #   updates to an incident. You can also make updates to the incident
-    #   through the chat channel using the SNS topics.
+    #   The SNS targets that are notified when updates are made to an
+    #   incident.
     #   @return [Array<Types::NotificationTargetItem>]
     #
     # @!attribute [rw] summary
@@ -1514,8 +1514,8 @@ module Aws::SSMIncidents
       include Aws::Structure
     end
 
-    # The SNS topic that's used by AWS Chatbot to notify the incidents chat
-    # channel.
+    # The SNS targets that are notified when updates are made to an
+    # incident.
     #
     # @note NotificationTargetItem is a union - when making an API calls you must set exactly one of the members.
     #
@@ -1691,6 +1691,10 @@ module Aws::SSMIncidents
     # The set of Regions that your Incident Manager data will be replicated
     # to and the KMS key used to encrypt the data.
     #
+    # @!attribute [rw] arn
+    #   The Amazon Resource Name (ARN) of the replication set.
+    #   @return [String]
+    #
     # @!attribute [rw] created_by
     #   Details about who created the replication set.
     #   @return [String]
@@ -1726,6 +1730,7 @@ module Aws::SSMIncidents
     # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/ReplicationSet AWS API Documentation
     #
     class ReplicationSet < Struct.new(
+      :arn,
       :created_by,
       :created_time,
       :deletion_protected,
@@ -2273,9 +2278,8 @@ module Aws::SSMIncidents
     #   @return [Integer]
     #
     # @!attribute [rw] notification_targets
-    #   The SNS targets that AWS Chatbot uses to notify the chat channel of
-    #   updates to an incident. You can also make updates to the incident
-    #   through the chat channel using the SNS topics.
+    #   The SNS targets that are notified when updates are made to an
+    #   incident.
     #
     #   Using multiple SNS topics creates redundancy in the case that a
     #   Region is down during the incident.
@@ -2499,6 +2503,9 @@ module Aws::SSMIncidents
     # @!attribute [rw] chat_channel
     #   The AWS Chatbot chat channel used for collaboration during an
     #   incident.
+    #
+    #   Use the empty structure to remove the chat channel from the response
+    #   plan.
     #   @return [Types::ChatChannel]
     #
     # @!attribute [rw] client_token
@@ -2540,8 +2547,8 @@ module Aws::SSMIncidents
     #   @return [Integer]
     #
     # @!attribute [rw] incident_template_notification_targets
-    #   The SNS targets that AWS Chatbot uses to notify the chat channels
-    #   and perform actions on the incident record.
+    #   The SNS targets that are notified when updates are made to an
+    #   incident.
     #   @return [Array<Types::NotificationTargetItem>]
     #
     # @!attribute [rw] incident_template_summary
@@ -2579,7 +2586,7 @@ module Aws::SSMIncidents
     #   data as a hash:
     #
     #       {
-    #         client_token: "ClientToken", # required
+    #         client_token: "ClientToken",
     #         event_data: "EventData",
     #         event_id: "UUID", # required
     #         event_time: Time.now,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ssmincidents
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core