Module Values.CreatePortalResponseSource

Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center 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.

Sourcetype nonrec t = {
  1. portalId : ID.t option;
    (*

    The ID of the created portal.

    *)
  2. portalArn : ARN.t option;
    (*

    The ARN of the portal, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

    *)
  3. portalStartUrl : Url.t option;
    (*

    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.

    *)
  4. portalStatus : PortalStatus.t option;
    (*

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

    *)
  5. ssoApplicationId : SSOApplicationId.t option;
    (*

    The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalFailureException of InternalFailureException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `LimitExceededException of LimitExceededException.t
  4. | `ResourceNotFoundException of ResourceNotFoundException.t
  5. | `ThrottlingException of ThrottlingException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?portalId:??? -> ?portalArn:??? -> ?portalStartUrl:??? -> ?portalStatus:??? -> ?ssoApplicationId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalFailureException of InternalFailureException.t | `InvalidRequestException of InvalidRequestException.t | `LimitExceededException of LimitExceededException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalFailureException of InternalFailureException.t | `InvalidRequestException of InvalidRequestException.t | `LimitExceededException of LimitExceededException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of ID.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of MonitorErrorMessage.t ]) list ]) 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