Struct aws_sdk_quicksight::input::get_dashboard_embed_url_input::Builder

pub struct Builder { /* private fields */ }

A builder for GetDashboardEmbedUrlInput.

Implementations

impl Builder

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.

Examples found in repository

src/client.rs (line 9329)

        pub fn aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.aws_account_id(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 9337)

        pub fn set_aws_account_id(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_aws_account_id(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9342)

        pub fn dashboard_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.dashboard_id(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 9347)

        pub fn set_dashboard_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_dashboard_id(input);
            self
        }

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

The authentication method that the user uses to sign in.

Examples found in repository

src/client.rs (line 9352)

        pub fn identity_type(mut self, input: crate::model::EmbeddingIdentityType) -> Self {
            self.inner = self.inner.identity_type(input);
            self
        }

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

The authentication method that the user uses to sign in.

Examples found in repository

src/client.rs (line 9360)

        pub fn set_identity_type(
            mut self,
            input: std::option::Option<crate::model::EmbeddingIdentityType>,
        ) -> Self {
            self.inner = self.inner.set_identity_type(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9365)

        pub fn session_lifetime_in_minutes(mut self, input: i64) -> Self {
            self.inner = self.inner.session_lifetime_in_minutes(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9370)

        pub fn set_session_lifetime_in_minutes(mut self, input: std::option::Option<i64>) -> Self {
            self.inner = self.inner.set_session_lifetime_in_minutes(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9375)

        pub fn undo_redo_disabled(mut self, input: bool) -> Self {
            self.inner = self.inner.undo_redo_disabled(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9380)

        pub fn set_undo_redo_disabled(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_undo_redo_disabled(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9385)

        pub fn reset_disabled(mut self, input: bool) -> Self {
            self.inner = self.inner.reset_disabled(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9390)

        pub fn set_reset_disabled(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_reset_disabled(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9395)

        pub fn state_persistence_enabled(mut self, input: bool) -> Self {
            self.inner = self.inner.state_persistence_enabled(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9400)

        pub fn set_state_persistence_enabled(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_state_persistence_enabled(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9411)

        pub fn user_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.user_arn(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 9422)

        pub fn set_user_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_user_arn(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9427)

        pub fn namespace(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.namespace(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 9432)

        pub fn set_namespace(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_namespace(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 9441)

        pub fn additional_dashboard_ids(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.additional_dashboard_ids(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 9449)

        pub fn set_additional_dashboard_ids(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_additional_dashboard_ids(input);
            self
        }

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

Consumes the builder and constructs a GetDashboardEmbedUrlInput.

Examples found in repository

src/client.rs (line 9296)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::GetDashboardEmbedUrl,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::GetDashboardEmbedUrlError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::GetDashboardEmbedUrlOutput,
            aws_smithy_http::result::SdkError<crate::error::GetDashboardEmbedUrlError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> 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 Builder