Struct aws_sdk_quicksight::input::GenerateEmbedUrlForAnonymousUserInput

#[non_exhaustive]
pub struct GenerateEmbedUrlForAnonymousUserInput {
    pub aws_account_id: Option<String>,
    pub session_lifetime_in_minutes: Option<i64>,
    pub namespace: Option<String>,
    pub session_tags: Option<Vec<SessionTag>>,
    pub authorized_resource_arns: Option<Vec<String>>,
    pub experience_configuration: Option<AnonymousUserEmbeddingExperienceConfiguration>,
    pub allowed_domains: Option<Vec<String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

aws_account_id: Option<String>

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

session_lifetime_in_minutes: Option<i64>

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

namespace: Option<String>

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.

session_tags: Option<Vec<SessionTag>>

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.

authorized_resource_arns: Option<Vec<String>>

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.

experience_configuration: Option<AnonymousUserEmbeddingExperienceConfiguration>

The configuration of the experience that you are embedding.

allowed_domains: Option<Vec<String>>

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 and instead 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 a subdomain, use * to include all subdomains under a specific domain to the allow list. For example, https://*.sapp.amazon.com, includes all subdomains under https://sapp.amazon.com.

Implementations

impl GenerateEmbedUrlForAnonymousUserInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<GenerateEmbedUrlForAnonymousUser, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<GenerateEmbedUrlForAnonymousUser>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GenerateEmbedUrlForAnonymousUserInput.

impl GenerateEmbedUrlForAnonymousUserInput

pub fn aws_account_id(&self) -> Option<&str>

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

pub fn session_lifetime_in_minutes(&self) -> Option<i64>

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

pub fn namespace(&self) -> Option<&str>

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) -> Option<&[SessionTag]>

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) -> Option<&[String]>

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
) -> Option<&AnonymousUserEmbeddingExperienceConfiguration>

The configuration of the experience that you are embedding.

pub fn allowed_domains(&self) -> Option<&[String]>

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 and instead 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 a subdomain, use * to include all subdomains under a specific domain to the allow list. For example, https://*.sapp.amazon.com, includes all subdomains under https://sapp.amazon.com.

Trait Implementations

impl Clone for GenerateEmbedUrlForAnonymousUserInput

fn clone(&self) -> GenerateEmbedUrlForAnonymousUserInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateEmbedUrlForAnonymousUserInput

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

Formats the value using the given formatter.

impl PartialEq<GenerateEmbedUrlForAnonymousUserInput> for GenerateEmbedUrlForAnonymousUserInput

fn eq(&self, other: &GenerateEmbedUrlForAnonymousUserInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GenerateEmbedUrlForAnonymousUserInput) -> bool

This method tests for !=.

impl StructuralPartialEq for GenerateEmbedUrlForAnonymousUserInput