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.UpdatePortal

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an IoT SiteWise Monitor portal.

Synopsis

data UpdatePortal = UpdatePortal' {
- clientToken :: Maybe Text
- portalDescription :: Maybe Text
- notificationSenderEmail :: Maybe Text
- portalLogoImage :: Maybe Image
- alarms :: Maybe Alarms
- portalId :: Text
- portalName :: Text
- portalContactEmail :: Text
- roleArn :: Text
}
newUpdatePortal :: Text -> Text -> Text -> Text -> UpdatePortal
updatePortal_clientToken :: Lens' UpdatePortal (Maybe Text)
updatePortal_portalDescription :: Lens' UpdatePortal (Maybe Text)
updatePortal_notificationSenderEmail :: Lens' UpdatePortal (Maybe Text)
updatePortal_portalLogoImage :: Lens' UpdatePortal (Maybe Image)
updatePortal_alarms :: Lens' UpdatePortal (Maybe Alarms)
updatePortal_portalId :: Lens' UpdatePortal Text
updatePortal_portalName :: Lens' UpdatePortal Text
updatePortal_portalContactEmail :: Lens' UpdatePortal Text
updatePortal_roleArn :: Lens' UpdatePortal Text
data UpdatePortalResponse = UpdatePortalResponse' {
- httpStatus :: Int
- portalStatus :: PortalStatus
}
newUpdatePortalResponse :: Int -> PortalStatus -> UpdatePortalResponse
updatePortalResponse_httpStatus :: Lens' UpdatePortalResponse Int
updatePortalResponse_portalStatus :: Lens' UpdatePortalResponse PortalStatus

Creating a Request

data UpdatePortal Source #

See: newUpdatePortal smart constructor.

Constructors

UpdatePortal'

Fields

clientToken :: Maybe Text
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.
portalDescription :: Maybe Text
A new description for the portal.
notificationSenderEmail :: Maybe Text
The email address that sends alarm notifications.
portalLogoImage :: Maybe Image
alarms :: Maybe 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 in the IoT SiteWise Application Guide.
portalId :: Text
The ID of the portal to update.
portalName :: Text
A new friendly name for the portal.
portalContactEmail :: Text
The Amazon Web Services administrator's contact email address.
roleArn :: Text
The ARN 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 in the IoT SiteWise User Guide.

Instances

Instances details

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

newUpdatePortal Source #

Arguments

:: Text	`$sel:portalId:UpdatePortal'`
-> Text	`$sel:portalName:UpdatePortal'`
-> Text	`$sel:portalContactEmail:UpdatePortal'`
-> Text	`$sel:roleArn:UpdatePortal'`
-> UpdatePortal

Create a value of UpdatePortal 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:clientToken:UpdatePortal', updatePortal_clientToken - 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.

$sel:portalDescription:UpdatePortal', updatePortal_portalDescription - A new description for the portal.

$sel:notificationSenderEmail:UpdatePortal', updatePortal_notificationSenderEmail - The email address that sends alarm notifications.

$sel:portalLogoImage:UpdatePortal', updatePortal_portalLogoImage - Undocumented member.

$sel:alarms:UpdatePortal', updatePortal_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 in the IoT SiteWise Application Guide.

$sel:portalId:UpdatePortal', updatePortal_portalId - The ID of the portal to update.

$sel:portalName:UpdatePortal', updatePortal_portalName - A new friendly name for the portal.

$sel:portalContactEmail:UpdatePortal', updatePortal_portalContactEmail - The Amazon Web Services administrator's contact email address.

$sel:roleArn:UpdatePortal', updatePortal_roleArn - The ARN 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 in the IoT SiteWise User Guide.

Request Lenses

updatePortal_clientToken :: Lens' UpdatePortal (Maybe Text) Source #

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.

updatePortal_portalDescription :: Lens' UpdatePortal (Maybe Text) Source #

A new description for the portal.

updatePortal_notificationSenderEmail :: Lens' UpdatePortal (Maybe Text) Source #

The email address that sends alarm notifications.

updatePortal_portalLogoImage :: Lens' UpdatePortal (Maybe Image) Source #

Undocumented member.

updatePortal_alarms :: Lens' UpdatePortal (Maybe Alarms) Source #

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 in the IoT SiteWise Application Guide.

updatePortal_portalId :: Lens' UpdatePortal Text Source #

The ID of the portal to update.

updatePortal_portalName :: Lens' UpdatePortal Text Source #

A new friendly name for the portal.

updatePortal_portalContactEmail :: Lens' UpdatePortal Text Source #

The Amazon Web Services administrator's contact email address.

updatePortal_roleArn :: Lens' UpdatePortal Text Source #

The ARN 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 in the IoT SiteWise User Guide.

Destructuring the Response

data UpdatePortalResponse Source #

See: newUpdatePortalResponse smart constructor.

Constructors

UpdatePortalResponse'
Fields httpStatus :: Int The response's http status code. portalStatus :: PortalStatus The status of the portal, which contains a state (`UPDATING` after successfully calling this operation) and any error message.

Instances

Instances details

Eq UpdatePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdatePortal Methods (==) :: UpdatePortalResponse -> UpdatePortalResponse -> Bool # (/=) :: UpdatePortalResponse -> UpdatePortalResponse -> Bool #
Read UpdatePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdatePortal Methods readsPrec :: Int -> ReadS UpdatePortalResponse # readList :: ReadS [UpdatePortalResponse] # readPrec :: ReadPrec UpdatePortalResponse # readListPrec :: ReadPrec [UpdatePortalResponse] #
Show UpdatePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdatePortal Methods showsPrec :: Int -> UpdatePortalResponse -> ShowS # show :: UpdatePortalResponse -> String # showList :: [UpdatePortalResponse] -> ShowS #
Generic UpdatePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdatePortal Associated Types type Rep UpdatePortalResponse :: Type -> Type # Methods from :: UpdatePortalResponse -> Rep UpdatePortalResponse x # to :: Rep UpdatePortalResponse x -> UpdatePortalResponse #
NFData UpdatePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdatePortal Methods rnf :: UpdatePortalResponse -> () #
type Rep UpdatePortalResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdatePortal type Rep UpdatePortalResponse = D1 ('MetaData "UpdatePortalResponse" "Amazonka.IoTSiteWise.UpdatePortal" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "UpdatePortalResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "portalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PortalStatus)))

newUpdatePortalResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdatePortalResponse'`
-> PortalStatus	`$sel:portalStatus:UpdatePortalResponse'`
-> UpdatePortalResponse

Create a value of UpdatePortalResponse 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:httpStatus:UpdatePortalResponse', updatePortalResponse_httpStatus - The response's http status code.

$sel:portalStatus:UpdatePortalResponse', updatePortalResponse_portalStatus - The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.

Response Lenses

updatePortalResponse_httpStatus :: Lens' UpdatePortalResponse Int Source #

The response's http status code.

updatePortalResponse_portalStatus :: Lens' UpdatePortalResponse PortalStatus Source #

The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.