Module Values_2.GetSessionEmbedUrlResponseSource

Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon Quick Sight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick User Guide: Embedding Analytics Customizing Access to the Amazon Quick Console

Sourcetype nonrec t = {
  1. embedUrl : EmbeddingUrl.t option;
    (*

    A single-use URL that you can put into your server-side web page to embed your Quick session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.

    *)
  2. status : Values_1.StatusCode.t option;
    (*

    The HTTP status of the request.

    *)
  3. requestId : Values_0.String_.t option;
    (*

    The Amazon Web Services request ID for this operation.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of Values_0.AccessDeniedException.t
  2. | `InternalFailureException of Values_1.InternalFailureException.t
  3. | `InvalidParameterValueException of Values_1.InvalidParameterValueException.t
  4. | `QuickSightUserNotFoundException of QuickSightUserNotFoundException.t
  5. | `ResourceExistsException of Values_1.ResourceExistsException.t
  6. | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t
  7. | `SessionLifetimeInMinutesInvalidException of SessionLifetimeInMinutesInvalidException.t
  8. | `ThrottlingException of Values_1.ThrottlingException.t
  9. | `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t
  10. | `Unknown_operation_error of string * string option
]
Sourceval make : ?embedUrl:??? -> ?status:??? -> ?requestId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `InternalFailureException of Values_1.InternalFailureException.t | `InvalidParameterValueException of Values_1.InvalidParameterValueException.t | `QuickSightUserNotFoundException of QuickSightUserNotFoundException.t | `ResourceExistsException of Values_1.ResourceExistsException.t | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t | `SessionLifetimeInMinutesInvalidException of SessionLifetimeInMinutesInvalidException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option | `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `InternalFailureException of Values_1.InternalFailureException.t | `InvalidParameterValueException of Values_1.InvalidParameterValueException.t | `QuickSightUserNotFoundException of QuickSightUserNotFoundException.t | `ResourceExistsException of Values_1.ResourceExistsException.t | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t | `SessionLifetimeInMinutesInvalidException of SessionLifetimeInMinutesInvalidException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option | `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of Values_1.StatusCode.t | `String of EmbeddingUrl.t ]) 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