Module Values.AssumeRoleWithSAMLResponseSource

Contains the response to a successful AssumeRoleWithSAML request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

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

    The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

    *)
  2. assumedRoleUser : AssumedRoleUser.t option;
    (*

    The identifiers for the temporary security credentials that the operation returns.

    *)
  3. packedPolicySize : NonNegativeIntegerType.t option;
    (*

    A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

    *)
  4. subject : Subject.t option;
    (*

    The value of the NameID element in the Subject element of the SAML assertion.

    *)
  5. subjectType : SubjectType.t option;
    (*

    The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent. If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

    *)
  6. issuer : Issuer.t option;
    (*

    The value of the Issuer element of the SAML assertion.

    *)
  7. audience : Audience.t option;
    (*

    The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

    *)
  8. nameQualifier : NameQualifier.t option;
    (*

    A hash value based on the concatenation of the following: The Issuer response value. The Amazon Web Services account ID. The friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a user. The following pseudocode shows how the hash value is calculated: BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

    *)
  9. sourceIdentity : SourceIdentityType.t option;
    (*

    The value in the SourceIdentity attribute in the SAML assertion. The source identity value persists across chained role sessions. You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

    *)
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. assumeRoleWithSAMLResult : assumeRoleWithSAMLResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `ExpiredTokenException of ExpiredTokenException.t
  2. | `IDPRejectedClaimException of IDPRejectedClaimException.t
  3. | `InvalidIdentityTokenException of InvalidIdentityTokenException.t
  4. | `MalformedPolicyDocumentException of MalformedPolicyDocumentException.t
  5. | `PackedPolicyTooLargeException of PackedPolicyTooLargeException.t
  6. | `RegionDisabledException of RegionDisabledException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?credentials:??? -> ?assumedRoleUser:??? -> ?packedPolicySize:??? -> ?subject:??? -> ?subjectType:??? -> ?issuer:??? -> ?audience:??? -> ?nameQualifier:??? -> ?sourceIdentity:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ExpiredTokenException of ExpiredTokenException.t | `IDPRejectedClaimException of IDPRejectedClaimException.t | `InvalidIdentityTokenException of InvalidIdentityTokenException.t | `MalformedPolicyDocumentException of MalformedPolicyDocumentException.t | `PackedPolicyTooLargeException of PackedPolicyTooLargeException.t | `RegionDisabledException of RegionDisabledException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ExpiredTokenException of ExpiredTokenException.t | `IDPRejectedClaimException of IDPRejectedClaimException.t | `InvalidIdentityTokenException of InvalidIdentityTokenException.t | `MalformedPolicyDocumentException of MalformedPolicyDocumentException.t | `PackedPolicyTooLargeException of PackedPolicyTooLargeException.t | `RegionDisabledException of RegionDisabledException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Integer of NonNegativeIntegerType.t | `String of Subject.t | `Structure of (string * [> `String of AccessKeyIdType.t | `Timestamp of DateType.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