Struct aws_sdk_quicksight::operation::get_dashboard_embed_url::builders::GetDashboardEmbedUrlInputBuilder

impl GetDashboardEmbedUrlInputBuilder

pub fn aws_account_id(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_aws_account_id(self, input: Option<String>) -> Self

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

pub fn get_aws_account_id(&self) -> &Option<String>

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

pub fn dashboard_id(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_dashboard_id(self, input: Option<String>) -> Self

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

pub fn get_dashboard_id(&self) -> &Option<String>

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

pub fn identity_type(self, input: EmbeddingIdentityType) -> Self

The authentication method that the user uses to sign in.

This field is required.

pub fn set_identity_type(self, input: Option<EmbeddingIdentityType>) -> Self

The authentication method that the user uses to sign in.

pub fn get_identity_type(&self) -> &Option<EmbeddingIdentityType>

The authentication method that the user uses to sign in.

pub fn session_lifetime_in_minutes(self, input: i64) -> Self

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

pub fn set_session_lifetime_in_minutes(self, input: Option<i64>) -> Self

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

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

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

pub fn undo_redo_disabled(self, input: bool) -> Self

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

pub fn set_undo_redo_disabled(self, input: Option<bool>) -> Self

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

pub fn get_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.

pub fn reset_disabled(self, input: bool) -> Self

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

pub fn set_reset_disabled(self, input: Option<bool>) -> Self

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

pub fn get_reset_disabled(&self) -> &Option<bool>

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

pub fn state_persistence_enabled(self, input: bool) -> Self

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.

pub fn set_state_persistence_enabled(self, input: Option<bool>) -> Self

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.

pub fn get_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.

pub fn user_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_user_arn(self, input: Option<String>) -> Self

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.

pub fn get_user_arn(&self) -> &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.

pub fn namespace(self, input: impl Into<String>) -> Self

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

pub fn set_namespace(self, input: Option<String>) -> Self

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

pub fn get_namespace(&self) -> &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.

pub fn additional_dashboard_ids(self, input: impl Into<String>) -> Self

Appends an item to additional_dashboard_ids.

To override the contents of this collection use set_additional_dashboard_ids.

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.

pub fn set_additional_dashboard_ids(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_additional_dashboard_ids(&self) -> &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.

pub fn build(self) -> Result<GetDashboardEmbedUrlInput, BuildError>

Consumes the builder and constructs a GetDashboardEmbedUrlInput.

impl GetDashboardEmbedUrlInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<GetDashboardEmbedUrlOutput, SdkError<GetDashboardEmbedUrlError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations§

impl Clone for GetDashboardEmbedUrlInputBuilder

fn clone(&self) -> GetDashboardEmbedUrlInputBuilder

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for GetDashboardEmbedUrlInputBuilder

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

Formats the value using the given formatter. Read more

impl Default for GetDashboardEmbedUrlInputBuilder

fn default() -> GetDashboardEmbedUrlInputBuilder

Returns the “default value” for a type. Read more

impl PartialEq for GetDashboardEmbedUrlInputBuilder

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

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

1.0.0 · source§

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 GetDashboardEmbedUrlInputBuilder

Auto Trait Implementations§

impl UnwindSafe for GetDashboardEmbedUrlInputBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more