Struct aws_sdk_quicksight::client::fluent_builders::GetDashboardEmbedUrl

pub struct GetDashboardEmbedUrl { /* private fields */ }

Fluent builder constructing a request to GetDashboardEmbedUrl.

Generates a session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:

• They must be used together.

• They can be used one time only.

• They are valid for 5 minutes after you run this command.

• The resulting user session is valid for 10 hours.

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Implementations

impl GetDashboardEmbedUrl

pub async fn send(
    self
) -> Result<GetDashboardEmbedUrlOutput, SdkError<GetDashboardEmbedUrlError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn aws_account_id(self, input: impl Into<String>) -> Self

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

pub fn set_aws_account_id(self, input: Option<String>) -> Self

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

pub fn dashboard_id(self, input: impl Into<String>) -> Self

The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

pub fn set_dashboard_id(self, input: Option<String>) -> Self

The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

pub fn identity_type(self, input: EmbeddingIdentityType) -> Self

The authentication method that the user uses to sign in.

pub fn set_identity_type(self, input: Option<EmbeddingIdentityType>) -> Self

The authentication method that the user uses to sign in.

pub fn session_lifetime_in_minutes(self, input: i64) -> Self

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

pub fn set_session_lifetime_in_minutes(self, input: Option<i64>) -> Self

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

pub fn undo_redo_disabled(self, input: bool) -> Self

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

pub fn set_undo_redo_disabled(self, input: Option<bool>) -> Self

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

pub fn reset_disabled(self, input: bool) -> Self

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

pub fn set_reset_disabled(self, input: Option<bool>) -> Self

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

pub fn state_persistence_enabled(self, input: bool) -> Self

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 (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

pub fn set_state_persistence_enabled(self, input: Option<bool>) -> Self

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 (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

pub fn user_arn(self, input: impl Into<String>) -> Self

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

• IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

pub fn set_user_arn(self, input: Option<String>) -> Self

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

• IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

pub fn namespace(self, input: impl Into<String>) -> Self

The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.

pub fn set_namespace(self, input: Option<String>) -> Self

The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.

pub fn additional_dashboard_ids(self, input: impl Into<String>) -> Self

Appends an item to AdditionalDashboardIds.

To override the contents of this collection use set_additional_dashboard_ids.

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

pub fn set_additional_dashboard_ids(self, input: Option<Vec<String>>) -> Self

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Trait Implementations

impl Clone for GetDashboardEmbedUrl

fn clone(&self) -> GetDashboardEmbedUrl

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetDashboardEmbedUrl

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.