Module Values.AssumeRootResponseSource

Returns a set of short term credentials you can use to perform privileged tasks on a member account in your organization. You must use credentials from an Organizations management account or a delegated administrator account for IAM to call AssumeRoot. You cannot use root user credentials to make this call. Before you can launch a privileged session, you must have centralized root access in your organization. For steps to enable this feature, see Centralize root access for member accounts in the IAM User Guide. The STS global endpoint is not supported for AssumeRoot. You must send this request to a Regional STS endpoint. For more information, see Endpoints. You can track AssumeRoot in CloudTrail logs to determine what actions were performed in a session. For more information, see Track privileged tasks in CloudTrail in the IAM User Guide. When granting access to privileged tasks you should only grant the necessary permissions required to perform that task. For more information, see Security best practices in IAM. In addition, you can use service control policies (SCPs) to manage and limit permissions in your organization. See General examples in the Organizations User Guide for more information on SCPs.

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

    The temporary security credentials, which include an access key ID, a secret access key, and a security 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. sourceIdentity : SourceIdentityType.t option;
    (*

    The source identity specified by the principal that is calling the AssumeRoot operation. You can use the aws:SourceIdentity condition key to control access based on the value of source identity. 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. assumeRootResult : assumeRootResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `ExpiredTokenException of ExpiredTokenException.t
  2. | `RegionDisabledException of RegionDisabledException.t
  3. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?credentials:??? -> ?sourceIdentity:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ExpiredTokenException of ExpiredTokenException.t | `RegionDisabledException of RegionDisabledException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ExpiredTokenException of ExpiredTokenException.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 * [> `String of SourceIdentityType.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