Struct aws_sdk_quicksight::client::fluent_builders::GenerateEmbedUrlForAnonymousUser

pub struct GenerateEmbedUrlForAnonymousUser { /* private fields */ }

Fluent builder constructing a request to GenerateEmbedUrlForAnonymousUser.

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards 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 GenerateEmbedUrlForAnonymousUser

pub async fn customize(
    self
) -> Result<CustomizableOperation<GenerateEmbedUrlForAnonymousUser, AwsResponseRetryClassifier>, SdkError<GenerateEmbedUrlForAnonymousUserError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<GenerateEmbedUrlForAnonymousUserOutput, SdkError<GenerateEmbedUrlForAnonymousUserError>>

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 namespace(self, input: impl Into<String>) -> Self

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

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

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

pub fn session_tags(self, input: SessionTag) -> Self

Appends an item to SessionTags.

To override the contents of this collection use set_session_tags.

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

pub fn set_session_tags(self, input: Option<Vec<SessionTag>>) -> Self

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

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

Appends an item to AuthorizedResourceArns.

To override the contents of this collection use set_authorized_resource_arns.

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.

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

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.

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

The configuration of the experience that you are embedding.

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

The configuration of the experience that you are embedding.

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

Appends an item to AllowedDomains.

To override the contents of this collection use set_allowed_domains.

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.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

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

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.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Trait Implementations

impl Clone for GenerateEmbedUrlForAnonymousUser

fn clone(&self) -> GenerateEmbedUrlForAnonymousUser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateEmbedUrlForAnonymousUser

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

Formats the value using the given formatter.