Struct aws_sdk_quicksight::operation::get_session_embed_url::GetSessionEmbedUrlInput

#[non_exhaustive]
pub struct GetSessionEmbedUrlInput {
    pub aws_account_id: Option<String>,
    pub entry_point: Option<String>,
    pub session_lifetime_in_minutes: Option<i64>,
    pub user_arn: Option<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 associated with your Amazon QuickSight subscription.

entry_point: Option<String>

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

• /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

session_lifetime_in_minutes: Option<i64>

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

user_arn: Option<String>

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

1. Active Directory (AD) users or group members

2. Invited nonfederated users

3. 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.

Implementations

impl GetSessionEmbedUrlInput

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

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

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

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

• /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

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

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

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

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

1. Active Directory (AD) users or group members

2. Invited nonfederated users

3. 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.

impl GetSessionEmbedUrlInput

pub fn builder() -> GetSessionEmbedUrlInputBuilder

Creates a new builder-style object to manufacture GetSessionEmbedUrlInput.

Trait Implementations

impl Clone for GetSessionEmbedUrlInput

fn clone(&self) -> GetSessionEmbedUrlInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetSessionEmbedUrlInput

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

Formats the value using the given formatter.

impl PartialEq for GetSessionEmbedUrlInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetSessionEmbedUrlInput