aws-sdk-quicksight 1.131.0

AWS SDK for Amazon QuickSight
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetIdentityContext`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID for the Amazon Web Services account that the user whose identity context you want to retrieve is in. Currently, you use the ID for the Amazon Web Services account that contains your Quick Sight account.</p><br>
    ///   - [`user_identifier(UserIdentifier)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::user_identifier) / [`set_user_identifier(Option<UserIdentifier>)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::set_user_identifier):<br>required: **true**<br><p>The identifier for the user whose identity context you want to retrieve.</p><br>
    ///   - [`namespace(impl Into<String>)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::set_namespace):<br>required: **false**<br><p>The namespace of the user that you want to get identity context for. This parameter is required when the UserIdentifier is specified using Email or UserName.</p><br>
    ///   - [`session_expires_at(DateTime)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::session_expires_at) / [`set_session_expires_at(Option<DateTime>)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::set_session_expires_at):<br>required: **false**<br><p>The timestamp at which the session will expire.</p><br>
    ///   - [`context_region(impl Into<String>)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::context_region) / [`set_context_region(Option<String>)`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::set_context_region):<br>required: **false**<br><p>The region in which the context is to be used. Use this parameter to obtain an identity context for cross-region use.</p> <p>The specified region must meet the following conditions:</p> <ul>  <li>   <p>The region must be in the same Amazon Web Services partition as the region you are calling from. Cross-partition requests are not supported. For example, you cannot specify a region in the <code>aws-cn</code> partition when calling from a region in the <code>aws</code> partition.</p></li>  <li>   <p>It must be a valid Amazon QuickSight supported region.</p></li>  <li>   <p>The calling customer account must be enabled in the specified context region.</p></li>  <li>   <p>This parameter is not supported when calling from an opt-in region.</p></li> </ul><br>
    /// - On success, responds with [`GetIdentityContextOutput`](crate::operation::get_identity_context::GetIdentityContextOutput) with field(s):
    ///   - [`status(i32)`](crate::operation::get_identity_context::GetIdentityContextOutput::status): <p>The HTTP status of the request.</p>
    ///   - [`request_id(String)`](crate::operation::get_identity_context::GetIdentityContextOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
    ///   - [`context(Option<String>)`](crate::operation::get_identity_context::GetIdentityContextOutput::context): <p>The identity context information for the user. This is an identity token that should be used as the ContextAssertion parameter in the <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">STS AssumeRole API</a> call to obtain identity enhanced Amazon Web Services credentials.</p>
    /// - On failure, responds with [`SdkError<GetIdentityContextError>`](crate::operation::get_identity_context::GetIdentityContextError)
    pub fn get_identity_context(&self) -> crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder {
        crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::new(self.handle.clone())
    }
}