aws_sdk_quicksight/client/
get_identity_context.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetIdentityContext`](crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`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>
7    ///   - [`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>
8    ///   - [`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>
9    ///   - [`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>
10    /// - On success, responds with [`GetIdentityContextOutput`](crate::operation::get_identity_context::GetIdentityContextOutput) with field(s):
11    ///   - [`status(i32)`](crate::operation::get_identity_context::GetIdentityContextOutput::status): <p>The HTTP status of the request.</p>
12    ///   - [`request_id(String)`](crate::operation::get_identity_context::GetIdentityContextOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
13    ///   - [`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 AWS credentials.</p>
14    /// - On failure, responds with [`SdkError<GetIdentityContextError>`](crate::operation::get_identity_context::GetIdentityContextError)
15    pub fn get_identity_context(&self) -> crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder {
16        crate::operation::get_identity_context::builders::GetIdentityContextFluentBuilder::new(self.handle.clone())
17    }
18}