Module Values_2.GetIdentityContextResponseSource

Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs. Currently, you can call the following APIs with identity-enhanced Credentials StartDashboardSnapshotJob DescribeDashboardSnapshotJob DescribeDashboardSnapshotJobResult Supported Authentication Methods This API supports Quick Sight native users, IAM federated users, and Active Directory users. For Quick Sight users authenticated by Amazon Web Services Identity Center, see Identity Center documentation on identity-enhanced IAM role sessions. Supported Regions The GetIdentityContext API works only in regions that support at least one of these identity types: Amazon Quick Sight native identity IAM federated identity Active Directory To use this API successfully, call it in the same region where your user's identity resides. For example, if your user's identity is in us-east-1, make the API call in us-east-1. For more information about managing identities in Amazon Quick Sight, see Identity and access management in Amazon Quick Sight in the Amazon Quick Sight User Guide. Getting Identity-Enhanced Credentials To obtain identity-enhanced credentials, follow these steps: Call the GetIdentityContext API to retrieve an identity token for the specified user. Use the identity token with the STS AssumeRole API to obtain identity-enhanced IAM role session credentials. Usage with STS AssumeRole The identity token returned by this API should be used with the STS AssumeRole API to obtain credentials for an identity-enhanced IAM role session. When calling AssumeRole, include the identity token in the ProvidedContexts parameter with ProviderArn set to arn:aws:iam::aws:contextProvider/QuickSight and ContextAssertion set to the identity token received from this API. The assumed role must allow the sts:SetContext action in addition to sts:AssumeRole in its trust relationship policy. The trust policy should include both actions for the principal that will be assuming the role.

Sourcetype nonrec t = {
  1. status : int option;
    (*

    The HTTP status of the request.

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

    The Amazon Web Services request ID for this operation.

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

    The identity context information for the user. This is an identity token that should be used as the ContextAssertion parameter in the STS AssumeRole API call to obtain identity enhanced Amazon Web Services credentials.

    *)
}
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. | `PreconditionNotMetException of Values_1.PreconditionNotMetException.t
  5. | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t
  6. | `ThrottlingException of Values_1.ThrottlingException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?status:??? -> ?requestId:??? -> ?context:??? -> 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 | `PreconditionNotMetException of Values_1.PreconditionNotMetException.t | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option ]
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 | `PreconditionNotMetException of Values_1.PreconditionNotMetException.t | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of int | `String of Values_0.String_.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