Struct aws_sdk_quicksight::input::GetDashboardEmbedUrlInput [−][src]
#[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: bool,
pub reset_disabled: bool,
pub state_persistence_enabled: 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: bool
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
reset_disabled: bool
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
state_persistence_enabled: 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
-
IAMusers and IAMrole-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAMfederation.
Omit this parameter for users in the third group – IAMusers 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 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 Amazon QuickSight or IAMusers. 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
pub fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetDashboardEmbedUrl, AwsErrorRetryPolicy>, BuildError>
pub fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetDashboardEmbedUrl, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<GetDashboardEmbedUrl
>
Creates a new builder-style object to manufacture GetDashboardEmbedUrlInput
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for GetDashboardEmbedUrlInput
impl Send for GetDashboardEmbedUrlInput
impl Sync for GetDashboardEmbedUrlInput
impl Unpin for GetDashboardEmbedUrlInput
impl UnwindSafe for GetDashboardEmbedUrlInput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more