libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTSiteWise.UpdatePortal

Description

Updates an IoT SiteWise Monitor portal.

Synopsis

Creating a Request

data UpdatePortal Source #

See: newUpdatePortal smart constructor.

Constructors

UpdatePortal' 

Fields

Instances

Instances details
Eq UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

Read UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

Show UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

Generic UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

Associated Types

type Rep UpdatePortal :: Type -> Type #

NFData UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

Methods

rnf :: UpdatePortal -> () #

Hashable UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

ToJSON UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

AWSRequest UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

Associated Types

type AWSResponse UpdatePortal #

ToHeaders UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

ToPath UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

ToQuery UpdatePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

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

newUpdatePortal Source #

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_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

Read UpdatePortalResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

Show UpdatePortalResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

Generic UpdatePortalResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.UpdatePortal

Associated Types

type Rep UpdatePortalResponse :: Type -> Type #

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 #

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_portalStatus :: Lens' UpdatePortalResponse PortalStatus Source #

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