Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSiteWise.DescribePortal

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a portal.

Synopsis

data DescribePortal = DescribePortal' {
- portalId :: Text
}
newDescribePortal :: Text -> DescribePortal
describePortal_portalId :: Lens' DescribePortal Text
data DescribePortalResponse = DescribePortalResponse' {
- portalAuthMode :: Maybe AuthMode
- portalDescription :: Maybe Text
- notificationSenderEmail :: Maybe Text
- portalLogoImageLocation :: Maybe ImageLocation
- alarms :: Maybe Alarms
- 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_portalAuthMode :: Lens' DescribePortalResponse (Maybe AuthMode)
describePortalResponse_portalDescription :: Lens' DescribePortalResponse (Maybe Text)
describePortalResponse_notificationSenderEmail :: Lens' DescribePortalResponse (Maybe Text)
describePortalResponse_portalLogoImageLocation :: Lens' DescribePortalResponse (Maybe ImageLocation)
describePortalResponse_alarms :: Lens' DescribePortalResponse (Maybe Alarms)
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.

Constructors

DescribePortal'
Fields portalId :: Text The ID of the portal.

Instances

Instances details

Eq DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods (==) :: DescribePortal -> DescribePortal -> Bool # (/=) :: DescribePortal -> DescribePortal -> Bool #
Read DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods readsPrec :: Int -> ReadS DescribePortal # readList :: ReadS [DescribePortal] # readPrec :: ReadPrec DescribePortal # readListPrec :: ReadPrec [DescribePortal] #
Show DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods showsPrec :: Int -> DescribePortal -> ShowS # show :: DescribePortal -> String # showList :: [DescribePortal] -> ShowS #
Generic DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Associated Types type Rep DescribePortal :: Type -> Type # Methods from :: DescribePortal -> Rep DescribePortal x # to :: Rep DescribePortal x -> DescribePortal #
NFData DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods rnf :: DescribePortal -> () #
Hashable DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods hashWithSalt :: Int -> DescribePortal -> Int # hash :: DescribePortal -> Int #
AWSRequest DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Associated Types type AWSResponse DescribePortal # Methods request :: DescribePortal -> Request DescribePortal # response :: MonadResource m => Logger -> Service -> Proxy DescribePortal -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePortal))) #
ToHeaders DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods toHeaders :: DescribePortal -> [Header] #
ToPath DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods toPath :: DescribePortal -> ByteString #
ToQuery DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods toQuery :: DescribePortal -> QueryString #
type Rep DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal type Rep DescribePortal = D1 ('MetaData "DescribePortal" "Amazonka.IoTSiteWise.DescribePortal" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribePortal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "portalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal type AWSResponse DescribePortal = DescribePortalResponse

newDescribePortal Source #

Arguments

:: Text	`$sel:portalId:DescribePortal'`
-> DescribePortal

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:

$sel:portalId: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.

Constructors

DescribePortalResponse'

Fields

portalAuthMode :: Maybe AuthMode
The service to use to authenticate users to the portal.
portalDescription :: Maybe Text
The portal's description.
notificationSenderEmail :: Maybe Text
The email address that sends alarm notifications.
portalLogoImageLocation :: Maybe ImageLocation
The portal's logo image, which is available at a URL.
alarms :: Maybe Alarms
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
roleArn :: Maybe Text
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.
httpStatus :: Int
The response's http status code.
portalId :: Text
The ID of the portal.

portalArn :: Text

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

portalName :: Text
The name of the portal.
portalClientId :: Text
The Amazon Web Services SSO application generated client ID (used with Amazon Web Services SSO APIs). IoT SiteWise includes portalClientId for only portals that use Amazon Web Services SSO to authenticate users.
portalStartUrl :: Text
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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.
portalContactEmail :: Text
The Amazon Web Services administrator's contact email address.
portalStatus :: PortalStatus
The current status of the portal, which contains a state and any error message.
portalCreationDate :: POSIX
The date the portal was created, in Unix epoch time.
portalLastUpdateDate :: POSIX
The date the portal was last updated, in Unix epoch time.

Instances

Instances details

Eq DescribePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods (==) :: DescribePortalResponse -> DescribePortalResponse -> Bool # (/=) :: DescribePortalResponse -> DescribePortalResponse -> Bool #
Read DescribePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods readsPrec :: Int -> ReadS DescribePortalResponse # readList :: ReadS [DescribePortalResponse] # readPrec :: ReadPrec DescribePortalResponse # readListPrec :: ReadPrec [DescribePortalResponse] #
Show DescribePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods showsPrec :: Int -> DescribePortalResponse -> ShowS # show :: DescribePortalResponse -> String # showList :: [DescribePortalResponse] -> ShowS #
Generic DescribePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Associated Types type Rep DescribePortalResponse :: Type -> Type # Methods from :: DescribePortalResponse -> Rep DescribePortalResponse x # to :: Rep DescribePortalResponse x -> DescribePortalResponse #
NFData DescribePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal Methods rnf :: DescribePortalResponse -> () #
type Rep DescribePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribePortal type Rep DescribePortalResponse = D1 ('MetaData "DescribePortalResponse" "Amazonka.IoTSiteWise.DescribePortal" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribePortalResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "portalAuthMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthMode)) :: S1 ('MetaSel ('Just "portalDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "notificationSenderEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "portalLogoImageLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageLocation)))) :: ((S1 ('MetaSel ('Just "alarms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Alarms)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "portalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: (((S1 ('MetaSel ('Just "portalArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "portalName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "portalClientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "portalStartUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "portalContactEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "portalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PortalStatus)) :: (S1 ('MetaSel ('Just "portalCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "portalLastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDescribePortalResponse Source #

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:portalAuthMode:DescribePortalResponse', describePortalResponse_portalAuthMode - The service to use to authenticate users to the portal.

$sel:portalDescription:DescribePortalResponse', describePortalResponse_portalDescription - The portal's description.

$sel:notificationSenderEmail:DescribePortalResponse', describePortalResponse_notificationSenderEmail - The email address that sends alarm notifications.

$sel:portalLogoImageLocation:DescribePortalResponse', describePortalResponse_portalLogoImageLocation - The portal's logo image, which is available at a URL.

$sel:alarms:DescribePortalResponse', describePortalResponse_alarms - Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

$sel:roleArn: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.

$sel:portalId: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 Amazon Web Services SSO application generated client ID (used with Amazon Web Services SSO APIs). IoT SiteWise includes portalClientId for only portals that use Amazon Web Services SSO 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 Amazon Web Services SSO 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_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_notificationSenderEmail :: Lens' DescribePortalResponse (Maybe Text) Source #

The email address that sends alarm notifications.

describePortalResponse_portalLogoImageLocation :: Lens' DescribePortalResponse (Maybe ImageLocation) Source #

The portal's logo image, which is available at a URL.

describePortalResponse_alarms :: Lens' DescribePortalResponse (Maybe Alarms) Source #

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

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 Amazon Web Services SSO application generated client ID (used with Amazon Web Services SSO APIs). IoT SiteWise includes portalClientId for only portals that use Amazon Web Services SSO 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 Amazon Web Services SSO 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.

:: Int	`$sel:httpStatus:DescribePortalResponse'`
-> Text	`$sel:portalId:DescribePortal'`
-> Text	`$sel:portalArn:DescribePortalResponse'`
-> Text	`$sel:portalName:DescribePortalResponse'`
-> Text	`$sel:portalClientId:DescribePortalResponse'`
-> Text	`$sel:portalStartUrl:DescribePortalResponse'`
-> Text	`$sel:portalContactEmail:DescribePortalResponse'`
-> PortalStatus	`$sel:portalStatus:DescribePortalResponse'`
-> UTCTime	`$sel:portalCreationDate:DescribePortalResponse'`
-> UTCTime	`$sel:portalLastUpdateDate:DescribePortalResponse'`
-> DescribePortalResponse