aws_sdk_quicksight/client/

get_dashboard_embed_url.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetDashboardEmbedUrl`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::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>
    ///   - [`dashboard_id(impl Into<String>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::dashboard_id) / [`set_dashboard_id(Option<String>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::set_dashboard_id):<br>required: **true**<br><p>The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.</p><br>
    ///   - [`identity_type(EmbeddingIdentityType)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::identity_type) / [`set_identity_type(Option<EmbeddingIdentityType>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::set_identity_type):<br>required: **true**<br><p>The authentication method that the user uses to sign in.</p><br>
    ///   - [`session_lifetime_in_minutes(i64)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::session_lifetime_in_minutes) / [`set_session_lifetime_in_minutes(Option<i64>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::set_session_lifetime_in_minutes):<br>required: **false**<br><p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p><br>
    ///   - [`undo_redo_disabled(bool)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::undo_redo_disabled) / [`set_undo_redo_disabled(Option<bool>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::set_undo_redo_disabled):<br>required: **false**<br><p>Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.</p><br>
    ///   - [`reset_disabled(bool)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::reset_disabled) / [`set_reset_disabled(Option<bool>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::set_reset_disabled):<br>required: **false**<br><p>Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.</p><br>
    ///   - [`state_persistence_enabled(bool)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::state_persistence_enabled) / [`set_state_persistence_enabled(Option<bool>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::set_state_persistence_enabled):<br>required: **false**<br><p>Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to <code>TRUE</code>, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is <code>FALSE</code>.</p><br>
    ///   - [`user_arn(impl Into<String>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::user_arn) / [`set_user_arn(Option<String>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::set_user_arn):<br>required: **false**<br><p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:</p> <ul>  <li>   <p>Active Directory (AD) users or group members</p></li>  <li>   <p>Invited nonfederated users</p></li>  <li>   <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.</p></li> </ul> <p>Omit this parameter for users in the third group – IAM users and IAM role-based sessions.</p><br>
    ///   - [`namespace(impl Into<String>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::set_namespace):<br>required: **false**<br><p>The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set <code>Namespace = default</code>.</p><br>
    ///   - [`additional_dashboard_ids(impl Into<String>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::additional_dashboard_ids) / [`set_additional_dashboard_ids(Option<Vec::<String>>)`](crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::set_additional_dashboard_ids):<br>required: **false**<br><p>A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the <code>IdentityType</code> parameter must be set to <code>ANONYMOUS</code> because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.</p><br>
    /// - On success, responds with [`GetDashboardEmbedUrlOutput`](crate::operation::get_dashboard_embed_url::GetDashboardEmbedUrlOutput) with field(s):
    ///   - [`embed_url(Option<String>)`](crate::operation::get_dashboard_embed_url::GetDashboardEmbedUrlOutput::embed_url): <p>A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an <code>auth_code</code> value that enables one (and only one) sign-on to a user session that is valid for 10 hours.</p>
    ///   - [`status(i32)`](crate::operation::get_dashboard_embed_url::GetDashboardEmbedUrlOutput::status): <p>The HTTP status of the request.</p>
    ///   - [`request_id(Option<String>)`](crate::operation::get_dashboard_embed_url::GetDashboardEmbedUrlOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
    /// - On failure, responds with [`SdkError<GetDashboardEmbedUrlError>`](crate::operation::get_dashboard_embed_url::GetDashboardEmbedUrlError)
    pub fn get_dashboard_embed_url(&self) -> crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder {
        crate::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlFluentBuilder::new(self.handle.clone())
    }
}