aws_sdk_quicksight/client/
generate_embed_url_for_registered_user.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 [`GenerateEmbedUrlForRegisteredUser`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p><br>
7    ///   - [`session_lifetime_in_minutes(i64)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::session_lifetime_in_minutes) / [`set_session_lifetime_in_minutes(Option<i64>)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::set_session_lifetime_in_minutes):<br>required: **false**<br><p>How many minutes the session is valid. The session lifetime must be in \[15-600\] minutes range.</p><br>
8    ///   - [`user_arn(impl Into<String>)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::user_arn) / [`set_user_arn(Option<String>)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::set_user_arn):<br>required: **true**<br><p>The Amazon Resource Name for the registered user.</p><br>
9    ///   - [`experience_configuration(RegisteredUserEmbeddingExperienceConfiguration)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::experience_configuration) / [`set_experience_configuration(Option<RegisteredUserEmbeddingExperienceConfiguration>)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::set_experience_configuration):<br>required: **true**<br><p>The experience that you want to embed. For registered users, you can embed QuickSight dashboards, QuickSight visuals, the QuickSight Q search bar, the QuickSight Generative Q&amp;A experience, or the entire QuickSight console.</p><br>
10    ///   - [`allowed_domains(impl Into<String>)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::allowed_domains) / [`set_allowed_domains(Option<Vec::<String>>)`](crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::set_allowed_domains):<br>required: **false**<br><p>The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.</p> <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>. For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under <code>https://sapp.amazon.com</code>.</p><br>
11    /// - On success, responds with [`GenerateEmbedUrlForRegisteredUserOutput`](crate::operation::generate_embed_url_for_registered_user::GenerateEmbedUrlForRegisteredUserOutput) with field(s):
12    ///   - [`embed_url(String)`](crate::operation::generate_embed_url_for_registered_user::GenerateEmbedUrlForRegisteredUserOutput::embed_url): <p>The embed URL for the QuickSight dashboard, visual, Q search bar, Generative Q&amp;A experience, or console.</p>
13    ///   - [`status(i32)`](crate::operation::generate_embed_url_for_registered_user::GenerateEmbedUrlForRegisteredUserOutput::status): <p>The HTTP status of the request.</p>
14    ///   - [`request_id(String)`](crate::operation::generate_embed_url_for_registered_user::GenerateEmbedUrlForRegisteredUserOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
15    /// - On failure, responds with [`SdkError<GenerateEmbedUrlForRegisteredUserError>`](crate::operation::generate_embed_url_for_registered_user::GenerateEmbedUrlForRegisteredUserError)
16    pub fn generate_embed_url_for_registered_user(
17        &self,
18    ) -> crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder {
19        crate::operation::generate_embed_url_for_registered_user::builders::GenerateEmbedUrlForRegisteredUserFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_quicksight/client/generate_embed_url_for_registered_user.rs

aws_sdk_quicksight/client/
generate_embed_url_for_registered_user.rs
