class Aws::IoTSiteWise::Types::UpdatePortalRequest

@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",
      },
    }

@!attribute [rw] portal_id

The ID of the portal to update.
@return [String]

@!attribute [rw] portal_name

A new friendly name for the portal.
@return [String]

@!attribute [rw] portal_description

A new description for the portal.
@return [String]

@!attribute [rw] portal_contact_email

The Amazon Web Services administrator's contact email address.
@return [String]

@!attribute [rw] portal_logo_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.
@return [Types::Image]

@!attribute [rw] role_arn

The [ARN][1] 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][2]
in the *IoT SiteWise User Guide*.

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
[2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html
@return [String]

@!attribute [rw] client_token

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.
@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 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][1] in the *IoT SiteWise Application Guide*.

[1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
@return [Types::Alarms]

Constants

SENSITIVE