AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::IoTSiteWise::Types::UpdatePortalRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass UpdatePortalRequest data as a hash:

{
  portal_id: "ID", # required
  portal_name: "Name", # required
  portal_description: "Description",
  portal_contact_email: "Email", # required
  portal_logo_image: {
    id: "ID",
    file: {
      data: "data", # required
      type: "PNG", # required, accepts PNG
    },
  },
  role_arn: "ARN", # required
  client_token: "ClientToken",
  notification_sender_email: "Email",
  alarms: {
    alarm_role_arn: "ARN", # required
    notification_lambda_arn: "ARN",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarmsTypes::Alarms

Contains the configuration information of an alarm created in an 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 Monitoring with alarms in the IoT SiteWise Application Guide.

Returns:



6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6682

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6682

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#notification_sender_emailString

The email address that sends alarm notifications.

Returns:

  • (String)


6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6682

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_contact_emailString

The Amazon Web Services administrator's contact email address.

Returns:

  • (String)


6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6682

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_descriptionString

A new description for the portal.

Returns:

  • (String)


6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6682

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_idString

The ID of the portal to update.

Returns:

  • (String)


6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6682

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_logo_imageTypes::Image

Contains an image that is one of the following:

  • An image file. Choose this option to upload a new image.

  • The ID of an existing image. Choose this option to keep an existing image.

Returns:



6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6682

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_nameString

A new friendly name for the portal.

Returns:

  • (String)


6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6682

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

Returns:

  • (String)


6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6682

class UpdatePortalRequest < Struct.new(
  :portal_id,
  :portal_name,
  :portal_description,
  :portal_contact_email,
  :portal_logo_image,
  :role_arn,
  :client_token,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end