Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieves information about a portal.
Synopsis
- data DescribePortal = DescribePortal' {}
- newDescribePortal :: Text -> DescribePortal
- describePortal_portalId :: Lens' DescribePortal Text
- data DescribePortalResponse = DescribePortalResponse' {
- alarms :: Maybe Alarms
- notificationSenderEmail :: Maybe Text
- portalAuthMode :: Maybe AuthMode
- portalDescription :: Maybe Text
- portalLogoImageLocation :: Maybe ImageLocation
- roleArn :: Maybe Text
- httpStatus :: Int
- portalId :: Text
- portalArn :: Text
- portalName :: Text
- portalClientId :: Text
- portalStartUrl :: Text
- portalContactEmail :: Text
- portalStatus :: PortalStatus
- portalCreationDate :: POSIX
- portalLastUpdateDate :: POSIX
- newDescribePortalResponse :: Int -> Text -> Text -> Text -> Text -> Text -> Text -> PortalStatus -> UTCTime -> UTCTime -> DescribePortalResponse
- describePortalResponse_alarms :: Lens' DescribePortalResponse (Maybe Alarms)
- describePortalResponse_notificationSenderEmail :: Lens' DescribePortalResponse (Maybe Text)
- describePortalResponse_portalAuthMode :: Lens' DescribePortalResponse (Maybe AuthMode)
- describePortalResponse_portalDescription :: Lens' DescribePortalResponse (Maybe Text)
- describePortalResponse_portalLogoImageLocation :: Lens' DescribePortalResponse (Maybe ImageLocation)
- describePortalResponse_roleArn :: Lens' DescribePortalResponse (Maybe Text)
- describePortalResponse_httpStatus :: Lens' DescribePortalResponse Int
- describePortalResponse_portalId :: Lens' DescribePortalResponse Text
- describePortalResponse_portalArn :: Lens' DescribePortalResponse Text
- describePortalResponse_portalName :: Lens' DescribePortalResponse Text
- describePortalResponse_portalClientId :: Lens' DescribePortalResponse Text
- describePortalResponse_portalStartUrl :: Lens' DescribePortalResponse Text
- describePortalResponse_portalContactEmail :: Lens' DescribePortalResponse Text
- describePortalResponse_portalStatus :: Lens' DescribePortalResponse PortalStatus
- describePortalResponse_portalCreationDate :: Lens' DescribePortalResponse UTCTime
- describePortalResponse_portalLastUpdateDate :: Lens' DescribePortalResponse UTCTime
Creating a Request
data DescribePortal Source #
See: newDescribePortal
smart constructor.
Instances
Create a value of DescribePortal
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribePortal
, describePortal_portalId
- The ID of the portal.
Request Lenses
describePortal_portalId :: Lens' DescribePortal Text Source #
The ID of the portal.
Destructuring the Response
data DescribePortalResponse Source #
See: newDescribePortalResponse
smart constructor.
DescribePortalResponse' | |
|
Instances
newDescribePortalResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> PortalStatus | |
-> UTCTime | |
-> UTCTime | |
-> DescribePortalResponse |
Create a value of DescribePortalResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarms:DescribePortalResponse'
, describePortalResponse_alarms
- Contains the configuration information of an alarm created in an IoT
SiteWise Monitor portal.
$sel:notificationSenderEmail:DescribePortalResponse'
, describePortalResponse_notificationSenderEmail
- The email address that sends alarm notifications.
$sel:portalAuthMode:DescribePortalResponse'
, describePortalResponse_portalAuthMode
- The service to use to authenticate users to the portal.
$sel:portalDescription:DescribePortalResponse'
, describePortalResponse_portalDescription
- The portal's description.
$sel:portalLogoImageLocation:DescribePortalResponse'
, describePortalResponse_portalLogoImageLocation
- The portal's logo image, which is available at a URL.
DescribePortalResponse
, describePortalResponse_roleArn
- The
ARN
of the 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.
$sel:httpStatus:DescribePortalResponse'
, describePortalResponse_httpStatus
- The response's http status code.
DescribePortal
, describePortalResponse_portalId
- The ID of the portal.
$sel:portalArn:DescribePortalResponse'
, describePortalResponse_portalArn
- The
ARN
of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
$sel:portalName:DescribePortalResponse'
, describePortalResponse_portalName
- The name of the portal.
$sel:portalClientId:DescribePortalResponse'
, describePortalResponse_portalClientId
- The IAM Identity Center application generated client ID (used with IAM
Identity Center APIs). IoT SiteWise includes portalClientId
for only
portals that use IAM Identity Center to authenticate users.
$sel:portalStartUrl:DescribePortalResponse'
, describePortalResponse_portalStartUrl
- The URL for the IoT SiteWise Monitor portal. You can use this URL to
access portals that use IAM Identity Center for authentication. For
portals that use IAM for authentication, you must use the IoT SiteWise
console to get a URL that you can use to access the portal.
$sel:portalContactEmail:DescribePortalResponse'
, describePortalResponse_portalContactEmail
- The Amazon Web Services administrator's contact email address.
$sel:portalStatus:DescribePortalResponse'
, describePortalResponse_portalStatus
- The current status of the portal, which contains a state and any error
message.
$sel:portalCreationDate:DescribePortalResponse'
, describePortalResponse_portalCreationDate
- The date the portal was created, in Unix epoch time.
$sel:portalLastUpdateDate:DescribePortalResponse'
, describePortalResponse_portalLastUpdateDate
- The date the portal was last updated, in Unix epoch time.
Response Lenses
describePortalResponse_alarms :: Lens' DescribePortalResponse (Maybe Alarms) Source #
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
describePortalResponse_notificationSenderEmail :: Lens' DescribePortalResponse (Maybe Text) Source #
The email address that sends alarm notifications.
describePortalResponse_portalAuthMode :: Lens' DescribePortalResponse (Maybe AuthMode) Source #
The service to use to authenticate users to the portal.
describePortalResponse_portalDescription :: Lens' DescribePortalResponse (Maybe Text) Source #
The portal's description.
describePortalResponse_portalLogoImageLocation :: Lens' DescribePortalResponse (Maybe ImageLocation) Source #
The portal's logo image, which is available at a URL.
describePortalResponse_roleArn :: Lens' DescribePortalResponse (Maybe Text) Source #
The ARN of the 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.
describePortalResponse_httpStatus :: Lens' DescribePortalResponse Int Source #
The response's http status code.
describePortalResponse_portalId :: Lens' DescribePortalResponse Text Source #
The ID of the portal.
describePortalResponse_portalArn :: Lens' DescribePortalResponse Text Source #
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
describePortalResponse_portalName :: Lens' DescribePortalResponse Text Source #
The name of the portal.
describePortalResponse_portalClientId :: Lens' DescribePortalResponse Text Source #
The IAM Identity Center application generated client ID (used with IAM
Identity Center APIs). IoT SiteWise includes portalClientId
for only
portals that use IAM Identity Center to authenticate users.
describePortalResponse_portalStartUrl :: Lens' DescribePortalResponse Text Source #
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
describePortalResponse_portalContactEmail :: Lens' DescribePortalResponse Text Source #
The Amazon Web Services administrator's contact email address.
describePortalResponse_portalStatus :: Lens' DescribePortalResponse PortalStatus Source #
The current status of the portal, which contains a state and any error message.
describePortalResponse_portalCreationDate :: Lens' DescribePortalResponse UTCTime Source #
The date the portal was created, in Unix epoch time.
describePortalResponse_portalLastUpdateDate :: Lens' DescribePortalResponse UTCTime Source #
The date the portal was last updated, in Unix epoch time.