Module Values_1.GetFederationTokenResponseSource

Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

Sourcetype nonrec t = {
  1. credentials : Credentials.t option;
    (*

    The credentials to use for federation.

    *)
  2. signInUrl : Url.t option;
    (*

    The URL to sign into the user's instance.

    *)
  3. userArn : Values_0.ARN.t option;
    (*

    The Amazon Resource Name (ARN) of the user.

    *)
  4. userId : Values_0.AgentResourceId.t option;
    (*

    The identifier for the user. This can be the ID or the ARN of the user.

    *)
}
Sourcetype nonrec error = [
  1. | `DuplicateResourceException of Values_0.DuplicateResourceException.t
  2. | `InternalServiceException of Values_0.InternalServiceException.t
  3. | `InvalidParameterException of Values_0.InvalidParameterException.t
  4. | `InvalidRequestException of Values_0.InvalidRequestException.t
  5. | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t
  6. | `UserNotFoundException of UserNotFoundException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?credentials:??? -> ?signInUrl:??? -> ?userArn:??? -> ?userId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `DuplicateResourceException of Values_0.DuplicateResourceException.t | `InternalServiceException of Values_0.InternalServiceException.t | `InvalidParameterException of Values_0.InvalidParameterException.t | `InvalidRequestException of Values_0.InvalidRequestException.t | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t | `Unknown_operation_error of string * string option | `UserNotFoundException of UserNotFoundException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `DuplicateResourceException of Values_0.DuplicateResourceException.t | `InternalServiceException of Values_0.InternalServiceException.t | `InvalidParameterException of Values_0.InvalidParameterException.t | `InvalidRequestException of Values_0.InvalidRequestException.t | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t | `Unknown_operation_error of string * string option | `UserNotFoundException of UserNotFoundException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of Url.t | `Structure of (string * [> `String of SecurityToken.t | `Timestamp of string ]) 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