Struct rusoto_quicksight::GetDashboardEmbedUrlRequest

pub struct GetDashboardEmbedUrlRequest {
    pub additional_dashboard_ids: Option<Vec<String>>,
    pub aws_account_id: String,
    pub dashboard_id: String,
    pub identity_type: String,
    pub namespace: Option<String>,
    pub reset_disabled: Option<bool>,
    pub session_lifetime_in_minutes: Option<i64>,
    pub state_persistence_enabled: Option<bool>,
    pub undo_redo_disabled: Option<bool>,
    pub user_arn: Option<String>,
}

Fields

additional_dashboard_ids: Option<Vec<String>>

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

aws_account_id: String

The ID for the AWS account that contains the dashboard that you're embedding.

dashboard_id: String

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

identity_type: String

The authentication method that the user uses to sign in.

namespace: Option<String>

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

reset_disabled: Option<bool>

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

session_lifetime_in_minutes: Option<i64>

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

state_persistence_enabled: Option<bool>

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

undo_redo_disabled: Option<bool>

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

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

Trait Implementations

impl Clone for GetDashboardEmbedUrlRequest

pub fn clone(&self) -> GetDashboardEmbedUrlRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetDashboardEmbedUrlRequest

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

Formats the value using the given formatter.

impl Default for GetDashboardEmbedUrlRequest

pub fn default() -> GetDashboardEmbedUrlRequest

Returns the "default value" for a type.

impl PartialEq<GetDashboardEmbedUrlRequest> for GetDashboardEmbedUrlRequest

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

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

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

This method tests for !=.

impl Serialize for GetDashboardEmbedUrlRequest

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetDashboardEmbedUrlRequest