aws_sdk_quicksight/client/

generate_embed_url_for_anonymous_user.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GenerateEmbedUrlForAnonymousUser`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::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>
    ///   - [`session_lifetime_in_minutes(i64)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::session_lifetime_in_minutes) / [`set_session_lifetime_in_minutes(Option<i64>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::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>
    ///   - [`namespace(impl Into<String>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::set_namespace):<br>required: **true**<br><p>The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to <code>default</code>.</p><br>
    ///   - [`session_tags(SessionTag)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::session_tags) / [`set_session_tags(Option<Vec::<SessionTag>>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::set_session_tags):<br>required: **false**<br><p>The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the <code>DataSet$RowLevelPermissionTagConfiguration</code> parameter so that session tags can be used to provide row-level security.</p> <p>These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon QuickSight User Guide</i>.</p><br>
    ///   - [`authorized_resource_arns(impl Into<String>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::authorized_resource_arns) / [`set_authorized_resource_arns(Option<Vec::<String>>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::set_authorized_resource_arns):<br>required: **true**<br><p>The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.</p> <p>If you choose <code>Dashboard</code> embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.</p> <p>If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.</p> <p>Currently, you can pass up to 25 theme ARNs in each API call.</p><br>
    ///   - [`experience_configuration(AnonymousUserEmbeddingExperienceConfiguration)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::experience_configuration) / [`set_experience_configuration(Option<AnonymousUserEmbeddingExperienceConfiguration>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::set_experience_configuration):<br>required: **true**<br><p>The configuration of the experience that you are embedding.</p><br>
    ///   - [`allowed_domains(impl Into<String>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::allowed_domains) / [`set_allowed_domains(Option<Vec::<String>>)`](crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::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 Amazon 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>
    /// - On success, responds with [`GenerateEmbedUrlForAnonymousUserOutput`](crate::operation::generate_embed_url_for_anonymous_user::GenerateEmbedUrlForAnonymousUserOutput) with field(s):
    ///   - [`embed_url(String)`](crate::operation::generate_embed_url_for_anonymous_user::GenerateEmbedUrlForAnonymousUserOutput::embed_url): <p>The embed URL for the dashboard.</p>
    ///   - [`status(i32)`](crate::operation::generate_embed_url_for_anonymous_user::GenerateEmbedUrlForAnonymousUserOutput::status): <p>The HTTP status of the request.</p>
    ///   - [`request_id(String)`](crate::operation::generate_embed_url_for_anonymous_user::GenerateEmbedUrlForAnonymousUserOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
    ///   - [`anonymous_user_arn(String)`](crate::operation::generate_embed_url_for_anonymous_user::GenerateEmbedUrlForAnonymousUserOutput::anonymous_user_arn): <p>The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.</p>
    /// - On failure, responds with [`SdkError<GenerateEmbedUrlForAnonymousUserError>`](crate::operation::generate_embed_url_for_anonymous_user::GenerateEmbedUrlForAnonymousUserError)
    pub fn generate_embed_url_for_anonymous_user(
        &self,
    ) -> crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder {
        crate::operation::generate_embed_url_for_anonymous_user::builders::GenerateEmbedUrlForAnonymousUserFluentBuilder::new(self.handle.clone())
    }
}