Struct aws_sdk_quicksight::operation::get_session_embed_url::builders::GetSessionEmbedUrlFluentBuilder

pub struct GetSessionEmbedUrlFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetSessionEmbedUrl.

Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

• Embedding Analytics

• Customizing Access to the Amazon QuickSight Console

Implementations

impl GetSessionEmbedUrlFluentBuilder

pub fn as_input(&self) -> &GetSessionEmbedUrlInputBuilder

Access the GetSessionEmbedUrl as a reference.

pub async fn send( self ) -> Result<GetSessionEmbedUrlOutput, SdkError<GetSessionEmbedUrlError, HttpResponse>>

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, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<GetSessionEmbedUrlOutput, GetSessionEmbedUrlError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

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

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

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

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

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

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

• /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

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

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

• /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

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

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

• /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

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 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 type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

1. Active Directory (AD) users or group members

2. Invited nonfederated users

3. 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 type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

1. Active Directory (AD) users or group members

2. Invited nonfederated users

3. 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 type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

1. Active Directory (AD) users or group members

2. Invited nonfederated users

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

fn clone(&self) -> GetSessionEmbedUrlFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetSessionEmbedUrlFluentBuilder

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

Formats the value using the given formatter.