Struct aws_sdk_quicksight::client::fluent_builders::GenerateEmbedUrlForRegisteredUser

pub struct GenerateEmbedUrlForRegisteredUser { /* private fields */ }

Fluent builder constructing a request to GenerateEmbedUrlForRegisteredUser.

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

The following rules apply to the generated URL:

• It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

• The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter.

  The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

• You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics 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 GenerateEmbedUrlForRegisteredUser

pub async fn send(
    self
) -> Result<GenerateEmbedUrlForRegisteredUserOutput, SdkError<GenerateEmbedUrlForRegisteredUserError>>

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 session_lifetime_in_minutes(self, input: i64) -> Self

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

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

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

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

The Amazon Resource Name for the registered user.

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

The Amazon Resource Name for the registered user.

pub fn experience_configuration(
    self,
    input: RegisteredUserEmbeddingExperienceConfiguration
) -> Self

The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.

pub fn set_experience_configuration(
    self,
    input: Option<RegisteredUserEmbeddingExperienceConfiguration>
) -> Self

The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.

Trait Implementations

impl Clone for GenerateEmbedUrlForRegisteredUser

fn clone(&self) -> GenerateEmbedUrlForRegisteredUser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateEmbedUrlForRegisteredUser

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

Formats the value using the given formatter.