amazonka-iotsitewise-2.0: Amazon IoT SiteWise SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTSiteWise.Types.PortalSummary

Description

 
Synopsis

Documentation

data PortalSummary Source #

Contains a portal summary.

See: newPortalSummary smart constructor.

Constructors

PortalSummary' 

Fields

Instances

Instances details
FromJSON PortalSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.PortalSummary

Methods

parseJSON :: Value -> Parser PortalSummary #

parseJSONList :: Value -> Parser [PortalSummary] #

Generic PortalSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.PortalSummary

Associated Types

type Rep PortalSummary :: Type -> Type #

Methods

from :: PortalSummary -> Rep PortalSummary x #

to :: Rep PortalSummary x -> PortalSummary #

Read PortalSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.PortalSummary

Methods

readsPrec :: Int -> ReadS PortalSummary #

readList :: ReadS [PortalSummary] #

readPrec :: ReadPrec PortalSummary #

readListPrec :: ReadPrec [PortalSummary] #

Show PortalSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.PortalSummary

Methods

showsPrec :: Int -> PortalSummary -> ShowS #

show :: PortalSummary -> String #

showList :: [PortalSummary] -> ShowS #

NFData PortalSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.PortalSummary

Methods

rnf :: PortalSummary -> () #

Eq PortalSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.PortalSummary

Methods

(==) :: PortalSummary -> PortalSummary -> Bool #

(/=) :: PortalSummary -> PortalSummary -> Bool #

Hashable PortalSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.PortalSummary

Methods

hashWithSalt :: Int -> PortalSummary -> Int #

hash :: PortalSummary -> Int #

type Rep PortalSummary Source # 
Instance details

Defined in Amazonka.IoTSiteWise.Types.PortalSummary

type Rep PortalSummary = D1 ('MetaData "PortalSummary" "Amazonka.IoTSiteWise.Types.PortalSummary" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "PortalSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "startUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PortalStatus)))))

newPortalSummary Source #

Arguments

:: Text

$sel:id:PortalSummary'

-> Text

$sel:name:PortalSummary'

-> Text

$sel:startUrl:PortalSummary'

-> PortalStatus

$sel:status:PortalSummary'

-> PortalSummary 

Create a value of PortalSummary 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:creationDate:PortalSummary', portalSummary_creationDate - The date the portal was created, in Unix epoch time.

$sel:description:PortalSummary', portalSummary_description - The portal's description.

$sel:lastUpdateDate:PortalSummary', portalSummary_lastUpdateDate - The date the portal was last updated, in Unix epoch time.

$sel:roleArn:PortalSummary', portalSummary_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:id:PortalSummary', portalSummary_id - The ID of the portal.

$sel:name:PortalSummary', portalSummary_name - The name of the portal.

$sel:startUrl:PortalSummary', portalSummary_startUrl - 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:status:PortalSummary', portalSummary_status - Undocumented member.

portalSummary_creationDate :: Lens' PortalSummary (Maybe UTCTime) Source #

The date the portal was created, in Unix epoch time.

portalSummary_description :: Lens' PortalSummary (Maybe Text) Source #

The portal's description.

portalSummary_lastUpdateDate :: Lens' PortalSummary (Maybe UTCTime) Source #

The date the portal was last updated, in Unix epoch time.

portalSummary_roleArn :: Lens' PortalSummary (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.

portalSummary_id :: Lens' PortalSummary Text Source #

The ID of the portal.

portalSummary_name :: Lens' PortalSummary Text Source #

The name of the portal.

portalSummary_startUrl :: Lens' PortalSummary 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.

portalSummary_status :: Lens' PortalSummary PortalStatus Source #

Undocumented member.