# Get started with AWS IoT SiteWise Monitor (Classic) Get started with AWS IoT SiteWise Monitor (Classic) **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). If you're the AWS administrator for your organization, you create portals from the AWS IoT SiteWise console. Complete the following steps to create a portal so that members of your organization can view your AWS IoT SiteWise data: 1. Configure and create a portal 1. Add portal administrators and send invitation emails 1. Add portal users After you create a portal, the portal administrator can view your AWS IoT SiteWise assets and assign them to projects in the portal. Project owners can then create dashboards to visualize the properties of the assets that help project viewers understand how your devices, processes, and equipment are performing. **Note** When adding users or administrators to the portal, avoid creating AWS Identity and Access Management (IAM) policies that restrict user permissions, such as limited IP. Any attached policies with restricted permissions will not be able to connect to the AWS IoT SiteWise portal. You can follow a tutorial that walks through the steps required to set up a portal with a project, dashboards, and multiple users for a specific scenario using wind farm data. For more information, see [Visualize and share wind farm data in SiteWise Monitor](monitor-wind-farm.md). **Topics** + [ # Create a portal in SiteWise Monitor ](monitor-create-portal.md) + [ # Configure your portal in SiteWise Monitor ](monitor-configure-portal.md) + [ # Invite administrators in SiteWise Monitor ](monitor-invite-administrators.md) + [ # Add portal users in SiteWise Monitor ](monitor-add-portal-users.md) + [ # Create AWS IoT SiteWise dashboards (AWS CLI) ](create-dashboards-using-aws-cli.md) + [ # Turn on alarms for your portals in AWS IoT SiteWise ](monitor-enable-alarms.md) + [ # Enabling your AWS IoT SiteWise portal at the edge ](monitor-enable-edge.md) + [ # Administer your SiteWise Monitor portals ](administer-portals.md) # Create a portal in SiteWise Monitor Create a portal **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). You create a SiteWise Monitor portal in the AWS IoT SiteWise console. **To create a portal** 1. Sign in to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/). 1. In the navigation pane, choose **Monitor**, **Getting started**. ![\[The left navigation pane of the AWS IoT SiteWise console with Getting started highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-choose-monitor-getting-started-console.png) 1. Choose **Create Portal**. ![\[The AWS IoT SiteWise Monitor Getting started page with Create portal highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-choose-create-portal-console.png) Next, you must provide some basic information to configure your portal. # Configure your portal in SiteWise Monitor Configure your portal **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). Your users use portals to view your data. You can customize a portal's name, description, branding, user authentication, support contact email, and permissions. ![\[The "Portal configuration" page used to create a portal.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/PortalConfiguration.png) **To configure a portal** 1. Enter a name for your portal. 1. (Optional) Enter a description for your portal. If you have multiple portals, use meaningful descriptions to help you keep track of what each portal contains. 1. (Optional) Upload an image to display your brand in the portal. Choose a square, PNG image. If you upload a non-square image, the portal scales the image down to a square. 1. Choose one of the following options: + Choose **IAM Identity Center** if your portal users sign in to this portal with their corporate user names and passwords. If you haven't enabled IAM Identity Center in your account, do the following: 1. Choose **Create user**. 1. On the **Create user** page, to create the first portal, enter the user's email address, first name, and last name, and then choose **Create user**. ![\[Enable IAM Identity Center if you haven't enable IAM Identity Center in your AWS account.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOUserCreation.png) **Note** AWS automatically enables IAM Identity Center in your account when you create the first portal user. You can configure IAM Identity Center in only one Region at a time. SiteWise Monitor connects to the Region that you configured for IAM Identity Center. This means that you use one Region for IAM Identity Center access, but you can create portals in any Region. + Choose **IAM** if your portal users sign in to this portal with their IAM credentials. **Important** Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal. 1. Enter an email address that portal users can contact when they have an issue with the portal and need help to resolve it. 1. (Optional) Add tags for your portal. For more information, see [Tag your AWS IoT SiteWise resources](tag-resources.md). 1. Choose one of the following options: + Choose **Create and use a new service role**. By default, SiteWise Monitor automatically creates a service role for each portal. This role allows your portal users to access your AWS IoT SiteWise resources. For more information, see [Use service roles for AWS IoT SiteWise Monitor](monitor-service-role.md). + Choose **Use an existing service role**, and then choose the target role. 1. Choose **Next** 1. (Optional) Enable alarms for your portal. For more information, see [Turn on alarms for your portals in AWS IoT SiteWise](monitor-enable-alarms.md). 1. Choose **Create**. AWS IoT SiteWise will create your portal. **Note** If you close the console, you can finish the setup process by adding administrators and users. For more information, see [Add or remove portal administrators in AWS IoT SiteWise](portal-change-admins.md). If you don't want to keep this portal, delete it so it doesn't use resources. For more information, see [Delete a portal in AWS IoT SiteWise](portal-delete-portal.md). The **Status** column can be one of the following values. + **CREATING** - AWS IoT SiteWise is processing your request to create the portal. This process can take several minutes to complete. + **UPDATING** - AWS IoT SiteWise is processing your request to update the portal. This process can take several minutes to complete. + **PENDING** - AWS IoT SiteWise is waiting for the DNS record propagation to finish. This process can take several minutes to complete. You can delete the portal while the status is **PENDING**. + **DELETING** - AWS IoT SiteWise is processing your request to delete the portal. This process can take several minutes to complete. + **ACTIVE** - When the portal becomes active, your portal users can access it. + **FAILED** - AWS IoT SiteWise couldn't process your request to create, update, or delete the portal. If you enabled AWS IoT SiteWise to send logs to Amazon CloudWatch Logs, you can use these logs to troubleshoot issues. For more information, see [ Monitoring AWS IoT SiteWise with CloudWatch Logs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html). A message appears when your portal is created. ![\[An example successful portal creation message.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-create-portal-success-console.png) Next, you must invite one or more portal administrators to the portal. So far, you created a portal but no one can access it. # Invite administrators in SiteWise Monitor Invite administrators To get started in your new portal, you must assign a portal administrator. The portal administrator creates projects, chooses project owners, and assigns assets to projects. Portal administrators can see all of your AWS IoT SiteWise assets. Based on the user authentication service, choose one of the following options: ------ #### [ IAM Identity Center ] If you're using SiteWise Monitor for the first time, you can choose the user that you created earlier to be the portal administrator. If you want to add another user as a portal administrator, you can create an IAM Identity Center user from this page. Alternatively, you can connect an external identity provider to IAM Identity Center. For more information, see the [AWS IAM Identity Center User Guide](https://docs.aws.amazon.com/singlesignon/latest/userguide/). **To invite administrators** 1. Select the check boxes for the users that you want as your portal administrators. This adds the users to the **Portal administrators** list. **Note** If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as an administrator. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html). 1. (Optional) Choose **Send invite to selected users**. Your email client opens, and an invitation is populated in the message body. You can customize the email before you send it to your portal administrators. You can also send the email to your portal administrators later. If you're trying SiteWise Monitor for the first time and adding your new IAM Identity Center or IAM user or role as the portal administrator, you don't need to email yourself. 1. If you add a user that you don't want as an administrator, clear the check box for that user. 1. When you're finished inviting portal administrators, choose **Next**. ------ #### [ IAM ] You can choose a user or role to be the portal administrator. If you want to add another user or role as a portal administrator, you can create a user or role in the IAM console. For more information, see [Creating an IAM user in your AWS account](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) and [Creating IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) in the *IAM User Guide*. **To invite administrators** 1. Do the following: + Choose **IAM users** to add an IAM user as your portal administrator. + Choose **IAM roles** to add an IAM role as your portal administrator. 1. Select the check boxes for the users or roles that you want as your portal administrators. This adds the users or roles to the **Portal administrators** list. 1. If you add a user or role that you don't want as an administrator, clear the check box for that user or role. 1. When you're finished inviting portal administrators, choose **Next**. **Important** Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal. **Note** If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as an administrator. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html). ------ You can change the list of portal administrators later. For more information, see [Add or remove portal administrators in AWS IoT SiteWise](portal-change-admins.md). **Note** Because only a portal administrator can create projects and assign assets to them, you should specify at least one portal administrator. As the last step, you add users who can access your new portal. # Add portal users in SiteWise Monitor Add portal users **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). You control which users have access to your portals. In each portal, the portal administrators create one or more projects and assign portal users as owners or viewers for each project. Each project owner can invite additional portal users to own or view the project. Based on the user authentication service, choose one of the following options: ------ #### [ IAM Identity Center ] If you want to add a user to the **Users** list, complete the following steps. **To add portal users** 1. Choose users from the **Users** list to add to the portal. This adds the users to the **Portal users** list. If you're using SiteWise Monitor for the first time, you don't need to add your portal administrator as a portal user. **Note** If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as a user. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html). 1. If you add a user that you don't want to have access to the portal, clear the check box for that user. 1. When you're finished selecting users, choose **Assign users**. ![\[The assign IAM Identity Center users step of the portal creation process.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOUserAssign.png) ------ #### [ IAM ] If you see the user or role that you want to add in the **IAM users** or **IAM roles** list, complete the following steps. **To add portal users** 1. Do the following options: + Choose **IAM users** to add an IAM user as a portal user. + Choose **IAM roles** to add an IAM role as a portal user. If you're using SiteWise Monitor for the first time, you don't need to add your portal administrator as a portal user. 1. Select the check boxes for the users or roles that you want as portal users. This adds the users or roles to the **Portal users** list. 1. If you add a user that you don't want to have access to the portal, clear the check box for that user. 1. When you're finished selecting users, choose **Assign users**. **Important** Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal. ![\[The assign IAM users step of the portal creation process.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMUserAssign.png) ![\[The assign IAM step of the portal creation process.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMRoleAssign.png) ------ Congratulations\$1 You successfully created a portal, assigned portal administrators, and assigned users who can use that portal when invited to do so. Your portal administrators can now create projects and add assets to those projects. Then, your project owners can create dashboards to visualize the data for each project's assets. You can change the list of portal users later. For more information, see [Add or remove portal users in AWS IoT SiteWise](portal-change-users.md). If you need to make changes to the portal, see [Administer your SiteWise Monitor portals](administer-portals.md). To get started in the portal, see [Getting started](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/getting-started.html) in the *SiteWise Monitor Application Guide*. # Create AWS IoT SiteWise dashboards (AWS CLI) Create dashboards (CLI) **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). When you define visualizations (or widgets) in dashboards using the AWS CLI, you must specify the following information in the `dashboardDefinition` JSON document. This definition is a parameter of the [CreateDashboard](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateDashboard.html) and [UpdateDashboard](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateDashboard.html) operations. `widgets` A list of widget definition structures that each contain the following information: `type` The type of widget. AWS IoT SiteWise provides the following widget types: + `sc-line-chart` – A line chart. For more information, see [Line charts](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#line-charts) in the *AWS IoT SiteWise Monitor Application Guide*. + `sc-scatter-chart` – A scatter chart. For more information, see [Scatter charts](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#scatter-charts) in the *AWS IoT SiteWise Monitor Application Guide*. + `sc-bar-chart` – A bar chart. For more information, see [Bar charts](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#bar-charts) in the *AWS IoT SiteWise Monitor Application Guide*. + `sc-status-grid` – A status widget that shows the latest value of asset properties as a grid. For more information, see [Status widgets](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#status-widgets) in the *AWS IoT SiteWise Monitor Application Guide*. + `sc-status-timeline` – A status widget that shows the historical values of asset properties as a timeline. For more information, see [Status widgets](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#status-widgets) in the *AWS IoT SiteWise Monitor Application Guide*. + `sc-kpi` – A key performance indicator (KPI) visualization. For more information, see [KPI widgets](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#kpi-charts) in the *AWS IoT SiteWise Monitor Application Guide*. + `sc-table` – A table widget. For more information, see [Table widgets](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/choose-visualization-types.html#table-widgets) in the *AWS IoT SiteWise Monitor Application Guide*. `title` The title of the widget. `x` The horizontal position of the widget, starting from the left of the grid. This value refers to the widget's position in the dashboard's grid. `y` The vertical position of the widget, starting from the top of the grid. This value refers to the widget's position in the dashboard's grid. `width` The width of the widget, expressed in number of spaces on the dashboard's grid. `height` The height of the widget, expressed in number of spaces on the dashboard's grid. `metrics` A list of metric structures that each define a data stream for this widget. Each structure in the list must contain the following information: `label` A label to display for this metric. `type` The type of data source for this metric. AWS IoT SiteWise provides the following metric types: + `iotsitewise` – The dashboard fetches data for an asset property in AWS IoT SiteWise. If you choose this option, you must define `assetId` and `propertyId` for this metric. `assetId` (Optional) The ID of an asset in AWS IoT SiteWise. This field is required if you choose `iotsitewise` for `type` in this metric. `propertyId` (Optional) The ID of an asset property in AWS IoT SiteWise. This field is required if you choose `iotsitewise` for `type` in this metric. `analysis` (Optional) A structure that defines the analysis, such as trend lines, to display for the widget. For more information, see [Configuring trend lines](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/configure-trend-lines.html) in the *AWS IoT SiteWise Monitor Application Guide*. You can add one of each type of trend line per property in the widget. The analysis structure contains the following information: `trends` (Optional) A list of trend structures that each define a trend analysis for this widget. Each structure in the list contains the following information: `type` The type of trend line. Choose the following option: + `linear-regression` – Display a linear regression line. SiteWise Monitor uses the [least squares](https://en.wikipedia.org/wiki/Least_squares) method to calculate the linear regression. `annotations` (Optional) An annotations structure that defines thresholds for the widget. For more information, see [Configuring thresholds](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/configure-thresholds.html) in the *AWS IoT SiteWise Monitor Application Guide*. You can add up to six annotations per widget. The annotations structure contains the following information: `y` (Optional) A list of annotation structures that each define a horizontal threshold for this widget. Each structure in the list contains the following information: `comparisonOperator` The comparison operator for the threshold. Choose one of the following: + `LT` – Highlight properties that have at least one data point less than the `value`. + `GT` – Highlight properties that have at least one data point greater than the `value`. + `LTE` – Highlight properties that have at least one data point less than or equal to the `value`. + `GTE` – Highlight properties that have at least one data point greater than or equal to the `value`. + `EQ` – Highlight properties that have at least one data point equal to the `value`. `value` The threshold value to compare data points with the `comparisonOperator`. `color` (Optional) The 6-digit hexadecimal code of the threshold color. The visualization displays property legends in this color for properties with at least one data point that meets the threshold rule. Defaults to black (`#000000`). `showValue` (Optional) Whether or not to show the value of the threshold in the margins of the widget. Defaults to `true`. `properties` (Optional) A flat dictionary of properties for the widget. The members of this structure are context-dependent. AWS IoT SiteWise provides the following widgets that use `properties`: + [Line charts](#monitor-line-chart), [scatter charts](#monitor-scatter-chart), and [bar charts](#monitor-bar-chart) have the following property: `colorDataAcrossThresholds` (Optional) Whether or not to change the color of the data that crosses the thresholds in this widget. When you enable this option, the data that crosses a threshold appears in the color that you choose. Defaults to `true`. + [Status grids](#monitor-status-grid) have the following property: `labels` (Optional) A structure that defines the labels to display on the status grid. The labels structure contains the following information: `showValue` (Optional) Whether or not to display the unit and value for each asset property in this widget. Defaults to `true`. **Example dashboard definition** The following example defines a dashboard from a payload stored in a JSON file. ``` aws iotsitewise create-dashboard \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ --dashboard-name "Wind Farm Dashboard" \ --dashboard-definition file://dashboard-definition.json ``` The following JSON example for `dashboard-definition.json` defines dashboard with the following visualization widgets: + A line chart that visualizes total wind farm power in the upper left of the dashboard. This line chart includes a threshold that indicates when the wind farm outputs less power than its minimum expected output. This line chart also includes a linear regression trend line. + A bar chart that visualizes wind speed for four turbines in the upper right of the dashboard. This example represents line and bar chart visualizations on a dashboard. This dashboard is similar to the [example wind farm dashboard](monitor-data.md). ``` { "widgets": [ { "type": "sc-line-chart", "title": "Total Average Power", "x": 0, "y": 0, "height": 3, "width": 3, "metrics": [ { "label": "Power", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "analysis": { "trends": [ { "type": "linear-regression" } ] } } ], "annotations": { "y": [ { "comparisonOperator": "LT", "value": 20000, "color": "#D13212", "showValue": true } ] } }, { "type": "sc-bar-chart", "title": "Wind Speed", "x": 3, "y": 3, "height": 3, "width": 3, "metrics": [ { "label": "Turbine 1", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-2a2a2EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE" }, { "label": "Turbine 2", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-2b2b2EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE" }, { "label": "Turbine 3", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-2c2c2EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE" }, { "label": "Turbine 4", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-2d2d2EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE" } ] } ] } ``` # Turn on alarms for your portals in AWS IoT SiteWise Turn on alarms for your portals **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). **Note** End of support notice: AWS ended support for AWS IoT Events. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). You can enable the alarms feature supported by AWS IoT Events for your portals so that portal administrators can create, edit, and delete AWS IoT Events alarm models in your SiteWise Monitor portals. Project owners can configure alarms. Project viewers can view alarm details. This section explains how you can use the AWS IoT SiteWise console to enable the alarms feature for your portals. **Important** You can't create external alarms in your portals. If you want to send alarm notifications, you must choose IAM Identity Center for the user authentication service. The alarm notifications feature isn't available in the China (Beijing) AWS Region. When you configure and create a portal, you can enable alarms and alarm notifications in **Step 2 Additional features**. Based on the user authentication service, choose one of the following options: ------ #### [ IAM Identity Center ] ![\[Additional features page for enabling alarms for portals.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/portal-create-console-enable-alarms-sso.png) **To enable alarms for a portal** 1. (Optional) Choose **Enable alarms**. 1. For **AWS IoT SiteWise access role**, use an existing role or create a role with the required permissions. This role requires the `iotevents:BatchPutMessage` permission and a trust relationship that allows `iot.amazonaws.com` and `iotevents.amazonaws.com` to assume the role. 1. (Optional) Choose **Enable alarm notifications**. 1. For **Sender**, choose the sender. **Important** You must verify the sender email address in Amazon SES. For more information, see [Verifying email addresses in Amazon SES](https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html), in the *Amazon Simple Email Service Developer Guide*. 1. For **AWS Lambda role**, use an existing role or create a role with the required permissions. This role requires the `lambda:InvokeFunction` and `sso-directory:DescribeUser`permissions and a trust relationship that allows `iotevents.amazonaws.com` and `lambda.amazonaws.com` to assume the role. 1. For **AWS Lambda functions**, choose an existing Lambda function or create a function that manages alarm notifications. For more information, see [Managing alarm notifications](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) in the *AWS IoT Events Developer Guide*. ------ #### [ IAM ] ![\[Additional features page for enabling alarms for portals.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/portal-create-console-enable-alarms-iam.png) **To enable alarms for a portal** + (Optional) Choose **Enable alarms**. 1. For **AWS IoT SiteWise access role**, use an existing role or create a role with the required permissions. This role requires the `iotevents:BatchPutMessage` permission and a trust relationship that allows `iot.amazonaws.com` and `iotevents.amazonaws.com` to assume the role. ------ For more information about alarms in SiteWise Monitor, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the *AWS IoT SiteWise Application Guide*. # Enabling your AWS IoT SiteWise portal at the edge Enable your portal at the edge **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). After you enable your portal at the edge, this portal is available on all SiteWise Edge gateways with the data processing pack enabled in your account. **To enable the portal at the edge** 1. In the **Edge configuration** section, turn on **Enable this portal at the edge**. 1. Choose **Create**. # Administer your SiteWise Monitor portals Administer your portals **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). You have the ability to manage and configure various aspects of the portal. This includes adding and removing users or administrators, setting user permissions and roles, customizing the portal's URL, name, setting a support contact information, and sending email invitations to portal administrators. 1. Sign in to the [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/home). 1. In the navigation pane, choose **Monitor**, **Portals**. ![\[Left navigation pane in the AWS IoT SiteWise console with Portals highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-choose-portals-console.png) 1. Choose a portal, and then choose **View details** (or choose the portal's **Name**). 1. You can perform any of the following administrative tasks: + [Change portal details in AWS IoT SiteWise](portal-change-details.md) + [Add or remove portal administrators in AWS IoT SiteWise](portal-change-admins.md) + [Send email invitations to portal administrators](send-email-invitations-to-portal.md) + [Add or remove portal users in AWS IoT SiteWise](portal-change-users.md) + [Delete a portal in AWS IoT SiteWise](portal-delete-portal.md) For information about how to create a portal, see [Get started with AWS IoT SiteWise Monitor (Classic)](monitor-getting-started.md). **Topics** + [ # Change portal details in AWS IoT SiteWise ](portal-change-details.md) + [ # Add or remove portal administrators in AWS IoT SiteWise ](portal-change-admins.md) + [ # Send email invitations to portal administrators ](send-email-invitations-to-portal.md) + [ # Add or remove portal users in AWS IoT SiteWise ](portal-change-users.md) + [ # Delete a portal in AWS IoT SiteWise ](portal-delete-portal.md) # Change portal details in AWS IoT SiteWise Change a portal's attributes **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). You can change a portal's name, description, branding, support email, and permissions. 1. On the portal details page, in the **Portal details** section, choose **Edit**. ![\[Portal details section of the portal details page with Edit highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-view-portal-details-console.png) 1. Update the **Name**, **Description**, **Portal branding**, **Support contact email**, or **Permissions**. 1. When you're finished, choose **Save**. # Add or remove portal administrators in AWS IoT SiteWise Add or remove portal administrators **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). In a few steps, you can add or remove users as administrators for a portal. Based on the user authentication service, choose one of the following options. ------ #### [ IAM Identity Center ] ![\[Portal administrators section of the portal details page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOAdminDetail.png) **To add portal administrators** 1. On the portal details page, in the **Portal administrators** section, choose **Assign administrators**. 1. On the **Assign administrators** page, select the check boxes for the users to add to the portal as administrators. **Note** If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as an administrator. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html). 1. Choose **Assign administrators**. ![\[The "Assign administrators" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOAdminAssign.png) **To remove portal administrators** + On the portal details page, in the **Portal administrators** section, select the check box for each user to remove, and then choose **Remove from portal**. **Note** We recommend that you select at least one portal administrator. ------ #### [ IAM ] ![\[Portal administrators section of the portal details page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMAdminDetail.png) **To add portal administrators** 1. On the portal details page, in the **Portal administrators** section, choose **Assign administrators**. 1. On the **Assign administrators** page, do the following: + Choose **IAM users**, if you want to add an IAM user as your portal administrator. + Choose **IAM roles**, if you want to add an IAM role as your portal administrator. 1. Select the check boxes for the users or roles that you want as your portal administrators. This adds the users or roles to the **Portal administrators** list. 1. Choose **Assign administrators**. **Important** Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal. ![\[The "Assign administrators" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMUserAdminAssign.png) ![\[The "Assign administrators" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMRoleAdminAssign.png) **To remove portal administrators** + On the portal details page, in the **Portal administrators** section, select the check box for each user to remove, and then choose **Remove from portal**. **Note** Leaving a portal without a portal administrator is not recommended. ------ # Send email invitations to portal administrators **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). You can send email invitations to portal administrators. 1. On the portal details page, in the **Portal administrators** section, select the check boxes for the portal administrators. ![\[Portal administrators section of the portal details page with "Send invitations" highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-select-portal-administrator-console.png) 1. Choose **Send invitations**. Your email client opens, and an invitation is populated in the message body. You can customize the email before you send it to your portal administrators. # Add or remove portal users in AWS IoT SiteWise Add or remove portal users **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). You choose which users have access to your portals. Portal users appear in the list of users within a SiteWise Monitor portal. From this list, portal administrators can add project owners, and project owners can add project viewers. **Note** Your portal administrators and portal users might contact you through a portal's support email if they need you to add or remove a user. Based on the user authentication service, choose one of the following options. ------ #### [ IAM Identity Center ] ![\[Portal administrators section of the portal details page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOUserDetail.png) **To add portal users** 1. On the portal details page, in the **Portal users** section, choose **Assign users**. 1. On the **Assign users** page, select the check box for the users to add to the portal. **Note** If you use IAM Identity Center as your identity store, and you're signed in to your AWS Organizations management account, you can choose **Create user** to create an IAM Identity Center user. IAM Identity Center sends the new user an email for them to set their password. You can then assign the user to the portal as a user. For more information, see [Manage identities in IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-identity-source-sso.html). 1. Choose **Assign users**. ![\[The "Assign users" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/SSOUserAssign2.png) **To remove portal users** + On the portal details page, in the **Portal users** section, select the check box for the users to remove from the portal, and then choose **Remove from portal**. ------ #### [ IAM ] ![\[Portal administrators section of the portal details page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMRoleUserDetail.png) **To add portal users** 1. On the portal details page, in the **Portal users** section, choose **Assign users**. 1. On the **Assign users** page, do the following: + Choose **IAM users** to add an IAM user as your portal user. + Choose **IAM roles** to add an IAM role as your portal user. 1. Select the check boxes for the users or roles that you want to add as your portal users. This adds the users or roles to the **Portal users** list. 1. Choose **Assign users**. ![\[The "Assign users" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMUserAssign2.png) ![\[The "Assign users" page.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/IAMRoleAssign2.png) **To remove portal users** + On the portal details page, in the **Portal users** section, select the check box for the users to remove from the portal, and then choose **Remove from portal**. **Important** Users or roles must have the `iotsitewise:DescribePortal` permission to sign in to the portal. ------ # Delete a portal in AWS IoT SiteWise Delete a portal **Note** The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html). You might delete a portal if you created it for testing purposes or if you created a duplicate of a portal that already exists. **Note** You must first manually delete all dashboards and projects in a portal before you can delete a portal. For more information, see [Deleting projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-projects.html) and [Deleting dashboards](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-dashboards.html) in the *SiteWise Monitor Application Guide*. 1. On the portal details page, choose **Delete**. **Important** When you delete a portal, you lose all projects that the portal contains, and all dashboards in each project. This action can't be undone. Your asset data isn't affected. ![\[Portal details page with Delete highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-delete-portal-console.png) 1. In the **Delete portals** dialog box, choose **Remove admins and users**. You must remove the administrators and users from a portal before you can delete it. If your portal doesn't have administrators or users, the button doesn't appear, and you can skip to the next step. ![\["Delete portals" dialog box with "Remove administrators and users" highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-delete-portal-remove-users-console.png) 1. If you're sure that you want to delete the entire portal, enter **delete** in the field to confirm deletion. ![\["Delete portals" dialog box with "Delete" highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/images/sitewise-delete-portal-confirm-delete-console.png) 1. Choose **Delete**.