#[non_exhaustive]pub struct GetDashboardEmbedUrlInput {
pub aws_account_id: Option<String>,
pub dashboard_id: Option<String>,
pub identity_type: Option<EmbeddingIdentityType>,
pub session_lifetime_in_minutes: Option<i64>,
pub undo_redo_disabled: Option<bool>,
pub reset_disabled: Option<bool>,
pub state_persistence_enabled: Option<bool>,
pub user_arn: Option<String>,
pub namespace: Option<String>,
pub additional_dashboard_ids: Option<Vec<String>>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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.
dashboard_id: Option<String>
The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
identity_type: Option<EmbeddingIdentityType>
The authentication method that the user uses to sign in.
session_lifetime_in_minutes: Option<i64>
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
undo_redo_disabled: Option<bool>
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
reset_disabled: Option<bool>
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
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 (Amazon 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 Amazon 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
.
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.
namespace: Option<String>
The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default
.
additional_dashboard_ids: Option<Vec<String>>
A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType
parameter must be set to ANONYMOUS
because other identity types authenticate as Amazon 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.
Implementations§
source§impl GetDashboardEmbedUrlInput
impl GetDashboardEmbedUrlInput
sourcepub fn aws_account_id(&self) -> Option<&str>
pub fn aws_account_id(&self) -> Option<&str>
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
sourcepub fn dashboard_id(&self) -> Option<&str>
pub fn dashboard_id(&self) -> Option<&str>
The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
sourcepub fn identity_type(&self) -> Option<&EmbeddingIdentityType>
pub fn identity_type(&self) -> Option<&EmbeddingIdentityType>
The authentication method that the user uses to sign in.
sourcepub fn session_lifetime_in_minutes(&self) -> Option<i64>
pub fn session_lifetime_in_minutes(&self) -> Option<i64>
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
sourcepub fn undo_redo_disabled(&self) -> Option<bool>
pub fn undo_redo_disabled(&self) -> Option<bool>
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
sourcepub fn reset_disabled(&self) -> Option<bool>
pub fn reset_disabled(&self) -> Option<bool>
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
sourcepub fn state_persistence_enabled(&self) -> Option<bool>
pub fn state_persistence_enabled(&self) -> 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 (Amazon 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 Amazon 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
.
sourcepub fn user_arn(&self) -> Option<&str>
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 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.
sourcepub fn namespace(&self) -> Option<&str>
pub fn namespace(&self) -> Option<&str>
The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default
.
sourcepub fn additional_dashboard_ids(&self) -> &[String]
pub fn additional_dashboard_ids(&self) -> &[String]
A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType
parameter must be set to ANONYMOUS
because other identity types authenticate as Amazon 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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_dashboard_ids.is_none()
.
source§impl GetDashboardEmbedUrlInput
impl GetDashboardEmbedUrlInput
sourcepub fn builder() -> GetDashboardEmbedUrlInputBuilder
pub fn builder() -> GetDashboardEmbedUrlInputBuilder
Creates a new builder-style object to manufacture GetDashboardEmbedUrlInput
.
Trait Implementations§
source§impl Clone for GetDashboardEmbedUrlInput
impl Clone for GetDashboardEmbedUrlInput
source§fn clone(&self) -> GetDashboardEmbedUrlInput
fn clone(&self) -> GetDashboardEmbedUrlInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GetDashboardEmbedUrlInput
impl Debug for GetDashboardEmbedUrlInput
source§impl PartialEq for GetDashboardEmbedUrlInput
impl PartialEq for GetDashboardEmbedUrlInput
source§fn eq(&self, other: &GetDashboardEmbedUrlInput) -> bool
fn eq(&self, other: &GetDashboardEmbedUrlInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for GetDashboardEmbedUrlInput
Auto Trait Implementations§
impl Freeze for GetDashboardEmbedUrlInput
impl RefUnwindSafe for GetDashboardEmbedUrlInput
impl Send for GetDashboardEmbedUrlInput
impl Sync for GetDashboardEmbedUrlInput
impl Unpin for GetDashboardEmbedUrlInput
impl UnwindSafe for GetDashboardEmbedUrlInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more