CreatePortalRequest (p.awso.0.9.1.doc.awso.iotsitewise.Awso_iotsitewise.Values.CreatePortalRequest)

Sourcetype nonrec t = {

portalName : Name.t;
(*
A friendly name for the portal.
*)
portalDescription : Description.t option;
(*
A description for the portal.
*)
portalContactEmail : Email.t;
(*
The Amazon Web Services administrator's contact email address.
*)
clientToken : ClientToken.t option;
(*
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.
*)
portalLogoImageFile : ImageFile.t option;
(*
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
*)
roleArn : IamArn.t;
(*
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.
*)
tags : TagMap.t option;
(*
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.
*)
portalAuthMode : AuthMode.t option;
(*
The service to use to authenticate users to the portal. Choose from the following options: SSO – The portal uses IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center 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. You can't change this value after you create a portal. Default: SSO
*)
notificationSenderEmail : Email.t option;
(*
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 : Alarms.t option;
(*
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.
*)
portalType : PortalType.t option;
(*
Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
*)
portalTypeConfiguration : PortalTypeConfiguration.t option;
(*
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
*)

}

Sourceval context_ : string

val make : 
  ?portalDescription:??? ->
  ?clientToken:??? ->
  ?portalLogoImageFile:??? ->
  ?tags:??? ->
  ?portalAuthMode:??? ->
  ?notificationSenderEmail:??? ->
  ?alarms:??? ->
  ?portalType:??? ->
  ?portalTypeConfiguration:??? ->
  portalName:Name.t ->
  portalContactEmail:Email.t ->
  roleArn:IamArn.t ->
  unit ->
  t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Enum of string
          | `Map of
            ([> `String of TagKey.t ]
             * [> `String of TagValue.t
               | `Structure of
                 (string * [> `List of [> `String of Name.t ] list ]) list ])
              list
          | `String of Name.t
          | `Structure of
            (string
             * [> `Blob of ImageFileData.t
               | `Enum of string
               | `String of IamArn.t ])
              list ])
         list ]

Sourceval to_query : t -> Awso.Client.Query.t

Sourceval of_xml : Awso.Xml.t -> t

Sourceval of_string : string -> t

Sourceval of_json : Yojson.Safe.t -> t

Sourceval to_json : t -> Yojson.Safe.t