aws-sdk-iotsitewise 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 475b664f08aa75fff087661240437ba7ac4feec495f2c786009bfcef7862801a
-  data.tar.gz: '088f081cddad3d8c913bcfeb837c13f9f059446606a82f13fb20d3a97e5699e8'
+  metadata.gz: af97c5fc1bae0732e47062bced832b10873250302dea4c9ff75720a132828e67
+  data.tar.gz: 0f02d47cbf5944af9ae663f643f7b79579af2d2563d3af0d433673526a63f0c6
 SHA512:
-  metadata.gz: 7d07039e97c726330f1de60b65a9962705df1f53c6043cf4083adbdc1696a250b7db83f6584618d388881dc06e9bf75ec984d098fedbff833d599e346a2c9766
-  data.tar.gz: 37d627465c8d7dbebd22c01a8ce4d1ef245ea77127056c1b8bbe4c0d344882eec103461ffad07cb25bd5a1e8a49e531efd108dd37fb697361f8e2c927b2d8e9a
+  metadata.gz: 2cc711b359d9f3cade65fca22e6fc2410206ed311d92d5f57c67498d2693ae41815ed22be6c672a889da6fd2e6c6b12bd6921884701052174cabf3d5f3a22f30
+  data.tar.gz: 14b228dbd31a586f44ea0babb5ecfbe9455aeeb960dc2185a252026b2492e198a6fe97e992a215ca8a0a05a9a44d91cddcba89e451ba16ec2bd9d28b5637b6e9

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.23.0 (2021-05-27)
+------------------
+
+* Feature - IoT SiteWise Monitor Portal API updates to add alarms feature configuration.
+
 1.22.0 (2021-05-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.22.0
+1.23.0

data/lib/aws-sdk-iotsitewise.rb

@@ -49,6 +49,6 @@ require_relative 'aws-sdk-iotsitewise/customizations'
 # @!group service
 module Aws::IoTSiteWise
 
-  GEM_VERSION = '1.22.0'
+  GEM_VERSION = '1.23.0'
 
 end

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

@@ -1097,6 +1097,23 @@ module Aws::IoTSiteWise
     #
     #   [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
     #
+    # @option params [String] :notification_sender_email
+    #   The email address that sends alarm notifications.
+    #
+    #   If you use the AWS IoT Events managed AWS Lambda function to manage
+    #   your emails, you must [verify the sender email address in Amazon
+    #   SES][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
+    #
+    # @option params [Types::Alarms] :alarms
+    #   Contains the configuration information of an alarm created in an AWS
+    #   IoT SiteWise Monitor portal. You can use the alarm to monitor an asset
+    #   property and get notified when the asset property value is outside a
+    #   specified range. For more information, see .
+    #
     # @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreatePortalResponse#portal_id #portal_id} => String
@@ -1121,6 +1138,11 @@ module Aws::IoTSiteWise
     #       "TagKey" => "TagValue",
     #     },
     #     portal_auth_mode: "IAM", # accepts IAM, SSO
+    #     notification_sender_email: "Email",
+    #     alarms: {
+    #       alarm_role_arn: "ARN", # required
+    #       notification_lambda_arn: "ARN",
+    #     },
     #   })
     #
     # @example Response structure
@@ -1936,6 +1958,8 @@ module Aws::IoTSiteWise
     #   * {Types::DescribePortalResponse#portal_logo_image_location #portal_logo_image_location} => Types::ImageLocation
     #   * {Types::DescribePortalResponse#role_arn #role_arn} => String
     #   * {Types::DescribePortalResponse#portal_auth_mode #portal_auth_mode} => String
+    #   * {Types::DescribePortalResponse#notification_sender_email #notification_sender_email} => String
+    #   * {Types::DescribePortalResponse#alarms #alarms} => Types::Alarms
     #
     # @example Request syntax with placeholder values
     #
@@ -1961,6 +1985,9 @@ module Aws::IoTSiteWise
     #   resp.portal_logo_image_location.url #=> String
     #   resp.role_arn #=> String
     #   resp.portal_auth_mode #=> String, one of "IAM", "SSO"
+    #   resp.notification_sender_email #=> String
+    #   resp.alarms.alarm_role_arn #=> String
+    #   resp.alarms.notification_lambda_arn #=> String
     #
     #
     # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -3727,6 +3754,15 @@ module Aws::IoTSiteWise
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
     #
+    # @option params [String] :notification_sender_email
+    #   The email address that sends alarm notifications.
+    #
+    # @option params [Types::Alarms] :alarms
+    #   Contains the configuration information of an alarm created in an AWS
+    #   IoT SiteWise Monitor portal. You can use the alarm to monitor an asset
+    #   property and get notified when the asset property value is outside a
+    #   specified range. For more information, see .
+    #
     # @return [Types::UpdatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdatePortalResponse#portal_status #portal_status} => Types::PortalStatus
@@ -3747,6 +3783,11 @@ module Aws::IoTSiteWise
     #     },
     #     role_arn: "ARN", # required
     #     client_token: "ClientToken",
+    #     notification_sender_email: "Email",
+    #     alarms: {
+    #       alarm_role_arn: "ARN", # required
+    #       notification_lambda_arn: "ARN",
+    #     },
     #   })
     #
     # @example Response structure
@@ -3812,7 +3853,7 @@ module Aws::IoTSiteWise
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iotsitewise'
-      context[:gem_version] = '1.22.0'
+      context[:gem_version] = '1.23.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -22,6 +22,7 @@ module Aws::IoTSiteWise
     AggregatedValue = Shapes::StructureShape.new(name: 'AggregatedValue')
     AggregatedValues = Shapes::ListShape.new(name: 'AggregatedValues')
     Aggregates = Shapes::StructureShape.new(name: 'Aggregates')
+    Alarms = Shapes::StructureShape.new(name: 'Alarms')
     AmazonResourceName = Shapes::StringShape.new(name: 'AmazonResourceName')
     AssetCompositeModel = Shapes::StructureShape.new(name: 'AssetCompositeModel')
     AssetCompositeModels = Shapes::ListShape.new(name: 'AssetCompositeModels')
@@ -334,6 +335,10 @@ module Aws::IoTSiteWise
     Aggregates.add_member(:standard_deviation, Shapes::ShapeRef.new(shape: AggregatedDoubleValue, location_name: "standardDeviation"))
     Aggregates.struct_class = Types::Aggregates
 
+    Alarms.add_member(:alarm_role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "alarmRoleArn"))
+    Alarms.add_member(:notification_lambda_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "notificationLambdaArn"))
+    Alarms.struct_class = Types::Alarms
+
     AssetCompositeModel.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
     AssetCompositeModel.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
     AssetCompositeModel.add_member(:type, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "type"))
@@ -607,6 +612,8 @@ module Aws::IoTSiteWise
     CreatePortalRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "roleArn"))
     CreatePortalRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
     CreatePortalRequest.add_member(:portal_auth_mode, Shapes::ShapeRef.new(shape: AuthMode, location_name: "portalAuthMode"))
+    CreatePortalRequest.add_member(:notification_sender_email, Shapes::ShapeRef.new(shape: Email, location_name: "notificationSenderEmail"))
+    CreatePortalRequest.add_member(:alarms, Shapes::ShapeRef.new(shape: Alarms, location_name: "alarms"))
     CreatePortalRequest.struct_class = Types::CreatePortalRequest
 
     CreatePortalResponse.add_member(:portal_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "portalId"))
@@ -794,6 +801,8 @@ module Aws::IoTSiteWise
     DescribePortalResponse.add_member(:portal_logo_image_location, Shapes::ShapeRef.new(shape: ImageLocation, location_name: "portalLogoImageLocation"))
     DescribePortalResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "roleArn"))
     DescribePortalResponse.add_member(:portal_auth_mode, Shapes::ShapeRef.new(shape: AuthMode, location_name: "portalAuthMode"))
+    DescribePortalResponse.add_member(:notification_sender_email, Shapes::ShapeRef.new(shape: Email, location_name: "notificationSenderEmail"))
+    DescribePortalResponse.add_member(:alarms, Shapes::ShapeRef.new(shape: Alarms, location_name: "alarms"))
     DescribePortalResponse.struct_class = Types::DescribePortalResponse
 
     DescribeProjectRequest.add_member(:project_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "projectId"))
@@ -1260,6 +1269,8 @@ module Aws::IoTSiteWise
     UpdatePortalRequest.add_member(:portal_logo_image, Shapes::ShapeRef.new(shape: Image, location_name: "portalLogoImage"))
     UpdatePortalRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "roleArn"))
     UpdatePortalRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
+    UpdatePortalRequest.add_member(:notification_sender_email, Shapes::ShapeRef.new(shape: Email, location_name: "notificationSenderEmail"))
+    UpdatePortalRequest.add_member(:alarms, Shapes::ShapeRef.new(shape: Alarms, location_name: "alarms"))
     UpdatePortalRequest.struct_class = Types::UpdatePortalRequest
 
     UpdatePortalResponse.add_member(:portal_status, Shapes::ShapeRef.new(shape: PortalStatus, required: true, location_name: "portalStatus"))

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

@@ -112,6 +112,46 @@ module Aws::IoTSiteWise
       include Aws::Structure
     end
 
+    # Contains the configuration information of an alarm created in an AWS
+    # IoT SiteWise Monitor portal. You can use the alarm to monitor an asset
+    # property and get notified when the asset property value is outside a
+    # specified range. For more information, see .
+    #
+    # @note When making an API call, you may pass Alarms
+    #   data as a hash:
+    #
+    #       {
+    #         alarm_role_arn: "ARN", # required
+    #         notification_lambda_arn: "ARN",
+    #       }
+    #
+    # @!attribute [rw] alarm_role_arn
+    #   The [ARN][1] of the IAM role that allows the alarm to perform
+    #   actions and access AWS resources, including AWS IoT Events.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+    #   @return [String]
+    #
+    # @!attribute [rw] notification_lambda_arn
+    #   The [ARN][1] of the AWS Lambda function that manages alarm
+    #   notifications. For more information, see [Managing alarm
+    #   notifications][2] in the *AWS IoT Events Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+    #   [2]: https://docs.aws.amazon.com/
+    #   @return [String]
+    #
+    class Alarms < Struct.new(
+      :alarm_role_arn,
+      :notification_lambda_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains information about a composite model in an asset. This object
     # contains the asset's properties that you define in the composite
     # model.
@@ -1842,6 +1882,11 @@ module Aws::IoTSiteWise
     #           "TagKey" => "TagValue",
     #         },
     #         portal_auth_mode: "IAM", # accepts IAM, SSO
+    #         notification_sender_email: "Email",
+    #         alarms: {
+    #           alarm_role_arn: "ARN", # required
+    #           notification_lambda_arn: "ARN",
+    #         },
     #       }
     #
     # @!attribute [rw] portal_name
@@ -1916,6 +1961,25 @@ module Aws::IoTSiteWise
     #   [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
     #   @return [String]
     #
+    # @!attribute [rw] notification_sender_email
+    #   The email address that sends alarm notifications.
+    #
+    #   If you use the AWS IoT Events managed AWS Lambda function to manage
+    #   your emails, you must [verify the sender email address in Amazon
+    #   SES][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
+    #   @return [String]
+    #
+    # @!attribute [rw] alarms
+    #   Contains the configuration information of an alarm created in an AWS
+    #   IoT SiteWise Monitor portal. You can use the alarm to monitor an
+    #   asset property and get notified when the asset property value is
+    #   outside a specified range. For more information, see .
+    #   @return [Types::Alarms]
+    #
     class CreatePortalRequest < Struct.new(
       :portal_name,
       :portal_description,
@@ -1924,7 +1988,9 @@ module Aws::IoTSiteWise
       :portal_logo_image_file,
       :role_arn,
       :tags,
-      :portal_auth_mode)
+      :portal_auth_mode,
+      :notification_sender_email,
+      :alarms)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2934,6 +3000,15 @@ module Aws::IoTSiteWise
     #   The service to use to authenticate users to the portal.
     #   @return [String]
     #
+    # @!attribute [rw] notification_sender_email
+    #   The email address that sends alarm notifications.
+    #   @return [String]
+    #
+    # @!attribute [rw] alarms
+    #   Contains the configuration information of an alarm created in a AWS
+    #   IoT SiteWise Monitor portal.
+    #   @return [Types::Alarms]
+    #
     class DescribePortalResponse < Struct.new(
       :portal_id,
       :portal_arn,
@@ -2947,7 +3022,9 @@ module Aws::IoTSiteWise
       :portal_last_update_date,
       :portal_logo_image_location,
       :role_arn,
-      :portal_auth_mode)
+      :portal_auth_mode,
+      :notification_sender_email,
+      :alarms)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -5894,6 +5971,11 @@ module Aws::IoTSiteWise
     #         },
     #         role_arn: "ARN", # required
     #         client_token: "ClientToken",
+    #         notification_sender_email: "Email",
+    #         alarms: {
+    #           alarm_role_arn: "ARN", # required
+    #           notification_lambda_arn: "ARN",
+    #         },
     #       }
     #
     # @!attribute [rw] portal_id
@@ -5942,6 +6024,17 @@ module Aws::IoTSiteWise
     #   not need to pass this option.
     #   @return [String]
     #
+    # @!attribute [rw] notification_sender_email
+    #   The email address that sends alarm notifications.
+    #   @return [String]
+    #
+    # @!attribute [rw] alarms
+    #   Contains the configuration information of an alarm created in an AWS
+    #   IoT SiteWise Monitor portal. You can use the alarm to monitor an
+    #   asset property and get notified when the asset property value is
+    #   outside a specified range. For more information, see .
+    #   @return [Types::Alarms]
+    #
     class UpdatePortalRequest < Struct.new(
       :portal_id,
       :portal_name,
@@ -5949,7 +6042,9 @@ module Aws::IoTSiteWise
       :portal_contact_email,
       :portal_logo_image,
       :role_arn,
-      :client_token)
+      :client_token,
+      :notification_sender_email,
+      :alarms)
       SENSITIVE = []
       include Aws::Structure
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotsitewise
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core