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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate portal users and manage user permissions.

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.

Synopsis

data CreatePortal = CreatePortal' {
- portalAuthMode :: Maybe AuthMode
- clientToken :: Maybe Text
- portalDescription :: Maybe Text
- notificationSenderEmail :: Maybe Text
- alarms :: Maybe Alarms
- portalLogoImageFile :: Maybe ImageFile
- tags :: Maybe (HashMap Text Text)
- portalName :: Text
- portalContactEmail :: Text
- roleArn :: Text
}
newCreatePortal :: Text -> Text -> Text -> CreatePortal
createPortal_portalAuthMode :: Lens' CreatePortal (Maybe AuthMode)
createPortal_clientToken :: Lens' CreatePortal (Maybe Text)
createPortal_portalDescription :: Lens' CreatePortal (Maybe Text)
createPortal_notificationSenderEmail :: Lens' CreatePortal (Maybe Text)
createPortal_alarms :: Lens' CreatePortal (Maybe Alarms)
createPortal_portalLogoImageFile :: Lens' CreatePortal (Maybe ImageFile)
createPortal_tags :: Lens' CreatePortal (Maybe (HashMap Text Text))
createPortal_portalName :: Lens' CreatePortal Text
createPortal_portalContactEmail :: Lens' CreatePortal Text
createPortal_roleArn :: Lens' CreatePortal Text
data CreatePortalResponse = CreatePortalResponse' {
- httpStatus :: Int
- portalId :: Text
- portalArn :: Text
- portalStartUrl :: Text
- portalStatus :: PortalStatus
- ssoApplicationId :: Text
}
newCreatePortalResponse :: Int -> Text -> Text -> Text -> PortalStatus -> Text -> CreatePortalResponse
createPortalResponse_httpStatus :: Lens' CreatePortalResponse Int
createPortalResponse_portalId :: Lens' CreatePortalResponse Text
createPortalResponse_portalArn :: Lens' CreatePortalResponse Text
createPortalResponse_portalStartUrl :: Lens' CreatePortalResponse Text
createPortalResponse_portalStatus :: Lens' CreatePortalResponse PortalStatus
createPortalResponse_ssoApplicationId :: Lens' CreatePortalResponse Text

Creating a Request

data CreatePortal Source #

See: newCreatePortal smart constructor.

Constructors

CreatePortal'

Fields

portalAuthMode :: Maybe AuthMode
The service to use to authenticate users to the portal. Choose from the following options:
- SSO – The portal uses Amazon Web Services Single Sign On to authenticate users and manage user permissions. Before you can create a portal that uses Amazon Web Services SSO, you must enable Amazon Web Services SSO. For more information, see Enabling Amazon Web Services SSO in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.
- IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions. This option is only available in the China Regions.
You can't change this value after you create a portal.
Default: SSO
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 description for the portal.
notificationSenderEmail :: Maybe Text
The email address that sends alarm notifications.
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
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.
portalLogoImageFile :: Maybe ImageFile
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
tags :: Maybe (HashMap Text Text)
A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
portalName :: Text
A 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 CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Methods (==) :: CreatePortal -> CreatePortal -> Bool # (/=) :: CreatePortal -> CreatePortal -> Bool #
Read CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Methods readsPrec :: Int -> ReadS CreatePortal # readList :: ReadS [CreatePortal] # readPrec :: ReadPrec CreatePortal # readListPrec :: ReadPrec [CreatePortal] #
Show CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Methods showsPrec :: Int -> CreatePortal -> ShowS # show :: CreatePortal -> String # showList :: [CreatePortal] -> ShowS #
Generic CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Associated Types type Rep CreatePortal :: Type -> Type # Methods from :: CreatePortal -> Rep CreatePortal x # to :: Rep CreatePortal x -> CreatePortal #
NFData CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Methods rnf :: CreatePortal -> () #
Hashable CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Methods hashWithSalt :: Int -> CreatePortal -> Int # hash :: CreatePortal -> Int #
ToJSON CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Methods toJSON :: CreatePortal -> Value # toEncoding :: CreatePortal -> Encoding # toJSONList :: [CreatePortal] -> Value # toEncodingList :: [CreatePortal] -> Encoding #
AWSRequest CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Associated Types type AWSResponse CreatePortal # Methods request :: CreatePortal -> Request CreatePortal # response :: MonadResource m => Logger -> Service -> Proxy CreatePortal -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePortal))) #
ToHeaders CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Methods toHeaders :: CreatePortal -> [Header] #
ToPath CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Methods toPath :: CreatePortal -> ByteString #
ToQuery CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal Methods toQuery :: CreatePortal -> QueryString #
type Rep CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal type Rep CreatePortal = D1 ('MetaData "CreatePortal" "Amazonka.IoTSiteWise.CreatePortal" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "CreatePortal'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "portalAuthMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthMode)) :: 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 "alarms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Alarms))))) :: ((S1 ('MetaSel ('Just "portalLogoImageFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageFile)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text 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 CreatePortal Source #
Instance details Defined in Amazonka.IoTSiteWise.CreatePortal type AWSResponse CreatePortal = CreatePortalResponse

newCreatePortal Source #

Arguments

:: Text	`$sel:portalName:CreatePortal'`
-> Text	`$sel:portalContactEmail:CreatePortal'`
-> Text	`$sel:roleArn:CreatePortal'`
-> CreatePortal

Create a value of CreatePortal 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:CreatePortal', createPortal_portalAuthMode - The service to use to authenticate users to the portal. Choose from the following options:

SSO – The portal uses Amazon Web Services Single Sign On to authenticate users and manage user permissions. Before you can create a portal that uses Amazon Web Services SSO, you must enable Amazon Web Services SSO. For more information, see Enabling Amazon Web Services SSO in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.
IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

$sel:clientToken:CreatePortal', createPortal_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:CreatePortal', createPortal_portalDescription - A description for the portal.

$sel:notificationSenderEmail:CreatePortal', createPortal_notificationSenderEmail - The email address that sends alarm notifications.

If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

$sel:alarms:CreatePortal', createPortal_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:portalLogoImageFile:CreatePortal', createPortal_portalLogoImageFile - A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

$sel:tags:CreatePortal', createPortal_tags - A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

$sel:portalName:CreatePortal', createPortal_portalName - A friendly name for the portal.

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

$sel:roleArn:CreatePortal', createPortal_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

createPortal_portalAuthMode :: Lens' CreatePortal (Maybe AuthMode) Source #

The service to use to authenticate users to the portal. Choose from the following options:

SSO – The portal uses Amazon Web Services Single Sign On to authenticate users and manage user permissions. Before you can create a portal that uses Amazon Web Services SSO, you must enable Amazon Web Services SSO. For more information, see Enabling Amazon Web Services SSO in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.
IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

createPortal_clientToken :: Lens' CreatePortal (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.

createPortal_portalDescription :: Lens' CreatePortal (Maybe Text) Source #

A description for the portal.

createPortal_notificationSenderEmail :: Lens' CreatePortal (Maybe Text) Source #

The email address that sends alarm notifications.

If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

createPortal_alarms :: Lens' CreatePortal (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.

createPortal_portalLogoImageFile :: Lens' CreatePortal (Maybe ImageFile) Source #

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

createPortal_tags :: Lens' CreatePortal (Maybe (HashMap Text Text)) Source #

A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

createPortal_portalName :: Lens' CreatePortal Text Source #

A friendly name for the portal.

createPortal_portalContactEmail :: Lens' CreatePortal Text Source #

The Amazon Web Services administrator's contact email address.

createPortal_roleArn :: Lens' CreatePortal 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 CreatePortalResponse Source #

See: newCreatePortalResponse smart constructor.

Constructors

CreatePortalResponse'

Fields

httpStatus :: Int
The response's http status code.
portalId :: Text
The ID of the created portal.

portalArn :: Text

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

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

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.
portalStatus :: PortalStatus
The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
ssoApplicationId :: Text
The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.

Instances

Instances details

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

newCreatePortalResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreatePortalResponse'`
-> Text	`$sel:portalId:CreatePortalResponse'`
-> Text	`$sel:portalArn:CreatePortalResponse'`
-> Text	`$sel:portalStartUrl:CreatePortalResponse'`
-> PortalStatus	`$sel:portalStatus:CreatePortalResponse'`
-> Text	`$sel:ssoApplicationId:CreatePortalResponse'`
-> CreatePortalResponse

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

$sel:portalId:CreatePortalResponse', createPortalResponse_portalId - The ID of the created portal.

$sel:portalArn:CreatePortalResponse', createPortalResponse_portalArn - The ARN of the portal, which has the following format.

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

$sel:portalStartUrl:CreatePortalResponse', createPortalResponse_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:portalStatus:CreatePortalResponse', createPortalResponse_portalStatus - The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

$sel:ssoApplicationId:CreatePortalResponse', createPortalResponse_ssoApplicationId - The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.

Response Lenses

createPortalResponse_httpStatus :: Lens' CreatePortalResponse Int Source #

The response's http status code.

createPortalResponse_portalId :: Lens' CreatePortalResponse Text Source #

The ID of the created portal.

createPortalResponse_portalArn :: Lens' CreatePortalResponse Text Source #

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

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

createPortalResponse_portalStartUrl :: Lens' CreatePortalResponse 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.

createPortalResponse_portalStatus :: Lens' CreatePortalResponse PortalStatus Source #

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

createPortalResponse_ssoApplicationId :: Lens' CreatePortalResponse Text Source #

The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.